Package org.odpi.openmetadata.frameworks.integration.context

Class IntegrationContext

java.lang.Object
org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
Direct Known Subclasses:
AnalyticsIntegratorContext, APIIntegratorContext, CatalogIntegratorContext, DatabaseIntegratorContext, DisplayIntegratorContext, FilesIntegratorContext, InfrastructureIntegratorContext, LineageIntegratorContext, OrganizationIntegratorContext, SecurityIntegratorContext, TopicIntegratorContext
public class IntegrationContext extends Object
IntegrationContext is the base class for the integration context provided to the integration connector to provide access to open metadata services. Each integration service specializes this class to provide the method appropriate for the particular type of technology it is supporting. This base class supports the common methods available to all types of integration connectors.

  • Field Details

    • propertyHelper

      protected final PropertyHelper propertyHelper

    • openIntegrationClient

      protected final OpenIntegrationClient openIntegrationClient

    • actionControlInterface

      protected final ActionControlInterface actionControlInterface

    • governanceConfiguration

      protected final GovernanceConfiguration governanceConfiguration

    • openMetadataStoreClient

      protected final OpenMetadataClient openMetadataStoreClient

    • userId

      protected final String userId

    • connectorName

      protected final String connectorName

    • integrationConnectorGUID

      protected final String integrationConnectorGUID

    • permittedSynchronization

      protected final PermittedSynchronization permittedSynchronization

    • externalSourceGUID

      protected String externalSourceGUID

    • externalSourceName

      protected String externalSourceName

    • externalSourceIsHome

      protected boolean externalSourceIsHome

    • fileClassifier

      protected final FileClassifier fileClassifier

    • integrationReportWriter

      protected final IntegrationReportWriter integrationReportWriter

    • maxPageSize

      protected final int maxPageSize

  • Constructor Details

    • IntegrationContext

      public IntegrationContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String externalSourceGUID, String externalSourceName, String integrationConnectorGUID, AuditLog auditLog, int maxPageSize)
      Constructor handles standard values for all integration contexts.
      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
      generateIntegrationReport - should the connector generate an integration reports?
      permittedSynchronization - enum
      externalSourceGUID - unique identifier of the software server capability for the source of metadata
      externalSourceName - unique name of the software server capability for the source of metadata
      integrationConnectorGUID - unique identifier of the integration connector entity (maybe null)
      auditLog - logging destination
      maxPageSize - max number of elements that can be returned on a query

  • Method Details

    • getMyUserId

      public String getMyUserId()
      Return the userId for this connector. It is used to determine if changes where made by this connector. It should not be needed to issue calls to open metadata.
      Returns:
      string

    • getFileClassifier

      public FileClassifier getFileClassifier()
      Return the file classifier that uses reference data to describe a file.
      Returns:
      file classifier utility

    • elementShouldBeCatalogued

      public boolean elementShouldBeCatalogued(String elementName, List<String> excludedNames, List<String> includedNames)
      Determine whether a particular element should be catalogued. The include list takes precedent over the exclude list.
      Parameters:
      elementName - name of the element
      excludedNames - list of names to exclude (null means ignore value)
      includedNames - list of names to include (null means ignore value)
      Returns:
      flag indicating whether to work with the database

    • addCatalogTarget

      public String addCatalogTarget(String metadataElementGUID, CatalogTargetProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a catalog target to this integration connector.
      Parameters:
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      properties - properties for the relationship.
      Returns:
      catalog target GUID
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem storing the catalog target definition.

    • addCatalogTarget

      public String addCatalogTarget(String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a catalog target to another integration connector.
      Parameters:
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      properties - properties for the relationship.
      Returns:
      catalog target GUID
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem storing the catalog target definition.

    • updateCatalogTarget

      public void updateCatalogTarget(String relationshipGUID, CatalogTargetProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update a catalog target relationship for an integration connector.
      Parameters:
      relationshipGUID - unique identifier of the relationship.
      properties - properties for the relationship.
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem storing the catalog target definition.

    • getCatalogTarget

      public CatalogTarget getCatalogTarget(String relationshipGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      relationshipGUID - unique identifier of the relationship.
      Returns:
      details of the integration connector and the elements it is to catalog
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the integration connector definition.

    • getCatalogTargets

      public List<CatalogTarget> getCatalogTargets(String integrationConnectorGUID, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the identifiers of the metadata elements identified as catalog targets with another integration connector.
      Parameters:
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of named elements
      Throws:
      InvalidParameterException - one of the parameters is null or invalid,
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the integration connector definition.

    • getCatalogTargets

      public List<CatalogTarget> getCatalogTargets(int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector. Each catalog target may be configured with an optional symbolic name to guide the integration connector on how to use the catalog targets.
      Parameters:
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of named element headers
      Throws:
      InvalidParameterException - one of the parameters is null or invalid,
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the integration connector definition.

    • removeCatalogTarget

      public void removeCatalogTarget(String relationshipGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Unregister a catalog target from the integration connector.
      Parameters:
      relationshipGUID - unique identifier of the integration connector.
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem accessing/updating the integration connector definition.

    • getMetadataSourceQualifiedName

      public String getMetadataSourceQualifiedName()
      Return the qualified name of the software capability that represents an external source of metadata. Used to control external provenance and as a parent for some asset cataloguing. If null the provenance is LOCAL_COHORT.
      Returns:
      string name

    • getMetadataSourceGUID

      public String getMetadataSourceGUID()
      Return the guid of the software capability that represents an external source of metadata. Used to control external provenance and as a parent for some asset cataloguing. If null the provenance is LOCAL_COHORT.
      Returns:
      string name

    • setMetadataSourceQualifiedName

      public void setMetadataSourceQualifiedName(String metadataSourceQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Change the metadata collection that is in use when working with open metadata. It should be the qualified name of a software capability, The qualified name is supplied through open metadata values and may be incorrect which is why any exceptions from retrieving the software capability are passed through to the caller.
      Parameters:
      metadataSourceQualifiedName - supplied qualified name for the metadata collection
      Throws:
      InvalidParameterException - the unique name is null or not known.
      UserNotAuthorizedException - the caller's userId is not able to access the element
      PropertyServerException - there is a problem accessing the metadata store

    • setMetadataSourceQualifiedName

      public void setMetadataSourceQualifiedName(String metadataSourceGUID, String metadataSourceQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Change the metadata collection that is in use when working with open metadata. It should be the qualified name of a software capability, The qualified name is supplied through open metadata values and may be incorrect which is why any exceptions from retrieving the software capability are passed through to the caller.
      Parameters:
      metadataSourceGUID - unique identifier of the metadata source (if known)
      metadataSourceQualifiedName - supplied qualified name for the metadata collection
      Throws:
      InvalidParameterException - the unique name is null or not known.
      UserNotAuthorizedException - the caller's userId is not able to access the element
      PropertyServerException - there is a problem accessing the metadata store

    • getExternalSourceIsHome

      public boolean getExternalSourceIsHome()
      Return the flag indicating whether the external source name is to be used as the new element's metadata collection, or they belong to the local cohort.
      Returns:
      flag

    • setExternalSourceIsHome

      public void setExternalSourceIsHome(boolean newValue)
      Set the flag indicating whether the external source name is to be used as the new element's metadata collection, or they belong to the local cohort.
      Parameters:
      newValue - flag

    • getPermittedSynchronization

      public PermittedSynchronization getPermittedSynchronization()
      Return the permitted synchronization direction. This setting may affect which method in the context are available to the integration connector.
      Returns:
      permittedSynchronization enum

    • getIntegrationGovernanceContext

      public IntegrationGovernanceContext getIntegrationGovernanceContext()
      Return the integration governance context that provides access to various Governance Action Framework (GAF) function.
      Returns:
      IntegrationGovernanceContext context object

    • getConnectedAssetContext

      public ConnectedAssetContext getConnectedAssetContext()
      Return the connected asset context that support an integration connector working with assets and their connectors.
      Returns:
      connected asset context

    • setActiveReportPublishing

      public void setActiveReportPublishing(boolean flag)
      Set whether an integration report should be assembled and published. This allows the integration connector to turn off/on integration report writing. It only has an effect if the connector is configured to allow report writing
      Parameters:
      flag - required behaviour

    • reportAnchorGUID

      protected void reportAnchorGUID(String elementGUID, String anchorGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Save the relationship between an element and its anchor. This is called by the methods of the context that create, update, archive or delete elements.
      Parameters:
      elementGUID - unique identifier of the element
      anchorGUID - unique identifier of the associated anchor
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)

    • reportAnchorGUID

      protected void reportAnchorGUID(String elementGUID, String anchorGUID, String anchorTypeName)
      Save the relationship between an element and its anchor. This is called by the methods of the context that create, update, archive or delete elements.
      Parameters:
      elementGUID - unique identifier of the element
      anchorGUID - unique identifier of the associated anchor
      anchorTypeName - type name of the associated anchor

    • reportParentGUID

      protected void reportParentGUID(String elementGUID, String parentGUID)
      Attempt to use the parent's GUID to discover the relationship between an element and its anchor. This is used to identify which report that the element should be reported under.
      Parameters:
      elementGUID - unique identifier of the element
      parentGUID - unique identifier of the associated parent

    • reportElementCreation

      protected void reportElementCreation(String elementGUID)
      Save information about a newly created element.
      Parameters:
      elementGUID - unique identifier of the element

    • reportElementUpdate

      protected void reportElementUpdate(String elementGUID)
      Save information about a newly updated element.
      Parameters:
      elementGUID - unique identifier of the element

    • reportElementDelete

      protected void reportElementDelete(String elementGUID)
      Save information about a newly archived or deleted element.
      Parameters:
      elementGUID - unique identifier of the element

    • isRefreshInProgress

      public boolean isRefreshInProgress()
      Return whether there is a refresh in progress. This method is used in processEvent() to enable to connector to ignore events while it is running refresh() since many of the events are caused by the refresh process. Using this flag prevents the connector from processing the same elements multiple times.
      Returns:
      boolean flag

    • getAnchorGUID

      public String getAnchorGUID(ElementHeader elementHeader)
      Retrieve the anchorGUID from the Anchors classification.
      Parameters:
      elementHeader - element header where the classifications reside
      Returns:
      anchorGUID or null

    • getAnchorGUID

      public String getAnchorGUID(OpenMetadataElement openMetadataElement)
      Retrieve the anchorGUID from the Anchors classification.
      Parameters:
      openMetadataElement - element header where the classifications reside
      Returns:
      anchorGUID or null

    • registerFileListener

      public void registerFileListener(FileListenerInterface listener, File fileToMonitor) throws InvalidParameterException
      Register a listener object that will be called each time a specific file is created, changed or deleted.
      Parameters:
      listener - listener object
      fileToMonitor - name of the file to monitor
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • unregisterFileListener

      public void unregisterFileListener(FileListenerInterface listener, File fileToMonitor) throws InvalidParameterException
      Unregister a listener object that will be called each time a specific file is created, changed or deleted.
      Parameters:
      listener - listener object
      fileToMonitor - name of the file to unregister
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • registerDirectoryListener

      public void registerDirectoryListener(FileDirectoryListenerInterface listener, File directoryToMonitor, FileFilter fileFilter) throws InvalidParameterException
      Register a listener object that will be called each time a file is created, changed or deleted in a specific root directory. The file filter lets you request that only certain types of files are returned.
      Parameters:
      listener - listener object
      directoryToMonitor - details of the file directory to monitor
      fileFilter - a file filter implementation that restricts the files/directories that will be returned to the listener
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • unregisterDirectoryListener

      public void unregisterDirectoryListener(FileDirectoryListenerInterface listener, File directoryToMonitor) throws InvalidParameterException
      Unregister a listener object for the directory.
      Parameters:
      listener - listener object
      directoryToMonitor - details of the file directory unregister
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • registerDirectoryTreeListener

      public void registerDirectoryTreeListener(FileDirectoryListenerInterface listener, File directoryToMonitor, FileFilter fileFilter) throws InvalidParameterException
      Register a listener object that will be called each time a file is created, changed or deleted in a specific root directory and any of its subdirectories. The file filter lets you request that only certain types of files and/or directories are returned.
      Parameters:
      listener - listener object
      directoryToMonitor - details of the root file directory to monitor from
      fileFilter - a file filter implementation that restricts the files/directories that will be returned to the listener
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • unregisterDirectoryTreeListener

      public void unregisterDirectoryTreeListener(FileDirectoryListenerInterface listener, File directoryToMonitor) throws InvalidParameterException
      Unregister a listener object for the directory.
      Parameters:
      listener - listener object
      directoryToMonitor - details of the root file directory to unregister
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.

    • getMaxPageSize

      public int getMaxPageSize()
      Returns the server configuration for the maximum number of elements that can be returned on a request. It is used to control paging.
      Returns:
      integer

    • isTypeOf

      public boolean isTypeOf(ElementHeader elementHeader, String typeName)
      Understand the type of element. It checks the type and super types.
      Parameters:
      elementHeader - element to validate
      typeName - type to test
      Returns:
      boolean flag

    • isTypeOf

      public boolean isTypeOf(ElementType elementType, String typeName)
      Understand the type of element. It checks the type and super types.
      Parameters:
      elementType - element to validate
      typeName - type to test
      Returns:
      boolean flag

    • disconnect

      public void disconnect() throws ConnectorCheckedException
      Disconnect the file listener.
      Throws:
      ConnectorCheckedException - exception disconnecting