Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryeventmapper

Class OMRSRepositoryEventMapperConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryeventmapper.OMRSRepositoryEventMapperConnector

All Implemented Interfaces:

AuditLoggingComponent, OMRSRepositoryEventMapper

Direct Known Subclasses:

OMRSRepositoryEventMapperBase

public abstract class OMRSRepositoryEventMapperConnector
extends ConnectorBase
implements OMRSRepositoryEventMapper, AuditLoggingComponent

OMRSRepositoryEventMapperBase provides a base class for implementors of OMRSRepositoryEventMapper.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected String	localMetadataCollectionId
protected String	localOrganizationName
protected String	localServerName
protected String	localServerType
protected String	localServerUserId
protected OMRSRepositoryConnector	repositoryConnector
protected String	repositoryEventMapperName
protected OMRSRepositoryEventProcessor	repositoryEventProcessor
protected OMRSRepositoryHelper	repositoryHelper
protected OMRSRepositoryValidator	repositoryValidator

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
void	initialize(String repositoryEventMapperName, OMRSRepositoryConnector repositoryConnector)	Pass additional information to the connector needed to process events.
void	setAuditLog(AuditLog auditLog)	Receive an audit log object that can be used to record audit log messages.
void	setMetadataCollectionId(String metadataCollectionId)	Set up the unique Id for this metadata collection.
void	setOrganizationName(String organizationName)	Set up the name of the organization that runs/owns the server.
void	setRepositoryEventProcessor(OMRSRepositoryEventProcessor repositoryEventProcessor)	Set up the repository event listener for this connector to use.
void	setRepositoryHelper(OMRSRepositoryHelper repositoryHelper)	Set up a repository helper object for the repository connector to use.
void	setRepositoryValidator(OMRSRepositoryValidator repositoryValidator)	Set up a repository validator for the repository connector to use.
void	setServerName(String serverName)	Set up the name of the server where the metadata collection resides.
void	setServerType(String serverType)	Set up the descriptive string describing the type of the server.
void	setServerUserId(String localServerUserId)	Set up the userId that the local server should use when processing events and there is no external user driving the operation.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

repositoryEventProcessor

protected OMRSRepositoryEventProcessor repositoryEventProcessor

repositoryEventMapperName

protected String repositoryEventMapperName

repositoryConnector

protected OMRSRepositoryConnector repositoryConnector

repositoryHelper

protected OMRSRepositoryHelper repositoryHelper

repositoryValidator

protected OMRSRepositoryValidator repositoryValidator

localMetadataCollectionId

protected String localMetadataCollectionId

localServerName

protected String localServerName

localServerType

protected String localServerType

localOrganizationName

protected String localOrganizationName

localServerUserId

protected String localServerUserId

auditLog

protected AuditLog auditLog

Method Detail

setAuditLog

public void setAuditLog(AuditLog auditLog)

Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.

Specified by:

setAuditLog in interface AuditLoggingComponent

Parameters:

auditLog - audit log object

initialize

public void initialize(String repositoryEventMapperName,
                       OMRSRepositoryConnector repositoryConnector)

Pass additional information to the connector needed to process events.

Specified by:

initialize in interface OMRSRepositoryEventMapper

Parameters:

repositoryEventMapperName - repository event mapper name used for the source of the OMRS events.

repositoryConnector - ths is the connector to the local repository that the event mapper is processing events from. The repository connector is used to retrieve additional information necessary to fill out the OMRS Events.

setRepositoryHelper

public void setRepositoryHelper(OMRSRepositoryHelper repositoryHelper)

Set up a repository helper object for the repository connector to use.

Specified by:

setRepositoryHelper in interface OMRSRepositoryEventMapper

Parameters:

repositoryHelper - helper object for building TypeDefs and metadata instances.

setRepositoryValidator

public void setRepositoryValidator(OMRSRepositoryValidator repositoryValidator)

Set up a repository validator for the repository connector to use.

Specified by:

setRepositoryValidator in interface OMRSRepositoryEventMapper

Parameters:

repositoryValidator - validator object to check the validity of TypeDefs and metadata instances.

setServerName

public void setServerName(String serverName)

Set up the name of the server where the metadata collection resides.

Specified by:

setServerName in interface OMRSRepositoryEventMapper

Parameters:

serverName - String name

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.

Specified by:

setServerType in interface OMRSRepositoryEventMapper

Parameters:

serverType - String server type

setOrganizationName

public void setOrganizationName(String organizationName)

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

Specified by:

setOrganizationName in interface OMRSRepositoryEventMapper

Parameters:

organizationName - String organization name

setServerUserId

public void setServerUserId(String localServerUserId)

Set up the userId that the local server should use when processing events and there is no external user driving the operation.

Specified by:

setServerUserId in interface OMRSRepositoryEventMapper

Parameters:

localServerUserId - string user id

setMetadataCollectionId

public void setMetadataCollectionId(String metadataCollectionId)

Set up the unique Id for this metadata collection.

Specified by:

setMetadataCollectionId in interface OMRSRepositoryEventMapper

Parameters:

metadataCollectionId - String unique Id

setRepositoryEventProcessor

public void setRepositoryEventProcessor(OMRSRepositoryEventProcessor repositoryEventProcessor)

Set up the repository event listener for this connector to use. The connector should pass each type or instance metadata change reported by its metadata repository's metadata on to the repository event listener.

Specified by:

setRepositoryEventProcessor in interface OMRSRepositoryEventMapper

Parameters:

repositoryEventProcessor - listener responsible for distributing notifications of local changes to metadata types and instances to the rest of the open metadata repository cluster.

start

public void start()
           throws ConnectorCheckedException

Indicates that the connector is completely configured and can begin processing.

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

disconnect

public void disconnect()
                throws ConnectorCheckedException

Free up any resources held since the connector is no longer needed.

Overrides:

disconnect in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.