Package org.odpi.openmetadata.repositoryservices.properties

Enum Class CohortConnectionStatus

java.lang.Object

java.lang.Enum<CohortConnectionStatus>

org.odpi.openmetadata.repositoryservices.properties.CohortConnectionStatus

All Implemented Interfaces:

Serializable, Comparable<CohortConnectionStatus>, Constable

public enum CohortConnectionStatus
extends Enum<CohortConnectionStatus>
implements Serializable

CohortConnectionStatus defines the status of the local server's connection to the metadata highway for a specific cohort.

• NOT_INITIALIZED: the local components for communicating with other members of the cohort are not initialized. This should never been seen on the adminservices console since it is the value for the cohort manager used on the variable declaration.
• INITIALIZING: the local components for communicating with the other members of the cohort are initializing. It the server is working properly this status is only set for a split-second. If it is seen on the admin services console it probably means one of the underlying connectors is hanging during its initialization.
• NEW: the local components for the cohort are initialized but they have not yet exchanged messages with the other members of the cohort. At this point, the local metadata collection id may be changed.
• CONFIGURATION_ERROR: means there is an error in the configuration and connection is not possible. The administrator needs to either fix the config or fix the system's infrastructure around the server.
• CONNECTED: means the server is connected to the metadata highway for this cohort and is exchanging messages.
• DISCONNECTING: means the server is disconnecting from the metadata highway and is in the process of shutting down the local components that manage communication with the other members of this cohort.
• DISCONNECTED: means the server is disconnected from the metadata highway for this cohort. This may be because the local server is shutting down or the configuration is being adjusted.

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
CONFIGURATION_ERROR	ConfigurationError - There is an error in the configuration and connection is not possible.
CONNECTED	Connected - The server is connected to the metadata highway for this cohort and messages are being exchanged with other members of the cohort.
DISCONNECTED	Disconnected - The server is disconnected from the metadata highway for this cohort.
DISCONNECTING	Initializing - The local components for communicating with the cohort are disconnecting.
INITIALIZING	Initializing - The local components for communicating with the cohort are initializing.
NEW	New - The local components for communicating with the cohort are initialized, but they have not exchanged messages with the other members of cohort.
NOT_INITIALIZED	NotInitialized - The local components for communicating with the cohort are not initialized.

Method Summary

Modifier and Type	Method	Description
int	getStatusCode()	Return the numeric code for the enum.
String	getStatusDescription()	Return the description of the enum.
String	getStatusName()	Return the name for the enum.
static CohortConnectionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CohortConnectionStatus[]	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

NOT_INITIALIZED

public static final CohortConnectionStatus NOT_INITIALIZED

NotInitialized - The local components for communicating with the cohort are not initialized.

INITIALIZING

public static final CohortConnectionStatus INITIALIZING

Initializing - The local components for communicating with the cohort are initializing.

NEW

public static final CohortConnectionStatus NEW

New - The local components for communicating with the cohort are initialized, but they have not exchanged messages with the other members of cohort.

CONFIGURATION_ERROR

public static final CohortConnectionStatus CONFIGURATION_ERROR

ConfigurationError - There is an error in the configuration and connection is not possible.

CONNECTED

public static final CohortConnectionStatus CONNECTED

Connected - The server is connected to the metadata highway for this cohort and messages are being exchanged with other members of the cohort.

DISCONNECTING

public static final CohortConnectionStatus DISCONNECTING

Initializing - The local components for communicating with the cohort are disconnecting.

DISCONNECTED

public static final CohortConnectionStatus DISCONNECTED

Disconnected - The server is disconnected from the metadata highway for this cohort. This may be because the local server is shutting down or the configuration is being adjusted.

Method Details

values

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

getStatusCode

public int getStatusCode()

Return the numeric code for the enum.

Returns:

int code

getStatusName

public String getStatusName()

Return the name for the enum.

Returns:

String name

getStatusDescription

public String getStatusDescription()

Return the description of the enum.

Returns:

String description