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

Class JDBCResourceConnector

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.adapters.connectors.resource.jdbc.JDBCResourceConnector
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
public class JDBCResourceConnector extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
JDBCResourceConnector provides basic implementation of DataSource interface in order to get a Connection to target database. This is done via a static inner class, since DataSource.getConnection() clashes with ConnectorBase.getConnection().

The DataSource can be used directly. There are also selected methods to issue common SQL statements to the database.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JDBCResourceConnector()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disconnect()
    Free up any resources held since the connector is no longer needed.
    org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
    getConnectorComponentDescription()
    Return the component description that is used by this connector in the audit log.
    String
    getDatabaseName()
    Return the name of the database.
    DataSource
    getDataSource()
    Return the DataSource implementation for this database.
    Map<String,JDBCDataValue>
    getLatestRow(Connection jdbcConnection, String tableName, String identifierColumnName, String identifierColumnValue, String timestampColumnName, Map<String,Integer> columnNameTypeMap)
    Retrieve the row with the requested identifier and with the latest timestamp.
    void
    initializeEmbeddedConnectors(List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors)
    Set up the list of connectors that this virtual connector will use to support its interface.
    void
    insertRowIntoTable(Connection jdbcConnection, String tableName, Map<String,JDBCDataValue> columnNameValueMap)
    Prepare an INSERT SQL statement with all the columns for the new row filled out.
    void
    setAuditLog(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Receive an audit log object that can be used to record audit log messages.
    void
    start()
    Indicates that the connector is completely configured and can begin processing.

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

    equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, toString

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

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JDBCResourceConnector

      public JDBCResourceConnector()

  • Method Details

    • setAuditLog

      public void setAuditLog(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.
      Specified by:
      setAuditLog in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Parameters:
      auditLog - audit log object

    • getConnectorComponentDescription

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDescription getConnectorComponentDescription()
      Return the component description that is used by this connector in the audit log.
      Specified by:
      getConnectorComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Returns:
      id, name, description, wiki page URL.

    • initializeEmbeddedConnectors

      public void initializeEmbeddedConnectors(List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors)
      Set up the list of connectors that this virtual connector will use to support its interface. The connectors are initialized waiting to start. When start() is called on the virtual connector, it needs to pass start() to each of the embedded connectors. Similarly for disconnect().
      Specified by:
      initializeEmbeddedConnectors in interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
      Parameters:
      embeddedConnectors - list of connectors

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the connector is completely configured and can begin processing.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.

    • getDatabaseName

      public String getDatabaseName()
      Return the name of the database.
      Returns:
      string name

    • getDataSource

      public DataSource getDataSource()
      Return the DataSource implementation for this database. This supports creating the connection to the database.
      Returns:
      DataSource

    • getLatestRow

      public Map<String,JDBCDataValue> getLatestRow(Connection jdbcConnection, String tableName, String identifierColumnName, String identifierColumnValue, String timestampColumnName, Map<String,Integer> columnNameTypeMap) throws SQLException
      Retrieve the row with the requested identifier and with the latest timestamp.
      Parameters:
      jdbcConnection - connection to the database
      tableName - name of the table to query
      identifierColumnName - name of the column with the identifier in it
      identifierColumnValue - value of the identifier to match on
      timestampColumnName - name of the column with the timestamp
      columnNameTypeMap - map of resulting column names and values to include in the results
      Returns:
      Map of column names to data values that represent the requested row
      Throws:
      SQLException - there was a problem calling the database

    • insertRowIntoTable

      public void insertRowIntoTable(Connection jdbcConnection, String tableName, Map<String,JDBCDataValue> columnNameValueMap) throws SQLException
      Prepare an INSERT SQL statement with all the columns for the new row filled out.
      Parameters:
      jdbcConnection - connection to send the request
      tableName - name of the table where the row is to be added
      columnNameValueMap - column names, values and types
      Throws:
      SQLException - problem executing the command

    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Free up any resources held since the connector is no longer needed.
      Overrides:
      disconnect in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.