Package org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules

Interface RegisteredIntegrationModule

All Known Implementing Classes:
ApacheHiveIntegrationModule, ApacheKafkaIntegrationModule, AtlasGlossaryIntegrationModule, AtlasRegisteredIntegrationModuleBase, DatabaseIntegrationModuleBase, RDBMSIntegrationModule
public interface RegisteredIntegrationModule
RegisteredIntegrationModule defines the interface for an integration module that wants to be called to synchronize metadata between Egeria's open metadata ecosystem and Apache Atlas. The integration work is divided into modules that each focus on a particular type of open metadata. This is because the mapping between Apache atlas and open metadata is not one-to-one and requires special case code in places.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getListenForTypes()
    Return the list of open metadata types that this module supports events for.
    String
    getModuleName()
    Return the name of this module for messages.
    List<String>
    getSupportedEntityTypes()
    Return the list of entity types that this module is maintaining.
    void
    processEvent(OpenMetadataOutTopicEvent event)
    Process an event that was published by the Asset Manager OMAS.
    void
    refresh()
    Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.

  • Method Details

    • getSupportedEntityTypes

      List<String> getSupportedEntityTypes()
      Return the list of entity types that this module is maintaining.
      Returns:
      list of type names

    • getListenForTypes

      List<String> getListenForTypes()
      Return the list of open metadata types that this module supports events for.
      Returns:
      list of types

    • getModuleName

      String getModuleName()
      Return the name of this module for messages.
      Returns:
      module name

    • refresh

      void refresh() throws ConnectorCheckedException
      Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories. Refresh is called when the integration connector first starts and then at intervals defined in the connector's configuration as well as any external REST API calls to explicitly refresh the connector.
      Throws:
      ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.

    • processEvent

      void processEvent(OpenMetadataOutTopicEvent event)
      Process an event that was published by the Asset Manager OMAS. The listener is only registered if metadata is flowing from the open metadata ecosystem to Apache Atlas.
      Parameters:
      event - event object