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

Interface DataEngineInterface

All Known Implementing Classes:
DataEngineConnectorBase
public interface DataEngineInterface
Required methods expected to be implemented by any Data Engine Connector.

  • 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.
    org.odpi.openmetadata.accessservices.dataengine.model.Engine
    getDataEngineDetails()
    Retrieve the details about the data engine to which we are connected.
    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.

  • Method Details

    • getDataEngineDetails

      org.odpi.openmetadata.accessservices.dataengine.model.Engine getDataEngineDetails()
      Retrieve the details about the data engine to which we are connected.
      Returns:
      SoftwareCapability

    • requiresPolling

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

    • getProcessingStateSyncKey

      String getProcessingStateSyncKey()
      Gets processing state sync key.
      Returns:
      the processing state sync key

    • getChangesLastSynced

      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.
      Returns:
      Date
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • setChangesLastSynced

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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