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

Class AtlasReferenceClassificationsIntegrationModule

java.lang.Object

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

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

public class AtlasReferenceClassificationsIntegrationModule
extends AtlasIntegrationModuleBase

AtlasReferenceClassificationsIntegrationModule synchronizes a valid value set of classification definitions from the open metadata ecosystem to Apache Atlas as classification definitions. This is used to It is called after the registered integration modules have established the key assets into 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, moduleName, myContext, openMetadataAccess, openMetadataAssociatedElementPropertyName, openMetadataAssociatedGlossaryPropertyName, openMetadataCorrelationLinkTypeName, openMetadataCorrelationPropertyName, openMetadataCorrelationTypeName, openMetadataGlossaryCorrelationLinkTypeName, propertyHelper, stewardshipExchangeService, targetRootURL

Constructor Summary

Constructors

Constructor	Description
AtlasReferenceClassificationsIntegrationModule(String connectorName, ConnectionProperties connectionProperties, AuditLog auditLog, CatalogIntegratorContext myContext, String targetRootURL, ApacheAtlasRESTConnector atlasClient, List<Connector> embeddedConnectors, String classificationReferenceSetName, String classificationReferenceSetPolicy)	Constructor for the module is supplied with the runtime context in order to operate.

Method Summary

Modifier and Type	Method	Description
String	getClassificationReferenceSetGUID()	Return the unique identifier of the reference data set qualified name.
Map<String,ValidValueElement>	synchronizeClassificationDefinitions()	Exchange Atlas classification types as defined by the classification reference set.

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

AtlasReferenceClassificationsIntegrationModule

public AtlasReferenceClassificationsIntegrationModule(String connectorName,
 ConnectionProperties connectionProperties,
 AuditLog auditLog,
 CatalogIntegratorContext myContext,
 String targetRootURL,
 ApacheAtlasRESTConnector atlasClient,
 List<Connector> embeddedConnectors,
 String classificationReferenceSetName,
 String classificationReferenceSetPolicy)
                                               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

classificationReferenceSetName - determines what type of mapping to perform for informal tags

classificationReferenceSetPolicy - determines the direction of exchange between the open metadata ecosystem and Apache Atlas

Throws:

UserNotAuthorizedException - security problem

Method Details

synchronizeClassificationDefinitions

public Map<String,ValidValueElement> synchronizeClassificationDefinitions()

Exchange Atlas classification types as defined by the classification reference set.

Returns:

map of classification names to reference classification definitions

getClassificationReferenceSetGUID

public String getClassificationReferenceSetGUID()
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the unique identifier of the reference data set qualified name.

Returns:

string guid

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.