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 IntegrationContext

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	collaborationExchangeServiceName	Service for working with feedback elements.
static final String	connectionExchangeServiceName	Service for building and maintaining connections, connector types and endpoints.
static final String	connectorFactoryServiceName	Service for creating connector instances.
static final String	dataAssetExchangeServiceName	Service for working with data stores, data sets, data feeds and APIs.
static final String	externalReferenceExchangeServiceName	Services for maintaining links to external references.
static final String	glossaryExchangeServiceName	Service for maintaining glossaries and their contents
static final String	governanceExchangeServiceName	Service for maintaining governance definitions such as policies and rules.
static final String	infrastructureExchangeServiceName	Service for maintaining models of infrastructure.
static final String	lineageExchangeServiceName	Service for maintaining lineage relationships.
static final String	stewardshipExchangeServiceName	Service for handing actions for stewards.
static final String	validValuesExchangeServiceName	Service for maintaining reference data (valid values).

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

actionControlInterface, connectorName, externalSourceGUID, externalSourceIsHome, externalSourceName, fileClassifier, governanceConfiguration, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, propertyHelper, userId

Constructor Summary

Constructors

Constructor

Description

CatalogIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, ExternalAssetManagerClient assetManagerClient, AssetManagerEventClient eventClient, ConnectedAssetClient connectedAssetClient, CollaborationExchangeClient collaborationExchangeClient, ConnectionExchangeClient connectionExchangeClient, DataAssetExchangeClient dataAssetExchangeClient, ExternalReferenceExchangeClient externalReferenceExchangeClient, GlossaryExchangeClient glossaryExchangeClient, GovernanceExchangeClient governanceExchangeClient, InfrastructureExchangeClient infrastructureExchangeClient, LineageExchangeClient lineageExchangeClient, StewardshipExchangeClient stewardshipExchangeClient, ValidValuesExchangeClient validValuesExchangeClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String assetManagerGUID, String assetManagerName, String integrationServiceName, List<String> disabledExchangeServices, int maxPageSize, AuditLog auditLog)

Create a new context for a connector.

Method Summary

Modifier and Type	Method	Description
void	addExternalIdentifier(String externalScopeGUID, String externalScopeName, String externalScopeTypeName, String openMetadataElementGUID, String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)	Add a new external identifier to an existing open metadata element.
void	addExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)	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.
void	confirmSynchronization(String externalScopeGUID, String externalScopeName, String openMetadataGUID, String openMetadataElementTypeName, String externalIdentifier)	Confirm that the values of a particular metadata element have been synchronized.
String	getAssetManagerGUID()	Return the unique identifier for the asset manager element with a qualifiedName matching the assetManagerName.
String	getAssetManagerName()	Return the qualified name of the asset manager that is supplied in the configuration as metadataSourceQualifiedName.
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).
ConnectorFactoryService	getConnectorFactoryService()	Return the interface for working with connectors to digital resources.
DataAssetExchangeService	getDataAssetExchangeService()	Return the interface for exchanging data asset information (assets, schemas, connections).
ExternalReferenceExchangeService	getExternalReferenceService()	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).
MetadataCorrelationHeader	getMetadataCorrelationHeader(CorrelatedMetadataElement retrievedElement)	Retrieve the correlation header from the retrieved element that matches this asset manager.
StewardshipExchangeService	getStewardshipExchangeService()	Return the interface for exchanging stewardship information.
ValidValuesExchangeService	getValidValuesExchangeService()	Return the interface for exchanging valid values and reference data information.
boolean	isListenerRegistered()	Return a flag indicating whether a listener has been registered or not.
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)	Remove a new external identifier from an existing open metadata element.
void	updateExternalIdentifier(String openMetadataElementGUID, String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)	Update the description of a specific external identifier.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

addCatalogTarget, addCatalogTarget, disconnect, elementShouldBeCatalogued, getAnchorGUID, getAnchorGUID, getCatalogTarget, getCatalogTargets, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceGUID, getMetadataSourceQualifiedName, getMyUserId, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, removeCatalogTarget, reportAnchorGUID, reportAnchorGUID, reportElementCreation, reportElementDelete, reportElementUpdate, reportParentGUID, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, setMetadataSourceQualifiedName, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, updateCatalogTarget

Methods inherited from class java.lang.Object

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

Field Details

connectorFactoryServiceName

public static final String connectorFactoryServiceName

Service for creating connector instances.

See Also:

• Constant Field Values

collaborationExchangeServiceName

public static final String collaborationExchangeServiceName

Service for working with feedback elements.

See Also:

• Constant Field Values

connectionExchangeServiceName

public static final String connectionExchangeServiceName

Service for building and maintaining connections, connector types and endpoints.

See Also:

• Constant Field Values

dataAssetExchangeServiceName

public static final String dataAssetExchangeServiceName

Service for working with data stores, data sets, data feeds and APIs.

See Also:

• Constant Field Values

externalReferenceExchangeServiceName

public static final String externalReferenceExchangeServiceName

Services for maintaining links to external references.

See Also:

• Constant Field Values

glossaryExchangeServiceName

public static final String glossaryExchangeServiceName

Service for maintaining glossaries and their contents

See Also:

• Constant Field Values

governanceExchangeServiceName

public static final String governanceExchangeServiceName

Service for maintaining governance definitions such as policies and rules.

See Also:

• Constant Field Values

infrastructureExchangeServiceName

public static final String infrastructureExchangeServiceName

Service for maintaining models of infrastructure.

See Also:

• Constant Field Values

lineageExchangeServiceName

public static final String lineageExchangeServiceName

Service for maintaining lineage relationships.

See Also:

• Constant Field Values

stewardshipExchangeServiceName

public static final String stewardshipExchangeServiceName

Service for handing actions for stewards.

See Also:

• Constant Field Values

validValuesExchangeServiceName

public static final String validValuesExchangeServiceName

Service for maintaining reference data (valid values).

See Also:

• Constant Field Values

Constructor Details

CatalogIntegratorContext

public CatalogIntegratorContext(String connectorId,
 String connectorName,
 String connectorUserId,
 String serverName,
 OpenIntegrationClient openIntegrationClient,
 GovernanceConfiguration governanceConfiguration,
 OpenMetadataClient openMetadataStoreClient,
 ActionControlInterface actionControlInterface,
 ExternalAssetManagerClient assetManagerClient,
 AssetManagerEventClient eventClient,
 ConnectedAssetClient connectedAssetClient,
 CollaborationExchangeClient collaborationExchangeClient,
 ConnectionExchangeClient connectionExchangeClient,
 DataAssetExchangeClient dataAssetExchangeClient,
 ExternalReferenceExchangeClient externalReferenceExchangeClient,
 GlossaryExchangeClient glossaryExchangeClient,
 GovernanceExchangeClient governanceExchangeClient,
 InfrastructureExchangeClient infrastructureExchangeClient,
 LineageExchangeClient lineageExchangeClient,
 StewardshipExchangeClient stewardshipExchangeClient,
 ValidValuesExchangeClient validValuesExchangeClient,
 boolean generateIntegrationReport,
 PermittedSynchronization permittedSynchronization,
 String integrationConnectorGUID,
 String assetManagerGUID,
 String assetManagerName,
 String integrationServiceName,
 List<String> disabledExchangeServices,
 int maxPageSize,
 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

governanceConfiguration - client for managing catalog targets

openMetadataStoreClient - client for calling the metadata server

actionControlInterface - client for initiating governance actions

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

maxPageSize - max number of elements that can be returned on a query

auditLog - logging destination

Method Details

getAssetManagerGUID

public String getAssetManagerGUID()

Return the unique identifier for the asset manager element with a qualifiedName matching the assetManagerName.

Returns:

string guid

getAssetManagerName

public String getAssetManagerName()

Return the qualified name of the asset manager that is supplied in the configuration as metadataSourceQualifiedName.

Returns:

string name

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.

isListenerRegistered

public boolean isListenerRegistered()

Return a flag indicating whether a listener has been registered or not.

Returns:

true means the listener has been successfully registered

getMetadataCorrelationHeader

public MetadataCorrelationHeader getMetadataCorrelationHeader(CorrelatedMetadataElement retrievedElement)
                                                       throws InvalidParameterException

Retrieve the correlation header from the retrieved element that matches this asset manager.

Parameters:

retrievedElement - element retrieved from the metadata repository

Returns:

metadata correlation header or null if the element does not have a matching correlation header

Throws:

InvalidParameterException - the element passed is null

addExternalIdentifier

public void addExternalIdentifier(String openMetadataElementGUID,
 String openMetadataElementTypeName,
 ExternalIdentifierProperties externalIdentifierProperties)
                           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

externalIdentifierProperties - optional properties used to define an external identifier

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addExternalIdentifier

public void addExternalIdentifier(String externalScopeGUID,
 String externalScopeName,
 String externalScopeTypeName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 ExternalIdentifierProperties externalIdentifierProperties)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a new external identifier to an existing open metadata element.

Parameters:

externalScopeGUID - unique identifier of the software capability that owns this collection

externalScopeName - unique name of the software capability that owns this collection

externalScopeTypeName - type name of the software capability describing the manager for the external identifier

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:

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,
 ExternalIdentifierProperties externalIdentifierProperties)
                              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

externalIdentifierProperties - optional properties used to define an external identifier

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

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

confirmSynchronization

public void confirmSynchronization(String externalScopeGUID,
 String externalScopeName,
 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 point of view, and to allow bidirectional updates of metadata using optimistic locking.

Parameters:

externalScopeGUID - unique identifier for the owning scope (typically a catalog)

externalScopeName - unique name for the owning scope (typically a catalog)

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

getConnectorFactoryService

public ConnectorFactoryService getConnectorFactoryService()
                                                   throws UserNotAuthorizedException

Return the interface for working with connectors to digital resources.

Returns:

collaboration exchange service

Throws:

UserNotAuthorizedException - this option is not enabled in the configuration

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

getExternalReferenceService

public ExternalReferenceExchangeService getExternalReferenceService()
                                                             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