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

Class ApacheHiveIntegrationModule

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

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

All Implemented Interfaces:

RegisteredIntegrationModule

public class ApacheHiveIntegrationModule
extends DatabaseIntegrationModuleBase

ApacheHiveIntegrationModule manages the cataloguing of Apache Hive entities stored in Apache Atlas into the open metadata ecosystem.

Field Summary

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

egeriaDatabaseColumnTypeName, egeriaDatabaseColumnTypeTypeName, egeriaDatabaseTableTypeName, egeriaDatabaseTableTypeTypeName, egeriaDatabaseTypeName, egeriaRootDatabaseSchemaTypeTypeName

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
ApacheHiveIntegrationModule(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
protected void	augmentAtlasDatabaseInEgeria(AtlasEntityWithExtInfo atlasDatabaseEntity, String egeriaDatabaseGUID)	Allow a subclass to attach additional information to the database.
protected SchemaAttributeProperties	getEgeriaDatabaseColumnProperties(AtlasEntity atlasEntity, String egeriaSchemaAttributeTypeName, String egeriaSchemaTypeTypeName)	Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.
protected DataAssetProperties	getEgeriaDatabaseProperties(AtlasEntity atlasEntity, String egeriaTypeName)	Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.
protected SchemaAttributeProperties	getEgeriaDatabaseTableProperties(AtlasEntity atlasEntity, String egeriaSchemaAttributeTypeName, String egeriaSchemaTypeTypeName)	Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.apacheatlas.integration.modules.DatabaseIntegrationModuleBase

augmentAtlasDatabaseColumnInEgeria, augmentAtlasDatabaseTableInEgeria, createAtlasDatabaseColumnInEgeria, createAtlasDatabaseInEgeria, createAtlasDatabaseTableInEgeria, getEgeriaDatabaseSchemaType, processEvent, refresh, updateAtlasDatabaseColumnInEgeria, updateAtlasDatabaseInEgeria, updateAtlasDatabaseTableInEgeria

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

ApacheHiveIntegrationModule

public ApacheHiveIntegrationModule(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

getEgeriaDatabaseProperties

protected DataAssetProperties getEgeriaDatabaseProperties(AtlasEntity atlasEntity,
 String egeriaTypeName)

Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.

Specified by:

getEgeriaDatabaseProperties in class DatabaseIntegrationModuleBase

Parameters:

atlasEntity - retrieve entity from Apache Atlas

egeriaTypeName - name of the type used in the open metadata ecosystem

Returns:

properties to pass to Egeria

augmentAtlasDatabaseInEgeria

protected void augmentAtlasDatabaseInEgeria(AtlasEntityWithExtInfo atlasDatabaseEntity,
 String egeriaDatabaseGUID)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Allow a subclass to attach additional information to the database.

Overrides:

augmentAtlasDatabaseInEgeria in class DatabaseIntegrationModuleBase

Parameters:

atlasDatabaseEntity - entity retrieved from Apache Atlas

egeriaDatabaseGUID - unique identifier of the equivalent entity in the open metadata ecosystem

Throws:

InvalidParameterException - invalid parameter - probably a logic error

UserNotAuthorizedException - security problem

PropertyServerException - unable to communicate with Egeria

getEgeriaDatabaseTableProperties

protected SchemaAttributeProperties getEgeriaDatabaseTableProperties(AtlasEntity atlasEntity,
 String egeriaSchemaAttributeTypeName,
 String egeriaSchemaTypeTypeName)

Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.

Specified by:

getEgeriaDatabaseTableProperties in class DatabaseIntegrationModuleBase

Parameters:

atlasEntity - retrieve entity from Apache Atlas

egeriaSchemaAttributeTypeName - name of the type used in the open metadata ecosystem

egeriaSchemaTypeTypeName - name of the type used in the open metadata ecosystem

Returns:

properties to pass to Egeria

getEgeriaDatabaseColumnProperties

protected SchemaAttributeProperties getEgeriaDatabaseColumnProperties(AtlasEntity atlasEntity,
 String egeriaSchemaAttributeTypeName,
 String egeriaSchemaTypeTypeName)

Map the properties from the entity retrieved from Apache Atlas to the Egeria properties for the open metadata entity.

Specified by:

getEgeriaDatabaseColumnProperties in class DatabaseIntegrationModuleBase

Parameters:

atlasEntity - retrieve entity from Apache Atlas

egeriaSchemaAttributeTypeName - name of the type used in the open metadata ecosystem

egeriaSchemaTypeTypeName - name of the type used in the open metadata ecosystem

Returns:

properties to pass to Egeria