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:

DataEngineInterface

public abstract class DataEngineConnectorBase
extends ConnectorBase
implements DataEngineInterface

Base implementation of a Data Engine Connector, implementing all of 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, isActive, securedProperties

Constructor Summary

Constructors

Constructor and Description
DataEngineConnectorBase() Default constructor

Method Summary

Modifier and Type	Method and Description
List<LineageMapping>	getChangedLineageMappings(Date from, Date to) Retrieve a list of the changed lineage mappings between the dates and times provided.
List<PortAlias>	getChangedPortAliases(Date from, Date to) Retrieve a list of the changed port aliases between the dates and times provided.
List<PortImplementation>	getChangedPortImplementations(Date from, Date to) Retrieve a list of the changed port implementations 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<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.
abstract SoftwareServerCapability	getDataEngineDetails() Retrieve the details about the data engine to which we are connected.
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, isActive, start, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataEngineConnectorBase

public DataEngineConnectorBase()

Default constructor

Method Detail

getDataEngineDetails

public abstract SoftwareServerCapability getDataEngineDetails()

Retrieve the details about the data engine to which we are connected.

Specified by:

getDataEngineDetails in interface DataEngineInterface

Returns:

SoftwareServerCapability

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

getChangesLastSynced

public Date getChangesLastSynced()

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

Specified by:

getChangesLastSynced in interface DataEngineInterface

Returns:

Date

setChangesLastSynced

public void setChangesLastSynced(Date time)

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

getChangedSchemaTypes

public List<SchemaType> getChangedSchemaTypes(Date from,
                                              Date to)

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>

getChangedPortImplementations

public List<PortImplementation> getChangedPortImplementations(Date from,
                                                              Date to)

Retrieve a list of the changed port implementations between the dates and times provided.

Specified by:

getChangedPortImplementations 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<PortImplementation>

getChangedPortAliases

public List<PortAlias> getChangedPortAliases(Date from,
                                             Date to)

Retrieve a list of the changed port aliases between the dates and times provided.

Specified by:

getChangedPortAliases 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<PortAlias>

getChangedProcesses

public List<Process> getChangedProcesses(Date from,
                                         Date to)

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>

getChangedLineageMappings

public List<LineageMapping> getChangedLineageMappings(Date from,
                                                      Date to)

Retrieve a list of the changed lineage mappings between the dates and times provided.

Specified by:

getChangedLineageMappings 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<LineageMapping>