Package org.odpi.openmetadata.governanceservers.dataengineproxy.connectors

Class DataEngineConnectorBase

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.governanceservers.dataengineproxy.connectors.DataEngineConnectorBase
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, DataEngineInterface
public abstract class DataEngineConnectorBase extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements DataEngineInterface
Base implementation of a Data Engine Connector, implementing all the required methods any Data Engine Connector is expected to provide (via the DataEngineInterface). It is an abstract class as on its own it does absolutely nothing, and therefore a Data Engine Connector needs to extend it and override at least one of the methods to actually do something.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineConnectorBase()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.accessservices.dataengine.model.DataFlow>
    getChangedDataFlows(Date from, Date to)
    Retrieve a list of the changed data flows between the dates and times provided.
    List<? super org.odpi.openmetadata.accessservices.dataengine.model.Referenceable>
    getChangedDataStores(Date from, Date to)
    Retrieve a list of the changed data stores between the dates and times provided.
    List<org.odpi.openmetadata.accessservices.dataengine.model.Process>
    getChangedProcesses(Date from, Date to)
    Retrieve a list of the changed processes between the dates and times provided.
    List<org.odpi.openmetadata.accessservices.dataengine.model.ProcessHierarchy>
    getChangedProcessHierarchies(Date from, Date to)
    Retrieve a list of the changed process hierarchies between the dates and times provided.
    List<org.odpi.openmetadata.accessservices.dataengine.model.SchemaType>
    getChangedSchemaTypes(Date from, Date to)
    Retrieve a list of the changed schema types between the dates and times provided.
    Date
    getChangesLastSynced()
    Retrieve the date and time at which changes were last synchronized.
    Date
    getOldestChangeSince(Date time)
    Retrieve the date of the oldest change since the time specified, or if there were no changes since the time specified return null.
    String
    getProcessingStateSyncKey()
    Gets processing state sync key.
    boolean
    requiresPolling()
    Indicates whether the data engine requires polling (true) or is capable of notifying of changes on its own (false).
    void
    setChangesLastSynced(Date time)
    Persist the date and time at which changes were last successfully synchronized.

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

    disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, start, 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

    Methods inherited from interface org.odpi.openmetadata.governanceservers.dataengineproxy.connectors.DataEngineInterface

    getDataEngineDetails

  • Constructor Details

    • DataEngineConnectorBase

      public DataEngineConnectorBase()
      Default constructor

  • Method Details

    • requiresPolling

      public boolean requiresPolling()
      Indicates whether the data engine requires polling (true) or is capable of notifying of changes on its own (false).
      Specified by:
      requiresPolling in interface DataEngineInterface
      Returns:
      boolean

    • getProcessingStateSyncKey

      public String getProcessingStateSyncKey()
      Description copied from interface: DataEngineInterface
      Gets processing state sync key.
      Specified by:
      getProcessingStateSyncKey in interface DataEngineInterface
      Returns:
      the processing state sync key

    • getChangesLastSynced

      public Date getChangesLastSynced() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the date and time at which changes were last synchronized.
      Specified by:
      getChangesLastSynced in interface DataEngineInterface
      Returns:
      Date
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • setChangesLastSynced

      public void setChangesLastSynced(Date time) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Persist the date and time at which changes were last successfully synchronized.
      Specified by:
      setChangesLastSynced in interface DataEngineInterface
      Parameters:
      time - the time to record for the last synchronization
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getOldestChangeSince

      public Date getOldestChangeSince(Date time) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the date of the oldest change since the time specified, or if there were no changes since the time specified return null.
      Specified by:
      getOldestChangeSince in interface DataEngineInterface
      Parameters:
      time - the time from which to look for the oldest change
      Returns:
      Date
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getChangedSchemaTypes

      public List<org.odpi.openmetadata.accessservices.dataengine.model.SchemaType> getChangedSchemaTypes(Date from, Date to) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the changed schema types between the dates and times provided.
      Specified by:
      getChangedSchemaTypes in interface DataEngineInterface
      Parameters:
      from - the date and time from which to look for changes (exclusive)
      to - the date and time up to which to look for changes (inclusive)
      Returns:
      List<SchemaType>
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getChangedDataStores

      public List<? super org.odpi.openmetadata.accessservices.dataengine.model.Referenceable> getChangedDataStores(Date from, Date to) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the changed data stores between the dates and times provided.
      Specified by:
      getChangedDataStores in interface DataEngineInterface
      Parameters:
      from - the date and time from which to look for changes (exclusive)
      to - the date and time up to which to look for changes (inclusive)
      Returns:
      List<SchemaType>
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getChangedProcesses

      public List<org.odpi.openmetadata.accessservices.dataengine.model.Process> getChangedProcesses(Date from, Date to) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the changed processes between the dates and times provided.
      Specified by:
      getChangedProcesses in interface DataEngineInterface
      Parameters:
      from - the date and time from which to look for changes (exclusive)
      to - the date and time up to which to look for changes (inclusive)
      Returns:
      List<Process>
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getChangedProcessHierarchies

      public List<org.odpi.openmetadata.accessservices.dataengine.model.ProcessHierarchy> getChangedProcessHierarchies(Date from, Date to) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the changed process hierarchies between the dates and times provided.
      Specified by:
      getChangedProcessHierarchies in interface DataEngineInterface
      Parameters:
      from - the date and time from which to look for changes (exclusive)
      to - the date and time up to which to look for changes (inclusive)
      Returns:
      List<ProcessHierarchy>
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • getChangedDataFlows

      public List<org.odpi.openmetadata.accessservices.dataengine.model.DataFlow> getChangedDataFlows(Date from, Date to) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the changed data flows between the dates and times provided.
      Specified by:
      getChangedDataFlows in interface DataEngineInterface
      Parameters:
      from - the date and time from which to look for changes (exclusive)
      to - the date and time up to which to look for changes (inclusive)
      Returns:
      List<DataFlow>
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException