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

Class DatabaseIntegrationModuleBase

java.lang.Object
org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.AtlasIntegrationModuleBase
org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.AtlasRegisteredIntegrationModuleBase
org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.DatabaseIntegrationModuleBase
All Implemented Interfaces:
RegisteredIntegrationModule
Direct Known Subclasses:
ApacheHiveIntegrationModule, RDBMSIntegrationModule
public abstract class DatabaseIntegrationModuleBase extends AtlasRegisteredIntegrationModuleBase
DatabaseIntegrationModuleBase abstracts the process of synchronizing relational metadata from Apache Atlas, so it is independent of the actual Apache Atlas types. The subclasses supply the types. This is because Apache Atlas has multiple type definitions for this type of metadata.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatabaseIntegrationModuleBase(String connectorName, String moduleName, String atlasDatabaseTypeName, String atlasDatabaseTablesPropertyName, String atlasDatabaseTableTypeName, String atlasDatabaseColumnsPropertyName, String atlasDatabaseColumnTypeName, org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connectionProperties, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, org.odpi.openmetadata.integrationservices.catalog.connector.CatalogIntegratorContext myContext, String targetRootURL, ApacheAtlasRESTConnector atlasClient, List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors)
    Constructor for the module is supplied with the runtime context in order to operate.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    processEvent(org.odpi.openmetadata.accessservices.assetmanager.events.AssetManagerOutTopicEvent 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.

    Methods inherited from class org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.AtlasRegisteredIntegrationModuleBase

    getListenForTypes, getModuleName, getSupportedEntityTypes

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DatabaseIntegrationModuleBase

      public DatabaseIntegrationModuleBase(String connectorName, String moduleName, String atlasDatabaseTypeName, String atlasDatabaseTablesPropertyName, String atlasDatabaseTableTypeName, String atlasDatabaseColumnsPropertyName, String atlasDatabaseColumnTypeName, org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connectionProperties, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, org.odpi.openmetadata.integrationservices.catalog.connector.CatalogIntegratorContext myContext, String targetRootURL, ApacheAtlasRESTConnector atlasClient, List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Constructor for the module is supplied with the runtime context in order to operate.
      Parameters:
      connectorName - name of the connector (for messages)
      moduleName - name of this module
      atlasDatabaseTypeName - name of type in atlas used for the database
      atlasDatabaseTablesPropertyName - name of the property used to navigate from the database to its tables.
      atlasDatabaseTableTypeName - name of the type used to represent a database table in atlas
      atlasDatabaseColumnsPropertyName - name of the property used to navigate from a database table to its columns
      atlasDatabaseColumnTypeName - name of the type used to represent a database column in atlas
      connectionProperties - connection properties used to start the connector
      auditLog - logging destination
      myContext - integration context
      targetRootURL - URL to connect to Apache Atlas
      atlasClient - client to connect to Apache Atlas
      embeddedConnectors - list of any embedded connectors (such as secrets connector and topic connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security problem

  • Method Details

    • refresh

      public void refresh() throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.

    • processEvent

      public void processEvent(org.odpi.openmetadata.accessservices.assetmanager.events.AssetManagerOutTopicEvent 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