Package org.odpi.openmetadata.frameworks.connectors.controls

Enum Class SecretsStorePurpose

java.lang.Object

java.lang.Enum<SecretsStorePurpose>

org.odpi.openmetadata.frameworks.connectors.controls.SecretsStorePurpose

All Implemented Interfaces:

Serializable, Comparable<SecretsStorePurpose>, Constable

public enum SecretsStorePurpose
extends Enum<SecretsStorePurpose>

SecretsStorePurpose defines the purpose of a secrets connector. These values are set into the "displayName" property of the EmbeddedConnection entity (model 0205).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REST_BASIC_AUTHENTICATION	A password used to prove a user's identity - in clear text.
REST_BEARER_TOKEN	The secrets connector can supply a bearer token to send in the authorization header of a REST API call.
USER_DIRECTORY	A collection of user details including secrets used to prove the user's identity.

Field Summary

Fields

Modifier and Type	Field	Description
final String	description
final String	name

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the configuration property.
String	getName()	Return the name of the request parameter.
String	toString()	Output of this enum class and main value.
static SecretsStorePurpose	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecretsStorePurpose[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REST_BEARER_TOKEN

public static final SecretsStorePurpose REST_BEARER_TOKEN

The secrets connector can supply a bearer token to send in the authorization header of a REST API call.

REST_BASIC_AUTHENTICATION

public static final SecretsStorePurpose REST_BASIC_AUTHENTICATION

A password used to prove a user's identity - in clear text.

USER_DIRECTORY

public static final SecretsStorePurpose USER_DIRECTORY

A collection of user details including secrets used to prove the user's identity.

Field Details

name

public final String name

description

public final String description

Method Details

values

public static SecretsStorePurpose[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SecretsStorePurpose valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Return the name of the request parameter.

Returns:

string name

getDescription

public String getDescription()

Return the description of the configuration property.

Returns:

text

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<SecretsStorePurpose>

Returns:

string showing enum value