Package org.odpi.openmetadata.frameworks.integration.contextmanager

Enum Class PermittedSynchronization

java.lang.Object

java.lang.Enum<PermittedSynchronization>

org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization

All Implemented Interfaces:

Serializable, Comparable<PermittedSynchronization>, Constable

public enum PermittedSynchronization
extends Enum<PermittedSynchronization>
implements Serializable

PermittedSynchronization defines the permitted directions of flow of metadata updates between open metadata and a third party technology. It is set in the configuration for an integration connector and is enforced in the integration service (in the integration context to be precise).

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
BOTH_DIRECTIONS	Metadata exchange is permitted in both directions.
FROM_THIRD_PARTY	The third party technology is logically upstream (the originator and owner of the metadata).
OTHER	Another type of synchronization rule - see description property.
TO_THIRD_PARTY	The third party technology is logically downstream of open metadata.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the key pattern for this enum instance.
String	getName()	Return the default name for this enum instance.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the code for this enum instance
String	toString()	Standard toString method.
static PermittedSynchronization	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PermittedSynchronization[]	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

BOTH_DIRECTIONS

public static final PermittedSynchronization BOTH_DIRECTIONS

Metadata exchange is permitted in both directions. Synchronization is halted on a specific element if potentially clashing updates have occurred both in the third party technology and open metadata. Such conflicts are logged on the audit log and resolved through manual stewardship.

TO_THIRD_PARTY

public static final PermittedSynchronization TO_THIRD_PARTY

The third party technology is logically downstream of open metadata. This means the open metadata ecosystem is the originator and owner of the metadata being synchronized. Any updates detected in the third technology are overridden by the latest open metadata values.

FROM_THIRD_PARTY

public static final PermittedSynchronization FROM_THIRD_PARTY

The third party technology is logically upstream (the originator and owner of the metadata). Any updates made in open metadata are not passed to the third party technology and the third party technology is requested to refresh the open metadata version.

OTHER

public static final PermittedSynchronization OTHER

Another type of synchronization rule - see description property.

Method Details

values

public static PermittedSynchronization[] 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 PermittedSynchronization 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 for this enum instance

Returns:

int key pattern code

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int code number

getName

public String getName()

Return the default name for this enum instance.

Returns:

String default name

getDescription

public String getDescription()

Return the default description for the key pattern for this enum instance.

Returns:

String default description

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<PermittedSynchronization>

Returns:

print out of variables in a JSON-style