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

Class AtlasRegisteredIntegrationModuleBase

java.lang.Object

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

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

All Implemented Interfaces:

RegisteredIntegrationModule

Direct Known Subclasses:

ApacheKafkaIntegrationModule, AtlasGlossaryIntegrationModule, DatabaseIntegrationModuleBase

public abstract class AtlasRegisteredIntegrationModuleBase
extends AtlasIntegrationModuleBase
implements RegisteredIntegrationModule

AtlasRegisteredIntegrationModuleBase defines the common classes for integration modules that are working with assets from Apache Atlas.

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, moduleName, myContext, openMetadataAccess, openMetadataAssociatedElementPropertyName, openMetadataAssociatedGlossaryPropertyName, openMetadataCorrelationLinkTypeName, openMetadataCorrelationPropertyName, openMetadataCorrelationTypeName, openMetadataGlossaryCorrelationLinkTypeName, propertyHelper, stewardshipExchangeService, targetRootURL

Constructor Summary

Constructors

Constructor	Description
AtlasRegisteredIntegrationModuleBase(String connectorName, String moduleName, ConnectionProperties connectionProperties, AuditLog auditLog, CatalogIntegratorContext myContext, String targetRootURL, ApacheAtlasRESTConnector atlasClient, List<Connector> embeddedConnectors, String[] supportedEntityTypes, String[] listenForTypes)	Initialize the common properties for an integration module.

Method Summary

Modifier and Type	Method	Description
List<String>	getListenForTypes()	Return the list of open metadata types that this module supports events for.
String	getModuleName()	Return the name of this module for messages.
List<String>	getSupportedEntityTypes()	Return the list of entity types that this module is maintaining.

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

Methods inherited from interface org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.RegisteredIntegrationModule

processEvent, refresh

Constructor Details

AtlasRegisteredIntegrationModuleBase

public AtlasRegisteredIntegrationModuleBase(String connectorName,
 String moduleName,
 ConnectionProperties connectionProperties,
 AuditLog auditLog,
 CatalogIntegratorContext myContext,
 String targetRootURL,
 ApacheAtlasRESTConnector atlasClient,
 List<Connector> embeddedConnectors,
 String[] supportedEntityTypes,
 String[] listenForTypes)
                                     throws UserNotAuthorizedException

Initialize the common properties for an integration module.

Parameters:

connectorName - name of this connector

moduleName - name of this module

connectionProperties - supplied connector used to configure the connector

auditLog - logging destination

myContext - integration context assigned to the connector

targetRootURL - host name and port of Apache Atlas

atlasClient - client to call Apache Atlas

embeddedConnectors - any connectors embedded in the connector (such as the secrets connector or Kafka connector)

supportedEntityTypes - list of entity types that this module is maintaining

listenForTypes - list of types that the module wants to receive events on

Throws:

UserNotAuthorizedException - the data asset service has not been enabled.

Method Details

getSupportedEntityTypes

public List<String> getSupportedEntityTypes()

Return the list of entity types that this module is maintaining.

Specified by:

getSupportedEntityTypes in interface RegisteredIntegrationModule

Returns:

list of type names

getListenForTypes

public List<String> getListenForTypes()

Return the list of open metadata types that this module supports events for.

Specified by:

getListenForTypes in interface RegisteredIntegrationModule

Returns:

list of types

getModuleName

public String getModuleName()

Return the name of this module for messages.

Specified by:

getModuleName in interface RegisteredIntegrationModule

Returns:

module name