org.odpi.openmetadata.repositoryservices.events

Class OMRSEventOriginator

java.lang.Object

org.odpi.openmetadata.repositoryservices.events.OMRSEventOriginator

All Implemented Interfaces:

Serializable

public class OMRSEventOriginator
extends Object
implements Serializable

OMRSEventOriginator is part of an OMRSEvent's header. It defines the properties of the server/repository that originated the event. These properties are as follows:

• metadataCollectionId: the unique identifier of the metadata collection in the originating server. This is a mandatory property.
• ServerName: this is a display name for the server that is used in events, messages and UIs to make it easier for people to understand the origin of metadata. It is optional.
• ServerType: this is a descriptive string describing the type of the server. This might be the name of the product, or similar identifier. This is an optional property.
• OrganizationName: this is a descriptive name for the organization that runs/owns the server. For an enterprise, it may be the name of a department, geography or division. If the cluster covers a group of business partners then it may be their respective company names. This is an optional field.
• ProtocolVersion: this is an enumeration that identifies which version of the OMRS event structure should be used. In general it should be set to the highest level that all servers in the cohort can support.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMRSEventOriginator() Default constructor used by parsing engines and other consumers.

Method Summary

Modifier and Type	Method and Description
String	getMetadataCollectionId() Returns the unique identifier (guid) of the originating repository's metadata collection.
String	getOrganizationName() Return the name of the organization that runs/owns the server.
String	getServerName() Return the display name for the server that is used in events, messages and UIs to make it easier for people to understand the origin of metadata.
String	getServerType() Return the descriptive string describing the type of the server.
void	setMetadataCollectionId(String metadataCollectionId) Sets up the unique identifier (guid) of the originating repository.
void	setOrganizationName(String organizationName) Set up the name of the organization that runs/owns the server.
void	setServerName(String serverName) Set up the display name for the server that is used in events, messages and UIs to make it easier for people to understand the origin of metadata.
void	setServerType(String serverType) Set up the descriptive string describing the type of the server.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OMRSEventOriginator

public OMRSEventOriginator()

Default constructor used by parsing engines and other consumers.

Method Detail

getMetadataCollectionId

public String getMetadataCollectionId()

Returns the unique identifier (guid) of the originating repository's metadata collection.

Returns:

String guid

setMetadataCollectionId

public void setMetadataCollectionId(String metadataCollectionId)

Sets up the unique identifier (guid) of the originating repository.

Parameters:

metadataCollectionId - String guid

getServerName

public String getServerName()

Return the display name for the server that is used in events, messages and UIs to make it easier for people to understand the origin of metadata.

Returns:

String server name

setServerName

public void setServerName(String serverName)

Set up the display name for the server that is used in events, messages and UIs to make it easier for people to understand the origin of metadata.

Parameters:

serverName - String server name

getServerType

public String getServerType()

Return the descriptive string describing the type of the server. This might be the name of the product, or similar identifier.

Returns:

String server type

setServerType

public void setServerType(String serverType)

Set up the descriptive string describing the type of the server. This might be the name of the product, or similar identifier.

Parameters:

serverType - String server type

getOrganizationName

public String getOrganizationName()

Return the name of the organization that runs/owns the server.

Returns:

String organization name

setOrganizationName

public void setOrganizationName(String organizationName)

Set up the name of the organization that runs/owns the server.

Parameters:

organizationName - String organization name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.