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

Class AtlasGlossaryIntegrationModule

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.AtlasGlossaryIntegrationModule

All Implemented Interfaces:

RegisteredIntegrationModule

public class AtlasGlossaryIntegrationModule
extends AtlasRegisteredIntegrationModuleBase

AtlasGlossaryIntegrationModule exchanges glossary terms between Apache Atlas and the open metadata ecosystem.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.AtlasIntegrationModuleBase

atlasAssetProperties, atlasClient, atlasCreateTimePropertyName, atlasDataFileProperties, atlasDescriptionPropertyName, atlasDisplayNamePropertyName, atlasModifiedTimePropertyName, atlasNamePropertyName, atlasOwnerPropertyName, atlasPathPropertyName, atlasQualifiedNamePropertyName, atlasUserDescriptionPropertyName, auditLog, collaborationExchangeService, connectionProperties, connectorName, dataAssetExchangeService, egeriaGUIDPropertyName, egeriaOwnedPropertyName, egeriaOwnerPropertyName, egeriaOwnerTypeName, egeriaQualifiedNamePropertyName, egeriaTypeNamePropertyName, embeddedConnectors, myContext, openMetadataAccess, openMetadataAssociatedElementPropertyName, openMetadataAssociatedGlossaryPropertyName, openMetadataCorrelationLinkTypeName, openMetadataCorrelationPropertyName, openMetadataCorrelationTypeName, openMetadataGlossaryCorrelationLinkTypeName, propertyHelper, stewardshipExchangeService, targetRootURL

Constructor Summary

Constructors

Constructor	Description
AtlasGlossaryIntegrationModule(String connectorName, ConnectionProperties connectionProperties, AuditLog auditLog, CatalogIntegratorContext myContext, String targetRootURL, ApacheAtlasRESTConnector atlasClient, List<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(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 org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.AtlasIntegrationModuleBase

addPropertyMapToAdditionalProperties, addRemainingPropertiesToAdditionalProperties, addStringArrayToAdditionalProperties, atlasUpdateRequired, createAtlasDataSetAsDataSetInEgeria, egeriaUpdateRequired, ensureAtlasExternalIdentifier, getAtlasBooleanProperty, getAtlasGUID, getAtlasPropertyMap, getAtlasStringArray, getAtlasStringProperty, getDataAssetProperties, getEgeriaDataFileProperties, getEgeriaDataSetProperties, getEgeriaGUID, getExternalIdentifier, getExternalIdentifier, getProcessProperties, getSchemaAttributeProperties, getValidAtlasGUIDs, isAtlasOwnedElement, isEgeriaOwned, isEgeriaOwned, isEgeriaOwned, removeEgeriaGUID, saveEgeriaGUIDInAtlas, setOwner, syncAtlasDataSetAsDataSet, syncAtlasDataSetsAsDataSets, updateAtlasDataSetAsDataSetInEgeria, updateExternalIdentifierAfterAtlasUpdate

Methods inherited from class java.lang.Object

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

Constructor Details

AtlasGlossaryIntegrationModule

public AtlasGlossaryIntegrationModule(String connectorName,
 ConnectionProperties connectionProperties,
 AuditLog auditLog,
 CatalogIntegratorContext myContext,
 String targetRootURL,
 ApacheAtlasRESTConnector atlasClient,
 List<Connector> embeddedConnectors)
                               throws UserNotAuthorizedException

Constructor for the module is supplied with the runtime context in order to operate.

Parameters:

connectorName - name of the connector (for messages)

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:

UserNotAuthorizedException - security problem

Method Details

refresh

public void refresh()
             throws 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.

This method performs two sweeps. It first retrieves the glossary elements from Egeria and synchronizes them with Apache Atlas. The second sweep works through the glossaries in Apache Atlas and ensures that none have been missed out by the first sweep.

Throws:

ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.

processEvent

public void processEvent(AssetManagerOutTopicEvent event)

Process an event that was published by the Asset Manager OMAS. This connector is only interested in listening for glossaries, glossary categories and glossary terms. The listener that calls this method is only registered if metadata is flowing from the open metadata ecosystem to Apache Atlas.

Parameters:

event - event object