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

Class ApacheAtlasIntegrationConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

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

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, IntegrationConnector, OpenMetadataEventListener

public class ApacheAtlasIntegrationConnector
extends IntegrationConnectorBase
implements OpenMetadataEventListener

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

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
static final String	classificationReferenceSetPolicyDefaultValue
static final String[]	classificationReferenceSetPolicyValidValues
static final String	GLOSSARY_CORRELATION_LINK_TYPE_NAME	The type name for the relationship that links the correlation entity to its associated Apache Atlas glossary member.
static final String	informalTagsMappingDefaultValue
static final String[]	informalTagsMappingValidValues
static final String	OPEN_METADATA_CORRELATION_LINK_TYPE_NAME	The type name for the relationship that links the correlation entity to its associated Apache Atlas entity.
static final String	OPEN_METADATA_CORRELATION_TYPE_NAME	The type name for the entity that holds the correlation values for corresponding open metadata entity.
static final String	openMetadataTypesPolicyDefaultValue
static final String[]	openMetadataTypesPolicyValidValues
static final String	relatedElementPolicyDefaultValue
static final String[]	relatedElementPolicyValidValues

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

auditLog, catalogTargetsManager, connectorName, integrationContext, propertyHelper

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
ApacheAtlasIntegrationConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Shutdown Apache Atlas monitoring
void	processEvent(OpenMetadataOutTopicEvent 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.
void	start()	Indicates that the connector is completely configured and can begin processing.

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

engage, getConnectorComponentDescription, getNetworkAddress, passEventToCatalogTargets, refreshCatalogTargets, registerCatalogTargetChangeListener, setAuditLog, setConnectorName, setContext

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

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

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

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Field Details

OPEN_METADATA_CORRELATION_TYPE_NAME

public static final String OPEN_METADATA_CORRELATION_TYPE_NAME

The type name for the entity that holds the correlation values for corresponding open metadata entity.

See Also:

• Constant Field Values

OPEN_METADATA_CORRELATION_LINK_TYPE_NAME

public static final String OPEN_METADATA_CORRELATION_LINK_TYPE_NAME

The type name for the relationship that links the correlation entity to its associated Apache Atlas entity.

See Also:

• Constant Field Values

GLOSSARY_CORRELATION_LINK_TYPE_NAME

public static final String GLOSSARY_CORRELATION_LINK_TYPE_NAME

The type name for the relationship that links the correlation entity to its associated Apache Atlas glossary member.

See Also:

• Constant Field Values

openMetadataTypesPolicyValidValues

public static final String[] openMetadataTypesPolicyValidValues

openMetadataTypesPolicyDefaultValue

public static final String openMetadataTypesPolicyDefaultValue

See Also:

• Constant Field Values

informalTagsMappingValidValues

public static final String[] informalTagsMappingValidValues

informalTagsMappingDefaultValue

public static final String informalTagsMappingDefaultValue

See Also:

• Constant Field Values

classificationReferenceSetPolicyValidValues

public static final String[] classificationReferenceSetPolicyValidValues

classificationReferenceSetPolicyDefaultValue

public static final String classificationReferenceSetPolicyDefaultValue

See Also:

• Constant Field Values

relatedElementPolicyValidValues

public static final String[] relatedElementPolicyValidValues

relatedElementPolicyDefaultValue

public static final String relatedElementPolicyDefaultValue

See Also:

• Constant Field Values

Constructor Details

ApacheAtlasIntegrationConnector

public ApacheAtlasIntegrationConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the connector is completely configured and can begin processing. This call can be used to register with non-blocking services.

Specified by:

start in interface IntegrationConnector

Overrides:

start in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

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.

Specified by:

refresh in interface IntegrationConnector

Throws:

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

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

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

Specified by:

processEvent in interface OpenMetadataEventListener

Parameters:

event - event object

disconnect

public void disconnect()
                throws ConnectorCheckedException

Shutdown Apache Atlas monitoring

Specified by:

disconnect in interface IntegrationConnector

Overrides:

disconnect in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - something failed in the super class