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:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, OMRSRepositoryEventMapper
Direct Known Subclasses:
OMRSRepositoryEventMapperBase
public abstract class OMRSRepositoryEventMapperConnector extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements OMRSRepositoryEventMapper, org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
OMRSRepositoryEventMapperBase provides a base class for implementors of OMRSRepositoryEventMapper.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disconnect()
    Free up any resources held since the connector is no longer needed.
    org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
    getConnectorComponentDescription()
    Return the component description that is used by this connector in the audit log.
    void
    initialize(String repositoryEventMapperName, OMRSRepositoryConnector repositoryConnector)
    Pass additional information to the connector needed to process events.
    void
    setAuditLog(org.odpi.openmetadata.frameworks.auditlog.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, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, toString

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

    clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • setAuditLog

      public void setAuditLog(org.odpi.openmetadata.frameworks.auditlog.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 org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Parameters:
      auditLog - audit log object

    • getConnectorComponentDescription

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDescription getConnectorComponentDescription()
      Return the component description that is used by this connector in the audit log.
      Specified by:
      getConnectorComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Returns:
      id, name, description, wiki page URL.

    • 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 cohort.

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the connector is completely configured and can begin processing.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.

    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Free up any resources held since the connector is no longer needed.
      Overrides:
      disconnect in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.