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

Class CatalogIntegratorContext

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.CatalogIntegratorContext

public class CatalogIntegratorContext
extends Object

CatalogIntegratorContext provides a wrapper around the Asset Manager OMAS client. It provides the simplified interface to open metadata needed by the CatalogIntegratorConnector.

Constructor Summary

Constructors

Constructor

Description

CatalogIntegratorContext(ExternalAssetManagerClient assetManagerClient, AssetManagerEventClient eventClient, CollaborationExchangeClient collaborationExchangeClient, ConnectionExchangeClient connectionExchangeClient, DataAssetExchangeClient dataAssetExchangeClient, GlossaryExchangeClient glossaryExchangeClient, GovernanceExchangeClient governanceExchangeClient, InfrastructureExchangeClient infrastructureExchangeClient, LineageExchangeClient lineageExchangeClient, StewardshipExchangeClient stewardshipExchangeClient, ValidValuesExchangeClient validValuesExchangeClient, String userId, String assetManagerGUID, String assetManagerName, String connectorName, String integrationServiceName, SynchronizationDirection synchronizationDirection, List<String> disabledExchangeServices, AuditLog auditLog)

Create a new context for a connector.

Method Summary

Modifier and Type	Method	Description
void	addExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier, String externalIdentifierName, String externalIdentifierUsage, KeyPattern keyPattern, Map<String,String> mappingProperties)	Add a new external identifier to an existing open metadata element.
void	confirmSynchronization(String openMetadataGUID, String openMetadataElementTypeName, String externalIdentifier)	Confirm that the values of a particular metadata element have been synchronized.
CollaborationExchangeService	getCollaborationExchangeService()	Return the interface for exchanging collaboration information (comments, likes, reviews, tags).
ConnectionExchangeService	getConnectionExchangeService()	Return the interface for exchanging connection information (connections, connector types, endpoints).
DataAssetExchangeService	getDataAssetExchangeService()	Return the interface for exchanging data asset information (assets, schemas, connections).
GlossaryExchangeService	getGlossaryExchangeService()	Return the interface for exchanging glossary information (glossaries, with categories, terms and relationships)
GovernanceExchangeService	getGovernanceExchangeService()	Return the interface for exchanging governance information (policies, rules, ...)
InfrastructureExchangeService	getInfrastructureExchangeService()	Return the interface for exchanging infrastructure information (servers, applications, hosts etc).
LineageExchangeService	getLineageExchangeService()	Return the interface for exchanging lineage information (processes, ports, schemas, lineage linkage etc).
StewardshipExchangeService	getStewardshipExchangeService()	Return the interface for exchanging stewardship information.
ValidValuesExchangeService	getValidValuesExchangeService()	Return the interface for exchanging valid values and reference data information.
void	registerListener(AssetManagerEventListener listener)	Register a listener object that will be passed each of the events published by the Asset Manager OMAS.
void	removeExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier, String externalIdentifierName, String externalIdentifierUsage, KeyPattern keyPattern, Map<String,String> mappingProperties)	Remove a new external identifier from an existing open metadata element.
void	updateExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier, String externalIdentifierName, String externalIdentifierUsage, KeyPattern keyPattern, Map<String,String> mappingProperties)	Update the description of a specific external identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogIntegratorContext

public CatalogIntegratorContext(ExternalAssetManagerClient assetManagerClient,
                                AssetManagerEventClient eventClient,
                                CollaborationExchangeClient collaborationExchangeClient,
                                ConnectionExchangeClient connectionExchangeClient,
                                DataAssetExchangeClient dataAssetExchangeClient,
                                GlossaryExchangeClient glossaryExchangeClient,
                                GovernanceExchangeClient governanceExchangeClient,
                                InfrastructureExchangeClient infrastructureExchangeClient,
                                LineageExchangeClient lineageExchangeClient,
                                StewardshipExchangeClient stewardshipExchangeClient,
                                ValidValuesExchangeClient validValuesExchangeClient,
                                String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String connectorName,
                                String integrationServiceName,
                                SynchronizationDirection synchronizationDirection,
                                List<String> disabledExchangeServices,
                                AuditLog auditLog)

Create a new context for a connector.

Parameters:

assetManagerClient - common client to map requests to

eventClient - client to register for events

collaborationExchangeClient - client for collaboration requests

connectionExchangeClient - client for connection requests

dataAssetExchangeClient - 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

userId - integration daemon's userId

assetManagerGUID - unique identifier of the software server capability for the asset manager

assetManagerName - unique name of the software server capability for the asset manager

connectorName - name of the connector using this context

synchronizationDirection - controls the direction of synchronization that should be allowed

disabledExchangeServices - option from the integration service's configuration

integrationServiceName - name of this service

auditLog - logging destination

Method Detail

registerListener

public void registerListener(AssetManagerEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Asset Manager OMAS.

Parameters:

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addExternalIdentifier

public void addExternalIdentifier(String openMetadataElementGUID,
                                  String openMetadataElementTypeName,
                                  String externalIdentifier,
                                  String externalIdentifierName,
                                  String externalIdentifierUsage,
                                  KeyPattern keyPattern,
                                  Map<String,String> mappingProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  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

externalIdentifier - unique identifier of this element in the third party asset manager

externalIdentifierName - name of the identifier in the third party asset manager

externalIdentifierUsage - description of how the open metadata element maps to the identifier

keyPattern - style of the external identifier

mappingProperties - additional mapping properties

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateExternalIdentifier

public void updateExternalIdentifier(String openMetadataElementGUID,
                                     String openMetadataElementTypeName,
                                     String externalIdentifier,
                                     String externalIdentifierName,
                                     String externalIdentifierUsage,
                                     KeyPattern keyPattern,
                                     Map<String,String> mappingProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     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

externalIdentifier - unique identifier of this element in the external asset manager

externalIdentifierName - name of the identifier in the third party asset manager

externalIdentifierUsage - description of how the open metadata element maps to the identifier

keyPattern - style of the external identifier

mappingProperties - additional mapping properties

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeExternalIdentifier

public void removeExternalIdentifier(String openMetadataElementGUID,
                                     String openMetadataElementTypeName,
                                     String externalIdentifier,
                                     String externalIdentifierName,
                                     String externalIdentifierUsage,
                                     KeyPattern keyPattern,
                                     Map<String,String> mappingProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     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

externalIdentifierName - name of the identifier in the third party asset manager

externalIdentifierUsage - description of how the open metadata element maps to the identifier

keyPattern - style of the external identifier

mappingProperties - additional mapping properties

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

confirmSynchronization

public void confirmSynchronization(String openMetadataGUID,
                                   String openMetadataElementTypeName,
                                   String externalIdentifier)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getCollaborationExchangeService

public CollaborationExchangeService getCollaborationExchangeService()
                                                             throws UserNotAuthorizedException

Return the interface for exchanging collaboration information (comments, likes, reviews, tags).

Returns:

collaboration exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getConnectionExchangeService

public ConnectionExchangeService getConnectionExchangeService()
                                                       throws UserNotAuthorizedException

Return the interface for exchanging connection information (connections, connector types, endpoints).

Returns:

connection exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getDataAssetExchangeService

public DataAssetExchangeService getDataAssetExchangeService()
                                                     throws UserNotAuthorizedException

Return the interface for exchanging data asset information (assets, schemas, connections).

Returns:

data asset exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getGlossaryExchangeService

public GlossaryExchangeService getGlossaryExchangeService()
                                                   throws UserNotAuthorizedException

Return the interface for exchanging glossary information (glossaries, with categories, terms and relationships)

Returns:

glossary exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getGovernanceExchangeService

public GovernanceExchangeService getGovernanceExchangeService()
                                                       throws UserNotAuthorizedException

Return the interface for exchanging governance information (policies, rules, ...)

Returns:

governance exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getInfrastructureExchangeService

public InfrastructureExchangeService getInfrastructureExchangeService()
                                                               throws UserNotAuthorizedException

Return the interface for exchanging infrastructure information (servers, applications, hosts etc).

Returns:

infrastructure exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getLineageExchangeService

public LineageExchangeService getLineageExchangeService()
                                                 throws UserNotAuthorizedException

Return the interface for exchanging lineage information (processes, ports, schemas, lineage linkage etc).

Returns:

lineage exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getStewardshipExchangeService

public StewardshipExchangeService getStewardshipExchangeService()
                                                         throws UserNotAuthorizedException

Return the interface for exchanging stewardship information.

Returns:

stewardship exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

getValidValuesExchangeService

public ValidValuesExchangeService getValidValuesExchangeService()
                                                         throws UserNotAuthorizedException

Return the interface for exchanging valid values and reference data information.

Returns:

valid values exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration