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:
SecureConnectorExtension
,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.
-
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.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetChangedDataFlows
(Date from, Date to) Retrieve a list of the changed data flows between the dates and times provided.List<? super Referenceable>
getChangedDataStores
(Date from, Date to) Retrieve a list of the changed data stores between the dates and times provided.getChangedProcesses
(Date from, Date to) Retrieve a list of the changed processes between the dates and times provided.getChangedProcessHierarchies
(Date from, Date to) Retrieve a list of the changed process hierarchies between the dates and times provided.getChangedSchemaTypes
(Date from, Date to) Retrieve a list of the changed schema types between the dates and times provided.Retrieve the date and time at which changes were last synchronized.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.Gets processing state sync key.boolean
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, disconnectConnectors, 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
clone, finalize, 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 interfaceDataEngineInterface
- Returns:
- boolean
-
getProcessingStateSyncKey
Description copied from interface:DataEngineInterface
Gets processing state sync key.- Specified by:
getProcessingStateSyncKey
in interfaceDataEngineInterface
- Returns:
- the processing state sync key
-
getChangesLastSynced
Retrieve the date and time at which changes were last synchronized.- Specified by:
getChangesLastSynced
in interfaceDataEngineInterface
- Returns:
- Date
- Throws:
ConnectorCheckedException
PropertyServerException
-
setChangesLastSynced
public void setChangesLastSynced(Date time) throws ConnectorCheckedException, PropertyServerException Persist the date and time at which changes were last successfully synchronized.- Specified by:
setChangesLastSynced
in interfaceDataEngineInterface
- Parameters:
time
- the time to record for the last synchronization- Throws:
ConnectorCheckedException
PropertyServerException
-
getOldestChangeSince
public Date getOldestChangeSince(Date time) throws ConnectorCheckedException, 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 interfaceDataEngineInterface
- Parameters:
time
- the time from which to look for the oldest change- Returns:
- Date
- Throws:
ConnectorCheckedException
PropertyServerException
-
getChangedSchemaTypes
public List<SchemaType> getChangedSchemaTypes(Date from, Date to) throws ConnectorCheckedException, PropertyServerException Retrieve a list of the changed schema types between the dates and times provided.- Specified by:
getChangedSchemaTypes
in interfaceDataEngineInterface
- 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:
ConnectorCheckedException
PropertyServerException
-
getChangedDataStores
public List<? super Referenceable> getChangedDataStores(Date from, Date to) throws ConnectorCheckedException, PropertyServerException Retrieve a list of the changed data stores between the dates and times provided.- Specified by:
getChangedDataStores
in interfaceDataEngineInterface
- 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:
ConnectorCheckedException
PropertyServerException
-
getChangedProcesses
public List<Process> getChangedProcesses(Date from, Date to) throws ConnectorCheckedException, PropertyServerException Retrieve a list of the changed processes between the dates and times provided.- Specified by:
getChangedProcesses
in interfaceDataEngineInterface
- 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:
ConnectorCheckedException
PropertyServerException
-
getChangedProcessHierarchies
public List<ProcessHierarchy> getChangedProcessHierarchies(Date from, Date to) throws ConnectorCheckedException, PropertyServerException Retrieve a list of the changed process hierarchies between the dates and times provided.- Specified by:
getChangedProcessHierarchies
in interfaceDataEngineInterface
- 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:
ConnectorCheckedException
PropertyServerException
-
getChangedDataFlows
public List<DataFlow> getChangedDataFlows(Date from, Date to) throws ConnectorCheckedException, PropertyServerException Retrieve a list of the changed data flows between the dates and times provided.- Specified by:
getChangedDataFlows
in interfaceDataEngineInterface
- 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:
ConnectorCheckedException
PropertyServerException
-