com.incorta.connector

Interface ConnectorFactory

public interface ConnectorFactory

The connector factory is the runtime entry point for any connector. A connector factory is used for discovering supported connectors as well as for creating connector instances.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_MAJOR_VERSION The connector API major version.
static int	API_MINOR_VERSION The connector API minor version.
static java.lang.String	API_VERSION The connector API version, expressed as "(major).(minor)".

Method Summary

Modifier and Type	Method and Description
Connector	createConnector(ConnectorContext context, ConnectorSpec connectorSpec, boolean keepAlive) Factory method for creating a connector instance, given the specified connector specification.
ConnectorModel	getConnectorModel(ConnectorFactoryContext context, ConnectorType type) Returns the ConnectorModel object of the specified connector type.
default OAuthManager	getOAuthManager(ConnectorContext context, ConnectorType type) Returns an OAuthManager object that can be used for OAuth authentication of third parties.
java.util.List<ConnectorType>	getSupportedTypes() Returns a list of connector types that are supported by this connector factory.
default PropertyModel	refreshConnectorProperty(ConnectorContext context, ConnectorSpec connectorSpec, PropertyModel property) This method is used if a connector contains a DYNAMIC_LIST field.
default ConnectorSpec	updateLegacyConnectorSpec(ConnectorSpec connectorSpec) If this connector has previous versions, this method can be used to convert connector specification from the old version to the current version.
default DataSetSpec	updateLegacyDataSetSpec(DataSetSpec dataSetSpec) If this connector has previous versions, this method can be used to convert data set specification from the old version to the current version.

Field Detail

API_MAJOR_VERSION

static final int API_MAJOR_VERSION

The connector API major version. A change in API major version indicates a breaking change in the API. When deploying a connector as an external JAR,the API major version specified in the JAR's manifest must match that of the Incorta installation.

Since:

1.0

See Also:

Constant Field Values

API_MINOR_VERSION

static final int API_MINOR_VERSION

The connector API minor version. A change in API minor version indicates a non-breaking change in the API. When deploying a connector as an external JAR,the API minor version specified in the JAR's manifest must be less than or equal to that of the Incorta installation.

Since:

1.0

See Also:

Constant Field Values

API_VERSION

static final java.lang.String API_VERSION

The connector API version, expressed as "(major).(minor)".

Since:

1.0

See Also:

Constant Field Values

Method Detail

getSupportedTypes

java.util.List<ConnectorType> getSupportedTypes()

Returns a list of connector types that are supported by this connector factory. For a typical connector factory, this list should contain one item. But this is not always the case.

Returns:

ConnectorType list

Since:

1.0

getConnectorModel

ConnectorModel getConnectorModel(ConnectorFactoryContext context,
                                 ConnectorType type)

Returns the ConnectorModel object of the specified connector type.

Parameters:

context - A context object that can be used to access tenant information, etc.

type - The connector type, sub-type and version

Returns:

ConnectorModel

Since:

1.0

createConnector

Connector createConnector(ConnectorContext context,
                          ConnectorSpec connectorSpec,
                          boolean keepAlive)
                   throws ConnectorException

Factory method for creating a connector instance, given the specified connector specification.

Parameters:

context - A context object that can be used to access tenant information, etc.

connectorSpec - The connector specification, including connector name, type and properties

keepAlive - false if the created connector instance is temporary (e.g. for testing connection), true otherwise.

Returns:

The created Connector instance

Throws:

ConnectorException

Since:

1.0

getOAuthManager

default OAuthManager getOAuthManager(ConnectorContext context,
                                     ConnectorType type)
                              throws ConnectorException

Returns an OAuthManager object that can be used for OAuth authentication of third parties. It is used with OAUTH field type. By default, this method returns null.

Parameters:

context - A context object that can be used to access tenant information, etc.

type - The connector type, sub-type and version

Returns:

The OAUthManager object, if any

Throws:

ConnectorException

Since:

1.0

refreshConnectorProperty

default PropertyModel refreshConnectorProperty(ConnectorContext context,
                                               ConnectorSpec connectorSpec,
                                               PropertyModel property)
                                        throws ConnectorException

This method is used if a connector contains a DYNAMIC_LIST field. When the list is refreshed dynamically, this method is called to return the updated PropertyModel object which contains the updated list items. By default, this method returns the original property unchanged.

Parameters:

context - A context object that can be used to access tenant information, etc.

connectorSpec - The current connector specification that the user is editing

property - The DYNAMIC_LIST property to be updated

Returns:

Updated PropertyModel object

Throws:

ConnectorException

Since:

1.0

updateLegacyConnectorSpec

default ConnectorSpec updateLegacyConnectorSpec(ConnectorSpec connectorSpec)

If this connector has previous versions, this method can be used to convert connector specification from the old version to the current version. By default, this method returns the old specification object unchanged.

Parameters:

connectorSpec - Old version ConnectorSpec object

Returns:

New version ConnectorSpec object

Since:

1.0

updateLegacyDataSetSpec

default DataSetSpec updateLegacyDataSetSpec(DataSetSpec dataSetSpec)

If this connector has previous versions, this method can be used to convert data set specification from the old version to the current version. By default, this method returns the old specification object unchanged.

Parameters:

dataSetSpec - Old version DataSetSpec object

Returns:

New version DataSetSpec object

Since:

1.0