Package org.odpi.openmetadata.integrationservices.catalog.connector

Class CatalogIntegratorContext

java.lang.Object
org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
org.odpi.openmetadata.integrationservices.catalog.connector.CatalogIntegratorContext
public class CatalogIntegratorContext extends org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
CatalogIntegratorContext provides a wrapper around the Asset Manager OMAS client. It provides the simplified interface to open metadata needed by the CatalogIntegratorConnector.

  • Field Details

  • Constructor Details

    • CatalogIntegratorContext

      public CatalogIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient openIntegrationClient, org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient openMetadataStoreClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ExternalAssetManagerClient assetManagerClient, org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerEventClient eventClient, org.odpi.openmetadata.accessservices.assetmanager.client.ConnectedAssetClient connectedAssetClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.CollaborationExchangeClient collaborationExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ConnectionExchangeClient connectionExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.DataAssetExchangeClient dataAssetExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ExternalReferenceExchangeClient externalReferenceExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GlossaryExchangeClient glossaryExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GovernanceExchangeClient governanceExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.InfrastructureExchangeClient infrastructureExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.LineageExchangeClient lineageExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.StewardshipExchangeClient stewardshipExchangeClient, org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ValidValuesExchangeClient validValuesExchangeClient, boolean generateIntegrationReport, org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String assetManagerGUID, String assetManagerName, String integrationServiceName, List<String> disabledExchangeServices, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Create a new context for a connector.
      Parameters:
      connectorId - unique identifier of the connector (used to configure the event listener)
      connectorName - name of connector from config
      connectorUserId - userId for the connector
      serverName - name of the integration daemon
      openIntegrationClient - client for calling the metadata server
      openMetadataStoreClient - client for calling the metadata server
      assetManagerClient - common client to map requests to
      eventClient - client to register for events
      connectedAssetClient - client for connectors
      collaborationExchangeClient - client for collaboration requests
      connectionExchangeClient - client for connection requests
      dataAssetExchangeClient - client for asset requests
      externalReferenceExchangeClient - client for data asset requests
      glossaryExchangeClient - client for glossary requests
      governanceExchangeClient - client for governance requests
      infrastructureExchangeClient - client for infrastructure requests
      lineageExchangeClient - client for lineage requests
      stewardshipExchangeClient - client for stewardship requests
      validValuesExchangeClient - client for valid values requests
      assetManagerGUID - unique identifier of the software server capability for the asset manager
      assetManagerName - unique name of the software server capability for the asset manager
      generateIntegrationReport - should the connector generate an integration reports?
      permittedSynchronization - the direction of integration permitted by the integration connector
      integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).
      disabledExchangeServices - option from the integration service's configuration
      integrationServiceName - name of this service
      auditLog - logging destination

  • Method Details

    • getAssetManagerName

      public String getAssetManagerName()
      Return the qualified name of the asset manager that is supplied in the configuration document.
      Returns:
      string name

    • registerListener

      public void registerListener(org.odpi.openmetadata.accessservices.assetmanager.api.AssetManagerEventListener listener) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Register a listener object that will be passed each of the events published by the Asset Manager OMAS.
      Parameters:
      listener - listener object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addExternalIdentifier

      public void addExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a new external identifier to an existing open metadata element.
      Parameters:
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name for the open metadata element
      externalIdentifierProperties - optional properties used to define an external identifier
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • updateExternalIdentifier

      public void updateExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalIdentifierProperties externalIdentifierProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the description of a specific external identifier.
      Parameters:
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name for the open metadata element
      externalIdentifierProperties - optional properties used to define an external identifier
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • removeExternalIdentifier

      public void removeExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a new external identifier from an existing open metadata element. The open metadata element is not affected.
      Parameters:
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name for the open metadata element
      externalIdentifier - unique identifier of this element in the third party asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • confirmSynchronization

      public void confirmSynchronization(String openMetadataGUID, String openMetadataElementTypeName, String externalIdentifier) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Confirm that the values of a particular metadata element have been synchronized. This is important from an audit points of view, and to allow bidirectional updates of metadata using optimistic locking.
      Parameters:
      openMetadataGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      externalIdentifier - unique identifier of this element in the external asset manager
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • getConnectorFactoryService

      public ConnectorFactoryService getConnectorFactoryService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for working with connectors to digital resources.
      Returns:
      collaboration exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getCollaborationExchangeService

      public CollaborationExchangeService getCollaborationExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging collaboration information (comments, likes, reviews, tags).
      Returns:
      collaboration exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getConnectionExchangeService

      public ConnectionExchangeService getConnectionExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging connection information (connections, connector types, endpoints).
      Returns:
      connection exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getDataAssetExchangeService

      public DataAssetExchangeService getDataAssetExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging data asset information (assets, schemas, connections).
      Returns:
      data asset exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getExternalReferenceService

      public ExternalReferenceExchangeService getExternalReferenceService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging data asset information (assets, schemas, connections).
      Returns:
      data asset exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getGlossaryExchangeService

      public GlossaryExchangeService getGlossaryExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging glossary information (glossaries, with categories, terms and relationships)
      Returns:
      glossary exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getGovernanceExchangeService

      public GovernanceExchangeService getGovernanceExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging governance information (policies, rules, ...)
      Returns:
      governance exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getInfrastructureExchangeService

      public InfrastructureExchangeService getInfrastructureExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging infrastructure information (servers, applications, hosts etc).
      Returns:
      infrastructure exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getLineageExchangeService

      public LineageExchangeService getLineageExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging lineage information (processes, ports, schemas, lineage linkage etc).
      Returns:
      lineage exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getStewardshipExchangeService

      public StewardshipExchangeService getStewardshipExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging stewardship information.
      Returns:
      stewardship exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration

    • getValidValuesExchangeService

      public ValidValuesExchangeService getValidValuesExchangeService() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return the interface for exchanging valid values and reference data information.
      Returns:
      valid values exchange service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this option is not enabled in the configuration