Package org.odpi.openmetadata.adapters.connectors.unitycatalog.sync

Class OSSUnityCatalogServerSyncCatalog

java.lang.Object

org.odpi.openmetadata.frameworks.auditlog.AuditLoggingBase

org.odpi.openmetadata.adapters.connectors.unitycatalog.sync.OSSUnityCatalogInsideCatalogSyncBase

org.odpi.openmetadata.adapters.connectors.unitycatalog.sync.OSSUnityCatalogServerSyncCatalog

public class OSSUnityCatalogServerSyncCatalog
extends OSSUnityCatalogInsideCatalogSyncBase

Provides the specialist methods for working with a Unity Catalog (UC) server. It synchronizes the server's catalogs and sets them up as catalog targets in the friendship connector that configures the contents of the catalog.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.unitycatalog.sync.OSSUnityCatalogInsideCatalogSyncBase

assetClient, catalogGUID, catalogTargetName, catalogTypeName, configurationProperties, connectorName, context, deployedImplementationType, entityTypeName, excludeNames, externalIdClient, includeNames, metadataCollectionGUID, metadataCollectionQualifiedName, openMetadataStore, propertyFacetClient, propertyHelper, serverGUID, targetPermittedSynchronization, templateGUID, templates, ucConnector, ucFullNameToEgeriaGUID, ucServerEndpoint

Fields inherited from class org.odpi.openmetadata.frameworks.auditlog.AuditLoggingBase

auditLog

Constructor Summary

Constructors

Constructor

Description

OSSUnityCatalogServerSyncCatalog(String connectorName, IntegrationContext context, String catalogTargetName, String ucServerGUID, String dataAccessManagerGUID, String metadataCollectionGUID, String metadataCollectionName, String friendshipConnectorGUID, PermittedSynchronization targetPermittedSynchronization, OSSUnityCatalogResourceConnector ucConnector, String ucServerEndpoint, Map<String,String> templates, Map<String,Object> configurationProperties, List<String> excludeCatalogs, List<String> includeCatalogs, AuditLog auditLog)

Set up the catalog synchronizer.

Method Summary

Modifier and Type	Method	Description
protected IntegrationIterator	refreshEgeria(String parentGUID, String parentRelationshipTypeName, RelationshipBeanProperties relationshipProperties)	Review all the catalogs stored in Egeria.
protected void	refreshUnityCatalog(String parentGUID, String parentRelationshipTypeName, RelationshipBeanProperties relationshipProperties, IntegrationIterator iterator)	Review all the catalogs stored in UC.
protected void	updateElementInEgeria(CatalogInfo catalogInfo, MemberElement memberElement)	Update an element in open metadata.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.unitycatalog.sync.OSSUnityCatalogInsideCatalogSyncBase

addExternalIdentifier, addPropertyFacet, buildAnchorScopeGUIDs, deleteElementInEgeria, findExistingSchemaAttribute, findExistingSchemaType, getArrayConfigurationProperty, getCleanStorageLocation, getDateFromLong, getExternalIdLinkProperties, getExternalIdProperties, getParentGUIDFromMember, getQualifiedName, getShortName, getUCCatalogFromMember, getUCCommentFomMember, getUCNameFromMember, getUCPropertiesFromMember, getUCSchemaFromMember, getUCStorageLocationFromMember, noMismatchInExternalIdentifier, shouldBeCatalogued, throwBadBeanClass, throwMissingPropertyValue

Methods inherited from class org.odpi.openmetadata.frameworks.auditlog.AuditLoggingBase

logExceptionRecord, logExceptionRecord, logRecord, logRecord

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OSSUnityCatalogServerSyncCatalog

public OSSUnityCatalogServerSyncCatalog(String connectorName,
 IntegrationContext context,
 String catalogTargetName,
 String ucServerGUID,
 String dataAccessManagerGUID,
 String metadataCollectionGUID,
 String metadataCollectionName,
 String friendshipConnectorGUID,
 PermittedSynchronization targetPermittedSynchronization,
 OSSUnityCatalogResourceConnector ucConnector,
 String ucServerEndpoint,
 Map<String,String> templates,
 Map<String,Object> configurationProperties,
 List<String> excludeCatalogs,
 List<String> includeCatalogs,
 AuditLog auditLog)
                                 throws UserNotAuthorizedException,
InvalidParameterException

Set up the catalog synchronizer.

Parameters:

connectorName - name of this connector

context - context for the connector

catalogTargetName - the catalog target name

ucServerGUID - unique identifier of the UC Server's asset

dataAccessManagerGUID - the data access manager software capability for this element

metadataCollectionGUID - the metadata collection to use for all open metadata elements relating to this server.

metadataCollectionName - the metadata collection to use for all open metadata elements relating to this server.

friendshipConnectorGUID - optional unique name of inside catalog integration connector

targetPermittedSynchronization - the policy that controls the direction of metadata exchange

ucConnector - connector for accessing UC

ucServerEndpoint - the server endpoint used to constructing the qualified names

templates - templates supplied through the catalog target

configurationProperties - configuration properties supplied through the catalog target

excludeCatalogs - list of catalogs to ignore (and include all others)

includeCatalogs - list of catalogs to include (and ignore all others) - overrides excludeCatalogs

auditLog - logging destination

Throws:

UserNotAuthorizedException - connector disconnected

InvalidParameterException - missing template

Method Details

refreshEgeria

protected IntegrationIterator refreshEgeria(String parentGUID,
 String parentRelationshipTypeName,
 RelationshipBeanProperties relationshipProperties)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectorCheckedException

Review all the catalogs stored in Egeria.

Specified by:

refreshEgeria in class OSSUnityCatalogInsideCatalogSyncBase

Parameters:

parentGUID - unique identifier of the parent

parentRelationshipTypeName - relationship type between parent and elements to iterate through

relationshipProperties - optional properties for the relationship

Returns:

iterator

Throws:

InvalidParameterException - parameter error

PropertyServerException - repository error

UserNotAuthorizedException - security error

ConnectorCheckedException - logic error in properties

refreshUnityCatalog

protected void refreshUnityCatalog(String parentGUID,
 String parentRelationshipTypeName,
 RelationshipBeanProperties relationshipProperties,
 IntegrationIterator iterator)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectorCheckedException

Review all the catalogs stored in UC.

Specified by:

refreshUnityCatalog in class OSSUnityCatalogInsideCatalogSyncBase

Parameters:

parentGUID - unique identifier of the parent

parentRelationshipTypeName - relationship type between parent and elements to iterate through

relationshipProperties - optional properties for the relationship

iterator - Metadata collection iterator

Throws:

InvalidParameterException - parameter error

PropertyServerException - repository error

UserNotAuthorizedException - security error

ConnectorCheckedException - logic error in properties

updateElementInEgeria

protected void updateElementInEgeria(CatalogInfo catalogInfo,
 MemberElement memberElement)
                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update an element in open metadata.

Parameters:

catalogInfo - object from UC

memberElement - existing element in egeria

Throws:

InvalidParameterException - parameter error

PropertyServerException - repository error

UserNotAuthorizedException - authorization error