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

Enum Class SecretsStoreCollectionProperty

java.lang.Object

java.lang.Enum<SecretsStoreCollectionProperty>

org.odpi.openmetadata.frameworks.connectors.controls.SecretsStoreCollectionProperty

All Implemented Interfaces:

Serializable, Comparable<SecretsStoreCollectionProperty>, Constable

public enum SecretsStoreCollectionProperty
extends Enum<SecretsStoreCollectionProperty>

SecretsStoreConfigurationProperty provides definitions for typical properties used with the secrets store collections.

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
CLEAR_PASSWORD	A password used to prove a user's identity - in clear text.
ENCRYPTED_PASSWORD	A password used to prove a user's identity - encrypted.
REFRESH_TIME_INTERVAL	The time interval in minutes that tokens should be kept.
TOKEN	An encrypted token to provide access to a remote digital resource.
TOKEN_URL	A URL to retrieve an access token.
USER_ID	The name used to identify the collection of properties that a particular connector is using.

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	description
final String	example
final String	name

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Return the data type for the configuration property.
String	getDescription()	Return the description of the configuration property.
String	getExample()	Return an example of the configuration property to help users understand how to set it up.
String	getName()	Return the name of the request parameter.
String	toString()	Output of this enum class and main value.
static SecretsStoreCollectionProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecretsStoreCollectionProperty[]	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

REFRESH_TIME_INTERVAL

public static final SecretsStoreCollectionProperty REFRESH_TIME_INTERVAL

The time interval in minutes that tokens should be kept.

USER_ID

public static final SecretsStoreCollectionProperty USER_ID

The name used to identify the collection of properties that a particular connector is using.

CLEAR_PASSWORD

public static final SecretsStoreCollectionProperty CLEAR_PASSWORD

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

ENCRYPTED_PASSWORD

public static final SecretsStoreCollectionProperty ENCRYPTED_PASSWORD

A password used to prove a user's identity - encrypted.

TOKEN

public static final SecretsStoreCollectionProperty TOKEN

An encrypted token to provide access to a remote digital resource.

TOKEN_URL

public static final SecretsStoreCollectionProperty TOKEN_URL

A URL to retrieve an access token.

Field Details

name

public final String name

description

public final String description

dataType

public final String dataType

example

public final String example

Method Details

values

public static SecretsStoreCollectionProperty[] 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 SecretsStoreCollectionProperty 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

getDataType

public String getDataType()

Return the data type for the configuration property.

Returns:

data type name

getExample

public String getExample()

Return an example of the configuration property to help users understand how to set it up.

Returns:

example

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<SecretsStoreCollectionProperty>

Returns:

string showing enum value