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

Class JDBCIntegrationCatalogTargetProcessor

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.connectors.CatalogTargetProperties

org.odpi.openmetadata.frameworks.opengovernance.properties.CatalogTarget

org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

org.odpi.openmetadata.frameworks.integration.connectors.CatalogTargetProcessorBase

org.odpi.openmetadata.adapters.connectors.integration.jdbc.JDBCIntegrationCatalogTargetProcessor

public class JDBCIntegrationCatalogTargetProcessor
extends CatalogTargetProcessorBase

JDBCIntegrationCatalogTargetProcessor supports the cataloguing of database schema via the JDBC interface for a single database linked as a catalog target.

Field Summary

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

auditLog, connectorName, metadataCollectionGUID, metadataCollectionName, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

connectorToTarget, integrationContext

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties

typeName

Constructor Summary

Constructors

Constructor	Description
JDBCIntegrationCatalogTargetProcessor(CatalogTarget template, CatalogTargetContext catalogTargetContext, Connector connectorToTarget, String connectorName, AuditLog auditLog)	Primary constructor

Method Summary

Modifier and Type	Method	Description
void	close(Connection connection)	Work has completed, close the database connection.
void	refresh()	Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.
void	refreshDatabase(JDBCResourceConnector jdbcResourceConnector, String databaseName, OpenMetadataRootElement databaseElement, Map<String,Object> configurationProperties)	Refresh a single database: connect to it, resolve (or create) its database asset, and then hand off the schema/table/view/column cataloguing to a RelationalDatabaseCataloguer.
void	refreshDatabaseSchema(JDBCResourceConnector jdbcResourceConnector, String schemaName, OpenMetadataRootElement schemaElement, Map<String,Object> configurationProperties)	Refresh a single database schema: connect through the schema asset's own connection and catalog the tables, views and columns of that one schema.

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

disconnect, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getCatalogTargetElement, getDateConfigurationProperty, getHostIdentifier, getIntConfigurationProperty, getLongConfigurationProperty, getPortNumber, getStringConfigurationProperty, getSuppliedPlaceholderProperties, setUpMetadataSource, setUpSoftwareCapability, start, throwBadBeanClass, throwMissingConnectionInfo, throwMissingPropertyValue, throwWrongTypeOfCatalogTarget, throwWrongTypeOfResourceConnector

Methods inherited from class org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

clearRetrievedCatalogTargetElement, equals, getCatalogTargetElement, getCatalogTargetElementHeader, getCatalogTargetElementRetrievalException, getConnectorToTarget, getIntegrationContext, getNetworkAddress, hashCode, isStarted, toString

Methods inherited from class org.odpi.openmetadata.frameworks.opengovernance.properties.CatalogTarget

getRelationshipGUID, getRelationshipVersions, setCatalogTargetElement, setRelationshipGUID, setRelationshipVersions

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.connectors.CatalogTargetProperties

getCatalogTargetName, getConfigurationProperties, getConnectionName, getDeleteMethod, getMetadataCollectionQualifiedName, getMetadataSourceQualifiedName, getPermittedSynchronization, getTemplates, setCatalogTargetName, setConfigurationProperties, setConnectionName, setDeleteMethod, setMetadataCollectionQualifiedName, setMetadataSourceQualifiedName, setPermittedSynchronization, setTemplates

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties

getExtendedProperties, getTypeName, setExtendedProperties, setTypeName

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

getEffectiveFrom, getEffectiveTo, setEffectiveFrom, setEffectiveTo

Methods inherited from class java.lang.Object

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

Constructor Details

JDBCIntegrationCatalogTargetProcessor

public JDBCIntegrationCatalogTargetProcessor(CatalogTarget template,
 CatalogTargetContext catalogTargetContext,
 Connector connectorToTarget,
 String connectorName,
 AuditLog auditLog)

Primary constructor

Parameters:

template - object to copy

catalogTargetContext - specialized context for this catalog target

connectorToTarget - connector to access the target resource

connectorName - name of this integration connector

auditLog - logging destination

Method Details

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.

Overrides:

refresh in class CatalogTargetProcessorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

refreshDatabaseSchema

public void refreshDatabaseSchema(JDBCResourceConnector jdbcResourceConnector,
 String schemaName,
 OpenMetadataRootElement schemaElement,
 Map<String,Object> configurationProperties)
                           throws ConnectorCheckedException

Refresh a single database schema: connect through the schema asset's own connection and catalog the tables, views and columns of that one schema.

This is what the catalog-<vendor>-schema governance action processes in the database vendors' content packs set up. The schema asset already exists - it is the catalog target - so nothing here creates or deletes it, and no database asset is created above it.

Parameters:

jdbcResourceConnector - connector to the database

schemaName - qualified name of the schema asset, for the audit log

schemaElement - the schema asset

configurationProperties - configuration properties from the catalog target

Throws:

ConnectorCheckedException

refreshDatabase

public void refreshDatabase(JDBCResourceConnector jdbcResourceConnector,
 String databaseName,
 OpenMetadataRootElement databaseElement,
 Map<String,Object> configurationProperties)
                     throws ConnectorCheckedException

Refresh a single database: connect to it, resolve (or create) its database asset, and then hand off the schema/table/view/column cataloguing to a RelationalDatabaseCataloguer.

Parameters:

jdbcResourceConnector - connector to the database

databaseName - qualified name of the database

databaseElement - the already-known database asset, or null if this catalog target is a database server address

configurationProperties - configuration properties for the database

Throws:

ConnectorCheckedException

close

public void close(Connection connection)

Work has completed, close the database connection.

Parameters:

connection - database connection