Package org.odpi.openmetadata.adapters.connectors.wso2mi.controls

Enum Class WSO2MIPlaceholderProperty

java.lang.Object

java.lang.Enum<WSO2MIPlaceholderProperty>

org.odpi.openmetadata.adapters.connectors.wso2mi.controls.WSO2MIPlaceholderProperty

All Implemented Interfaces:

Serializable, Comparable<WSO2MIPlaceholderProperty>, Constable

public enum WSO2MIPlaceholderProperty
extends Enum<WSO2MIPlaceholderProperty>

WSO2MIPlaceholderProperty defines the placeholder properties used when the WSO2 Micro Integrator connectors are configured from a template.

The Micro Integrator Management API authenticates with a user name and password that are exchanged for a short-lived bearer token (see WSO2MIResourceConnector); those credentials are supplied through MI_USER_ID / MI_PASSWORD and stored via the connection's secrets store.

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
HOST_IDENTIFIER	The host name or IP address of the machine running the WSO2 Micro Integrator.
MANAGEMENT_PORT	The port that the WSO2 Micro Integrator Management API is listening on.
MI_PASSWORD	The Management API password.
MI_USER_ID	The Management API user name.
SERVER_NAME	The name to give the WSO2 Micro Integrator instance in the open metadata ecosystem.

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Return the open metadata data type of the placeholder property.
String	getDescription()	Return the description of the placeholder property.
String	getExample()	Return an example value for the placeholder property.
String	getName()	Return the name of the placeholder property.
static WSO2MIPlaceholderProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WSO2MIPlaceholderProperty[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HOST_IDENTIFIER

public static final WSO2MIPlaceholderProperty HOST_IDENTIFIER

The host name or IP address of the machine running the WSO2 Micro Integrator.

MANAGEMENT_PORT

public static final WSO2MIPlaceholderProperty MANAGEMENT_PORT

The port that the WSO2 Micro Integrator Management API is listening on.

SERVER_NAME

public static final WSO2MIPlaceholderProperty SERVER_NAME

The name to give the WSO2 Micro Integrator instance in the open metadata ecosystem.

MI_USER_ID

public static final WSO2MIPlaceholderProperty MI_USER_ID

The Management API user name.

MI_PASSWORD

public static final WSO2MIPlaceholderProperty MI_PASSWORD

The Management API password.

Method Details

values

public static WSO2MIPlaceholderProperty[] 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 WSO2MIPlaceholderProperty 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 placeholder property.

Returns:

string name

getDescription

public String getDescription()

Return the description of the placeholder property.

Returns:

string description

getDataType

public String getDataType()

Return the open metadata data type of the placeholder property.

Returns:

string data type

getExample

public String getExample()

Return an example value for the placeholder property.

Returns:

string example