Package org.odpi.openmetadata.adminservices.configuration.properties

Enum Class OpenMetadataExchangeRule

java.lang.Object

java.lang.Enum<OpenMetadataExchangeRule>

org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataExchangeRule>, Constable

public enum OpenMetadataExchangeRule
extends Enum<OpenMetadataExchangeRule>

OpenMetadataExchangeRule controls the sending/receiving of metadata instances on the metadata highway.

• REGISTRATION_ONLY means do not send/receive reference metadata - just perform the minimal registration exchanges.
• JUST_TYPEDEFS means only send/receive/validate type definitions (TypeDefs).
• SELECTED_TYPES means that in addition to TypeDefs events, only metadata instances of the types supplied in the related list of TypeDefs (see typesToSend, typesToSave and typesToFederate) should be processed.
• DESELECTED_TYPES means that in addition to TypeDefs events, only metadata instances NOT of the types supplied in the related list of TypeDefs (see typesToSend, typesToSave and typesToFederate) should be processed.
• LEARNED_TYPES means that the local repository requests reference copies of metadata based on the requests of the local user community.
• ALL means send/receive all types of metadata that are supported by the local repository.

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
ALL	Registration plus all type definitions (TypeDefs) and metadata instances (Entities, Classifications and Relationships).
DESELECTED_TYPES	Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) NOT listed in selected types.
JUST_TYPEDEFS	Only registration and type definitions (TypeDefs) exchange.
LEARNED_TYPES	Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) of types requested by local users to this server.
REGISTRATION_ONLY	Only registration exchange; no TypeDefs or metadata instances.
SELECTED_TYPES	Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) of selected types.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of this metadata instance replication rule.
String	getName()	Return the name of this metadata instance replication rule.
int	getOrdinal()	Return the code number of this metadata instance replication rule.
String	toString()	Standard toString method.
static OpenMetadataExchangeRule	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataExchangeRule[]	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

REGISTRATION_ONLY

public static final OpenMetadataExchangeRule REGISTRATION_ONLY

Only registration exchange; no TypeDefs or metadata instances.

JUST_TYPEDEFS

public static final OpenMetadataExchangeRule JUST_TYPEDEFS

Only registration and type definitions (TypeDefs) exchange.

SELECTED_TYPES

public static final OpenMetadataExchangeRule SELECTED_TYPES

Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) of selected types.

LEARNED_TYPES

public static final OpenMetadataExchangeRule LEARNED_TYPES

Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) of types requested by local users to this server.

DESELECTED_TYPES

public static final OpenMetadataExchangeRule DESELECTED_TYPES

Registration plus all type definitions (TypeDefs) and metadata instances (Entities and Relationships) NOT listed in selected types.

ALL

public static final OpenMetadataExchangeRule ALL

Registration plus all type definitions (TypeDefs) and metadata instances (Entities, Classifications and Relationships).

Method Details

values

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

getOrdinal

public int getOrdinal()

Return the code number of this metadata instance replication rule.

Returns:

int replication rule code number

getName

public String getName()

Return the name of this metadata instance replication rule.

Returns:

String replication rule name

getDescription

public String getDescription()

Return the description of this metadata instance replication rule.

Returns:

String replication rule description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<OpenMetadataExchangeRule>

Returns:

print out of variables in a JSON-style