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

Class ApacheAtlasIntegrationProvider

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider

org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.ApacheAtlasIntegrationProvider

All Implemented Interfaces:

AuditLoggingComponent

public class ApacheAtlasIntegrationProvider
extends IntegrationConnectorProvider

ApacheAtlasIntegrationProvider is the connector provider for the Apache Atlas integration connector that publishes glossary terms to Apache Atlas.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE	Static literal for setting openMetadataTypesPolicy to "ALL".
static final String	ALL_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE	Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "ALL".
static final String	ATLAS_GLOSSARY_NAME_CONFIGURATION_PROPERTY	The configuration property name used to supply the name of the Atlas Glossary to copy into the open metadata ecosystem.
static final String	CATALOG_TARGET_NAME	Symbolic name for the catalog target (Apache Atlas).
static final String	CLASSIFICATION_REFERENCE_SET_BOTH_WAYS_CONFIGURATION_PROPERTY_VALUE	Static literal for setting classificationReferenceSetPolicy to "BOTH_WAYS".
static final String	CLASSIFICATION_REFERENCE_SET_FROM_ATLAS_CONFIGURATION_PROPERTY_VALUE	Static literal for setting classificationReferenceSetPolicy to "FROM_ATLAS".
static final String	CLASSIFICATION_REFERENCE_SET_NAME_CONFIGURATION_PROPERTY	The classificationReferenceSetName configuration property is used to supply the qualified name of a valid values set that lists the names and descriptions of classifications to exchange with Apache Atlas.
static final String	CLASSIFICATION_REFERENCE_SET_POLICY_CONFIGURATION_PROPERTY	The classificationReferenceSetPolicy configuration property determines the direction of the exchange of classifications from Apache Atlas and the classification reference set.
static final String	CLASSIFICATION_REFERENCE_SET_TO_ATLAS_CONFIGURATION_PROPERTY_VALUE	Static literal for setting classificationReferenceSetPolicy to "TO_ATLAS".
static final String	EGERIA_GLOSSARY_QUALIFIED_NAME_CONFIGURATION_PROPERTY	The configuration property name used to supply the qualified name of an Egeria glossary to synchronize with Apache Atlas.
static final String	IGNORE_ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE	Static literal for setting ignoreOpenMetadataTypes to "*" which means the same as if it is not set.
static final String	IGNORE_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY	If openMetadataTypesPolicy is set to ALL, it is possible to skip the definition of particular open metadata types in Apache Atlas by listing these types in the ignoreOpenMetadataTypes property.
static final String	INFORMAL_TAGS_MAP_TO_CLASSIFICATIONS_CONFIGURATION_PROPERTY_VALUE	Static literal for setting informalTagsMappingPolicy to "CLASSIFICATIONS".
static final String	INFORMAL_TAGS_MAP_TO_ENTITIES_CONFIGURATION_PROPERTY_VALUE	Static literal for setting informalTagsMappingPolicy to "ENTITIES".
static final String	INFORMAL_TAGS_MAP_TO_LABELS_CONFIGURATION_PROPERTY_VALUE	Static literal for setting informalTagsMappingPolicy to "LABELS".
static final String	INFORMAL_TAGS_MAPPING_POLICY_CONFIGURATION_PROPERTY	The name of the configuration property to control how this connector maps open metadata informal tags to Apache Atlas.
static final String	INFORMAL_TAGS_NO_MAPPING_CONFIGURATION_PROPERTY_VALUE	Static literal for setting informalTagsMappingPolicy to "NONE".
static final String	NONE_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE	Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "NONE".
static final String	ON_DEMAND_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE	Static literal for setting openMetadataTypesPolicy to "ON_DEMAND".
static final String	OPEN_METADATA_TYPES_POLICY_CONFIGURATION_PROPERTY	This connector needs to add open metadata types to Apache Atlas to store particular types of open metadata elements that are beyond the types defined by Apache Atlas.
static final String	RELATED_CLASSIFICATION_IGNORE_LIST_CONFIGURATION_PROPERTY	The relatedClassificationIgnoreList configuration property is used to list the classification names that should not be copied from the open metadata ecosystem to Apache Atlas if relatedClassificationPolicy==SELECTED.
static final String	RELATED_CLASSIFICATION_POLICY_CONFIGURATION_PROPERTY	The relatedClassificationPolicy configuration property determines if a classification added to an open metadata entity that is synchronized in Apache Atlas should be added to the Apache Atlas entity as business metadata.
static final String	RELATED_ENTITY_POLICY_CONFIGURATION_PROPERTY	The relatedEntityPolicy configuration property determines if an entity related to an open metadata entity that is synchronized in Apache Atlas should be added to the Apache Atlas entity as a related entity.
static final String	RELATED_RELATIONSHIP_IGNORE_LIST_CONFIGURATION_PROPERTY	The relatedRelationshipIgnoreList configuration property used to list the relationship type names that should not be copied from the open metadata ecosystem to Apache Atlas if relatedEntityPolicy==SELECTED.
static final String	SELECTED_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE	Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "SELECTED".

Fields inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider

catalogTargets, supportedAssetTypeName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

auditLog, connectorInterfaces, connectorTypeBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

supportedConfigurationProperties, supportedTemplateTypes

Constructor Summary

Constructors

Constructor	Description
ApacheAtlasIntegrationProvider()	Constructor used to initialize the ConnectorProvider with the Java class name of the specific store implementation.

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider

getCatalogTargets, getRefreshTimeInterval, getUsesBlockingCalls, setRefreshTimeInterval, setUsesBlockingCalls

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

equals, getConnector, getConnector, getConnectorClassName, getConnectorComponentDescription, getConnectorType, getConnectorTypeProperties, getNewConnectorGUID, hashCode, setAuditLog, setConnectorClassName, setConnectorComponentDescription, setConnectorTypeProperties, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

getSupportedConfigurationProperties, getSupportedTemplateTypes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OPEN_METADATA_TYPES_POLICY_CONFIGURATION_PROPERTY

public static final String OPEN_METADATA_TYPES_POLICY_CONFIGURATION_PROPERTY

This connector needs to add open metadata types to Apache Atlas to store particular types of open metadata elements that are beyond the types defined by Apache Atlas. There are three new types that are always needed: OpenMetadataCorrelation, OpenMetadataCorrelationLink and OpenMetadataGlossaryCorrelationLink. In addition, this connector creates Apache Atlas types as it needs. The type name from open metadata is prefixed with "OpenMetadata" when it is added to Apache Atlas. For example, the LicenseType entityDef from open metadata becomes "OpenMetadataLicenseType in Apache Atlas. This makes it easy to identify the types from the open metadata ecosystem. The mapping between open metadata types and Apache Atlas is as follows:

• EntityDefs from open metadata are mapped to Apache Atlas EntityDefs.
• RelationshipDefs from open metadata are mapped to Apache Atlas RelationshipDefs
• ClassificationDefs from open metadata are mapped to Apache Atlas BusinessMetadataDefs. This is because classifications in Apache Atlas are less formally defined in Apache Atlas.
• EnumDefs from open metadata are mapped to Apache Atlas EnumDefs.
• Apache Atlas does not support explicit PrimitiveDefs and CollectionDefs. However, its implementation of these attr.

This openMetadataTypesPolicy configuration property can change the default approach that only creates new types in Apache Atlas when needed, to creating all known open metadata types. This is useful when the Apache Atlas service is being used in an open metadata ecosystem and its users want to use the open metadata types directly.

Set the openMetadataTypesPolicy=ALL and this connector will add all active open metadata types to Apache Atlas. If it is not set, or set to anything else, such as ON_DEMAND, then it only adds the types it needs.

See Also:

• Constant Field Values

ON_DEMAND_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

public static final String ON_DEMAND_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

Static literal for setting openMetadataTypesPolicy to "ON_DEMAND".

See Also:

• Constant Field Values

ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

public static final String ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

Static literal for setting openMetadataTypesPolicy to "ALL".

See Also:

• Constant Field Values

IGNORE_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY

public static final String IGNORE_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY

If openMetadataTypesPolicy is set to ALL, it is possible to skip the definition of particular open metadata types in Apache Atlas by listing these types in the ignoreOpenMetadataTypes property. For example, to avoid adding the types for the Anchors and LatestChange classifications, set ignoreOpenMetadataTypes to "[Anchors, LatestChange]".

See Also:

• Constant Field Values

IGNORE_ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

public static final String IGNORE_ALL_OPEN_METADATA_TYPES_CONFIGURATION_PROPERTY_VALUE

Static literal for setting ignoreOpenMetadataTypes to "*" which means the same as if it is not set.

See Also:

• Constant Field Values

EGERIA_GLOSSARY_QUALIFIED_NAME_CONFIGURATION_PROPERTY

public static final String EGERIA_GLOSSARY_QUALIFIED_NAME_CONFIGURATION_PROPERTY

The configuration property name used to supply the qualified name of an Egeria glossary to synchronize with Apache Atlas. If this value is null, all Egeria originated glossaries are copied to Apache Atlas.

See Also:

• Constant Field Values

ATLAS_GLOSSARY_NAME_CONFIGURATION_PROPERTY

public static final String ATLAS_GLOSSARY_NAME_CONFIGURATION_PROPERTY

The configuration property name used to supply the name of the Atlas Glossary to copy into the open metadata ecosystem. If this value is null, all Apache Atlas originated glossaries are copied into the open metadata ecosystem.

See Also:

• Constant Field Values

INFORMAL_TAGS_MAPPING_POLICY_CONFIGURATION_PROPERTY

public static final String INFORMAL_TAGS_MAPPING_POLICY_CONFIGURATION_PROPERTY

The name of the configuration property to control how this connector maps open metadata informal tags to Apache Atlas. If this value is null, or set to an invalid value, informal tags are added as related entities. Otherwise, it can be set to LABELS (mapping informal tags to labels on the related entity), CLASSIFICATIONS (mapping informal tags to classifications) or ENTITIES (mapping informal tags to related entities).

To turn off mapping of informal tags, specify ENTITIES in this property and list AttachedInformalTag in the IgnoreRelationshipList.

See Also:

• Constant Field Values

INFORMAL_TAGS_MAP_TO_LABELS_CONFIGURATION_PROPERTY_VALUE

public static final String INFORMAL_TAGS_MAP_TO_LABELS_CONFIGURATION_PROPERTY_VALUE

Static literal for setting informalTagsMappingPolicy to "LABELS".

See Also:

• Constant Field Values

INFORMAL_TAGS_MAP_TO_CLASSIFICATIONS_CONFIGURATION_PROPERTY_VALUE

public static final String INFORMAL_TAGS_MAP_TO_CLASSIFICATIONS_CONFIGURATION_PROPERTY_VALUE

Static literal for setting informalTagsMappingPolicy to "CLASSIFICATIONS".

See Also:

• Constant Field Values

INFORMAL_TAGS_MAP_TO_ENTITIES_CONFIGURATION_PROPERTY_VALUE

public static final String INFORMAL_TAGS_MAP_TO_ENTITIES_CONFIGURATION_PROPERTY_VALUE

Static literal for setting informalTagsMappingPolicy to "ENTITIES".

See Also:

• Constant Field Values

INFORMAL_TAGS_NO_MAPPING_CONFIGURATION_PROPERTY_VALUE

public static final String INFORMAL_TAGS_NO_MAPPING_CONFIGURATION_PROPERTY_VALUE

Static literal for setting informalTagsMappingPolicy to "NONE".

See Also:

• Constant Field Values

CLASSIFICATION_REFERENCE_SET_NAME_CONFIGURATION_PROPERTY

public static final String CLASSIFICATION_REFERENCE_SET_NAME_CONFIGURATION_PROPERTY

The classificationReferenceSetName configuration property is used to supply the qualified name of a valid values set that lists the names and descriptions of classifications to exchange with Apache Atlas. This is used to establish a standard set of classifications in an Apache Atlas server - or across multiple Apache Atlas servers.

See Also:

• Constant Field Values

CLASSIFICATION_REFERENCE_SET_POLICY_CONFIGURATION_PROPERTY

public static final String CLASSIFICATION_REFERENCE_SET_POLICY_CONFIGURATION_PROPERTY

The classificationReferenceSetPolicy configuration property determines the direction of the exchange of classifications from Apache Atlas and the classification reference set.

See Also:

• Constant Field Values

CLASSIFICATION_REFERENCE_SET_TO_ATLAS_CONFIGURATION_PROPERTY_VALUE

public static final String CLASSIFICATION_REFERENCE_SET_TO_ATLAS_CONFIGURATION_PROPERTY_VALUE

Static literal for setting classificationReferenceSetPolicy to "TO_ATLAS".

See Also:

• Constant Field Values

CLASSIFICATION_REFERENCE_SET_FROM_ATLAS_CONFIGURATION_PROPERTY_VALUE

public static final String CLASSIFICATION_REFERENCE_SET_FROM_ATLAS_CONFIGURATION_PROPERTY_VALUE

Static literal for setting classificationReferenceSetPolicy to "FROM_ATLAS".

See Also:

• Constant Field Values

CLASSIFICATION_REFERENCE_SET_BOTH_WAYS_CONFIGURATION_PROPERTY_VALUE

public static final String CLASSIFICATION_REFERENCE_SET_BOTH_WAYS_CONFIGURATION_PROPERTY_VALUE

Static literal for setting classificationReferenceSetPolicy to "BOTH_WAYS".

See Also:

• Constant Field Values

RELATED_CLASSIFICATION_POLICY_CONFIGURATION_PROPERTY

public static final String RELATED_CLASSIFICATION_POLICY_CONFIGURATION_PROPERTY

The relatedClassificationPolicy configuration property determines if a classification added to an open metadata entity that is synchronized in Apache Atlas should be added to the Apache Atlas entity as business metadata.

See Also:

• Constant Field Values

RELATED_ENTITY_POLICY_CONFIGURATION_PROPERTY

public static final String RELATED_ENTITY_POLICY_CONFIGURATION_PROPERTY

The relatedEntityPolicy configuration property determines if an entity related to an open metadata entity that is synchronized in Apache Atlas should be added to the Apache Atlas entity as a related entity.

See Also:

• Constant Field Values

ALL_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

public static final String ALL_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "ALL".

See Also:

• Constant Field Values

SELECTED_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

public static final String SELECTED_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "SELECTED".

See Also:

• Constant Field Values

NONE_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

public static final String NONE_RELATED_ELEMENT_CONFIGURATION_PROPERTY_VALUE

Static literal for setting relatedClassificationPolicy or relatedEntityPolicy to "NONE".

See Also:

• Constant Field Values

RELATED_CLASSIFICATION_IGNORE_LIST_CONFIGURATION_PROPERTY

public static final String RELATED_CLASSIFICATION_IGNORE_LIST_CONFIGURATION_PROPERTY

The relatedClassificationIgnoreList configuration property is used to list the classification names that should not be copied from the open metadata ecosystem to Apache Atlas if relatedClassificationPolicy==SELECTED. An example could be "[Anchors, LatestChange]" to ignore the Anchors and LatestChange classifications.

See Also:

• Constant Field Values

RELATED_RELATIONSHIP_IGNORE_LIST_CONFIGURATION_PROPERTY

public static final String RELATED_RELATIONSHIP_IGNORE_LIST_CONFIGURATION_PROPERTY

The relatedRelationshipIgnoreList configuration property used to list the relationship type names that should not be copied from the open metadata ecosystem to Apache Atlas if relatedEntityPolicy==SELECTED. An example could be "[License, Certification]" to ignore the License and Certification relationships.

See Also:

• Constant Field Values

CATALOG_TARGET_NAME

public static final String CATALOG_TARGET_NAME

Symbolic name for the catalog target (Apache Atlas).

See Also:

• Constant Field Values

Constructor Details

ApacheAtlasIntegrationProvider

public ApacheAtlasIntegrationProvider()

Constructor used to initialize the ConnectorProvider with the Java class name of the specific store implementation.