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<DataFlow>	getChangedDataFlows(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.
List<Process>	getChangedProcesses(Date from, Date to)	Retrieve a list of the changed processes between the dates and times provided.
List<ProcessHierarchy>	getChangedProcessHierarchies(Date from, Date to)	Retrieve a list of the changed process hierarchies between the dates and times provided.
List<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.
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

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 ConnectorCheckedException,
PropertyServerException

Retrieve the date and time at which changes were last synchronized.

Returns:

Date

Throws:

ConnectorCheckedException

PropertyServerException

setChangesLastSynced

void setChangesLastSynced(Date time)
                   throws ConnectorCheckedException,
PropertyServerException

Persist the date and time at which changes were last successfully synchronized.

Parameters:

time - the time to record for the last synchronization

Throws:

ConnectorCheckedException

PropertyServerException

getOldestChangeSince

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.

Parameters:

time - the time from which to look for the oldest change

Returns:

Date

Throws:

ConnectorCheckedException

PropertyServerException

getChangedSchemaTypes

List<SchemaType> getChangedSchemaTypes(Date from,
 Date to)
                                throws ConnectorCheckedException,
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:

ConnectorCheckedException

PropertyServerException

getChangedDataStores

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.

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

List<Process> getChangedProcesses(Date from,
 Date to)
                           throws ConnectorCheckedException,
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:

ConnectorCheckedException

PropertyServerException

getChangedProcessHierarchies

List<ProcessHierarchy> getChangedProcessHierarchies(Date from,
 Date to)
                                             throws ConnectorCheckedException,
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:

ConnectorCheckedException

PropertyServerException

getChangedDataFlows

List<DataFlow> getChangedDataFlows(Date from,
 Date to)
                            throws ConnectorCheckedException,
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:

ConnectorCheckedException

PropertyServerException