org.odpi.openmetadata.repositoryservices.events

Enum OMRSRegistryEventType

java.lang.Object

java.lang.Enum<OMRSRegistryEventType>

org.odpi.openmetadata.repositoryservices.events.OMRSRegistryEventType

All Implemented Interfaces:

Serializable, Comparable<OMRSRegistryEventType>

public enum OMRSRegistryEventType
extends Enum<OMRSRegistryEventType>
implements Serializable

OMRSRegistryEventType defines the different types of registry events in the open metadata repository services protocol. There are 4 basic values.

• UNKNOWN_REGISTRY_EVENT: the event is not recognized by this local server, probably because it is back-level from other servers in the cohort. It is logged in the audit log and then ignored. The registration protocol should evolve so that new message types can be ignored by back-level servers without damage to the cohort's integrity.
• REGISTRATION_EVENT: this event is a server's first contact with the cohort. It publicises the id of the local repository, the connection information needed to connect remotely to this local server's repository (localServerRemoteConnection) plus a list of typedef names and GUIDs. Other servers in the cohort will respond either with a RE_REGISTRATION_EVENT if all is ok or REGISTRATION_ERROR if there is a problem with any information in the REGISTRATION_EVENT.
• REFRESH_REGISTRATION_EVENT: this event is used after a local server has experienced configuration issues and needs to receive the registration information from other members of the cohort again.
• RE_REGISTRATION_EVENT: this event is used by a previously registered server to broadcast its current configuration. It is used in response to a REGISTRATION_EVENT and a REFRESH_REGISTRATION_EVENT to let the other servers know about its configuration, or whenever its configuration may have changed (such as after a server restart or administrator action).
• UN_REGISTRATION_EVENT: this event is used when a server is being removed from the cohort. The other servers can choose whether to remove its replicated metadata from their repository, or mark it as deregistered repository's metadata.
• REGISTRATION_ERROR_EVENT: ths event is used to report anomalies in the registration information being passed between the repositories and the actions taken. Each of these errors should be investigated since they should not occur.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RE_REGISTRATION_EVENT
REFRESH_REGISTRATION_REQUEST
REGISTRATION_ERROR_EVENT
REGISTRATION_EVENT
UN_REGISTRATION_EVENT
UNKNOWN_REGISTRY_EVENT

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for the enum value.
String	getName() Return the string name used for messages that include the enum.
int	getOrdinal() Return the int identifier used for indexing based on the enum.
String	toString() toString() JSON-style
static OMRSRegistryEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static OMRSRegistryEventType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN_REGISTRY_EVENT

public static final OMRSRegistryEventType UNKNOWN_REGISTRY_EVENT

REGISTRATION_EVENT

public static final OMRSRegistryEventType REGISTRATION_EVENT

REFRESH_REGISTRATION_REQUEST

public static final OMRSRegistryEventType REFRESH_REGISTRATION_REQUEST

RE_REGISTRATION_EVENT

public static final OMRSRegistryEventType RE_REGISTRATION_EVENT

UN_REGISTRATION_EVENT

public static final OMRSRegistryEventType UN_REGISTRATION_EVENT

REGISTRATION_ERROR_EVENT

public static final OMRSRegistryEventType REGISTRATION_ERROR_EVENT

Method Detail

values

public static OMRSRegistryEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OMRSRegistryEventType c : OMRSRegistryEventType.values())
    System.out.println(c);

Returns:

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

valueOf

public static OMRSRegistryEventType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the int identifier used for indexing based on the enum.

Returns:

int identifier code

getName

public String getName()

Return the string name used for messages that include the enum.

Returns:

String name

getDescription

public String getDescription()

Return the default description for the enum value. This is used when natural resource bundle is not available.

Returns:

String default description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OMRSRegistryEventType>

Returns:

string description