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

Class JDBCIntegrationConnector

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.integration.jdbc.JDBCIntegrationConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, CatalogTargetIntegrator, IntegrationConnector

public class JDBCIntegrationConnector
extends IntegrationConnectorBase
implements CatalogTargetIntegrator

JDBCIntegrationConnector supports the cataloguing of database schema via the JDBC interface.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

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

auditLog, catalogTargetsManager, connectorName, integrationContext

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
JDBCIntegrationConnector()

Method Summary

Modifier and Type	Method	Description
void	close(Connection connection)	Work has completed, close the database connection.
void	integrateCatalogTarget(RequestedCatalogTarget requestedCatalogTarget)	Perform the required integration logic for the assigned catalog target.
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.

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

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

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.integration.connectors.CatalogTargetIntegrator

getNewRequestedCatalogTargetSkeleton

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

initializeEmbeddedConnectors

Constructor Details

JDBCIntegrationConnector

public JDBCIntegrationConnector()

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.

Specified by:

refresh in interface IntegrationConnector

Throws:

ConnectorCheckedException - there is a problem within the connector.

integrateCatalogTarget

public void integrateCatalogTarget(RequestedCatalogTarget requestedCatalogTarget)
                            throws ConnectorCheckedException

Perform the required integration logic for the assigned catalog target.

Specified by:

integrateCatalogTarget in interface CatalogTargetIntegrator

Parameters:

requestedCatalogTarget - the catalog target

Throws:

ConnectorCheckedException - there is an unrecoverable error and the connector should stop processing.

refreshDatabase

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

Refresh a single database.

Parameters:

jdbcResourceConnector - connector to the database

databaseName - qualified name of the database

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