com.incorta.connector

Interface Connector

public interface Connector

A connector instance works as a connection to a data source. A connector is used for discovering catalogs, schemas, tables and columns from the data source. For example, an SQL database connector is used to discover the schemas and tables in this database, the columns in each table and their types, as well as the joins between those tables.

A connector instance is also used as a factory for DataSet objects, in the same way a JDBC Connection object is used as a factory for Statement object.

A connector is created using a ConnectorFactory.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
DataSet	createDataSet(DataSetContext context, DataSetSpec dsSpec) This is the factory method used for creating DataSet objects.
DataSetSpec	generateDataSetSpec(DiscoveryContext context, java.lang.String catalog, java.lang.String schema, java.lang.String table, java.lang.String[] columns) Generates the data set specification for the selected catalog, schema, table and columns.
java.util.List<CatalogDetails>	getCatalogs(DiscoveryContext context, java.lang.String parentCatalog) Returns a list of catalogs under the specified parent catalog.
java.util.List<ColumnDetails>	getColumns(DiscoveryContext context, java.lang.String catalog, java.lang.String schema, java.lang.String table) Returns the list of columns of the specified table.
java.lang.String	getName() Returns the name of the connector instance.
java.util.List<SchemaDetails>	getSchemas(DiscoveryContext context, java.lang.String catalog) Returns a list of schemas under the specified parent catalog.
java.util.List<TableDetails>	getTables(DiscoveryContext context, java.lang.String catalog, java.lang.String schema) Returns a list of tables under the specified catalog and schema.
ConnectorType	getType() Returns the complete type (type, sub-type and version) of this connector
default boolean	isPredefined() Returns a boolean flag indicating whether or not this connector is predefined.
default PropertyModel	refreshDataSetProperty(DataSetContext context, DataSetSpec dsSpec, PropertyModel property) This method is used if a data set contains a DYNAMIC_LIST field.
default void	shutdown() This method is used for shutting down the connector instance when Incorta is shutting down (closing connections, cleaning up resources, etc.).
boolean	supportsCatalogs(DiscoveryContext context) Returns a boolean flag indicating whether or not this connector supports catalogs.
boolean	supportsSchemas(DiscoveryContext context) Returns a boolean flag indicating whether or not this connector supports schemas.
void	testConnection() This method is used for testing connection to the data source.
DataSetTestResult	testDataSet(DiscoveryContext context, DataSetSpec dsSpec) Tests the specified data set specification.

Method Detail

getName

java.lang.String getName()

Returns the name of the connector instance.

Returns:

Connector name

Since:

1.0

getType

ConnectorType getType()

Returns the complete type (type, sub-type and version) of this connector

Returns:

ConnectorType object

Since:

1.0

isPredefined

default boolean isPredefined()

Returns a boolean flag indicating whether or not this connector is predefined. A predefined connector has a single predefined instance. User cannot create more than one instance of a predefined connector. An example of predefined connectors is the LocalFiles connector.

Returns:

true if this connector is predefined, false otherwise

Since:

1.0

testConnection

void testConnection()
             throws ConnectorException

This method is used for testing connection to the data source. The method should throw a ConnectorException (usually a FailedConnectionException) when connection fails.

Throws:

ConnectorException

Since:

1.0

shutdown

default void shutdown()
               throws ConnectorException

This method is used for shutting down the connector instance when Incorta is shutting down (closing connections, cleaning up resources, etc.). By default, this method does not do anything.

Throws:

ConnectorException

Since:

1.0

supportsCatalogs

boolean supportsCatalogs(DiscoveryContext context)
                  throws ConnectorException

Returns a boolean flag indicating whether or not this connector supports catalogs. Catalogs can contain schemas, tables and other nested catalogs. This method is used by the schema wizard during discovery.

Parameters:

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

Returns:

true if connector supports catalogs, false otherwise

Throws:

ConnectorException

Since:

1.0

supportsSchemas

boolean supportsSchemas(DiscoveryContext context)
                 throws ConnectorException

Returns a boolean flag indicating whether or not this connector supports schemas. Schemas can contain tables. This method is used by the schema wizard during discovery.

Parameters:

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

Returns:

true if connector supports schemas, false otherwise

Throws:

ConnectorException

Since:

1.0

getCatalogs

java.util.List<CatalogDetails> getCatalogs(DiscoveryContext context,
                                           java.lang.String parentCatalog)
                                    throws ConnectorException

Returns a list of catalogs under the specified parent catalog. If connector does not support catalogs, an empty list must be returned. This method is used by the schema wizard during discovery.

Parameters:

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

parentCatalog - Full path of the parent catalog (x/y/z), null for root

Returns:

List of CatalogDetails objects

Throws:

ConnectorException

Since:

1.0

getSchemas

java.util.List<SchemaDetails> getSchemas(DiscoveryContext context,
                                         java.lang.String catalog)
                                  throws ConnectorException

Returns a list of schemas under the specified parent catalog. If connector does not support schemas, an empty list must be returned. This method is used by the schema wizard during discovery.

Parameters:

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

catalog - Full path of the parent catalog (x/y/z), null for root

Returns:

List of SchemaDetails objects

Throws:

ConnectorException

Since:

1.0

getTables

java.util.List<TableDetails> getTables(DiscoveryContext context,
                                       java.lang.String catalog,
                                       java.lang.String schema)
                                throws ConnectorException

Returns a list of tables under the specified catalog and schema. This method is used by the schema wizard during discovery.

Parameters:

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

catalog - Fully qualified catalog path (x/y/z)

schema - Schema name

Returns:

List of TableDetails objects

Throws:

ConnectorException

Since:

1.0

getColumns

java.util.List<ColumnDetails> getColumns(DiscoveryContext context,
                                         java.lang.String catalog,
                                         java.lang.String schema,
                                         java.lang.String table)
                                  throws ConnectorException

Returns the list of columns of the specified table. This method is used by the schema wizard during discovery.

Parameters:

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

catalog - Fully qualified catalog path (x/y/z)

schema - Schema name

table - Table name

Returns:

List of ColumnDetails objects

Throws:

ConnectorException

Since:

1.0

generateDataSetSpec

DataSetSpec generateDataSetSpec(DiscoveryContext context,
                                java.lang.String catalog,
                                java.lang.String schema,
                                java.lang.String table,
                                java.lang.String[] columns)
                         throws ConnectorException

Generates the data set specification for the selected catalog, schema, table and columns. For example, for an SQL database connector, it generates a data set specification containing the SELECT query of the table. This method is used by the schema wizard during the last step.

Parameters:

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

catalog - Fully qualified catalog path (x/y/z)

schema - The selected schema name

table - The selected table name

columns - The selected column names

Returns:

DataSetSpec object corresponding to the selected criteria

Throws:

ConnectorException

Since:

1.0

testDataSet

DataSetTestResult testDataSet(DiscoveryContext context,
                              DataSetSpec dsSpec)
                       throws ConnectorException

Tests the specified data set specification. This method is used by the schema wizard during the last step.

Parameters:

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

dsSpec - The data set specification to be tested

Returns:

A DataSetTestResult object containing the test result, which may include sample data

Throws:

ConnectorException

Since:

1.0

createDataSet

DataSet createDataSet(DataSetContext context,
                      DataSetSpec dsSpec)
               throws ConnectorException

This is the factory method used for creating DataSet objects. This method is used during extraction.

Parameters:

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

dsSpec - The specification of the data set to be created

Returns:

The DataSet instance

Throws:

ConnectorException

Since:

1.0

refreshDataSetProperty

default PropertyModel refreshDataSetProperty(DataSetContext context,
                                             DataSetSpec dsSpec,
                                             PropertyModel property)
                                      throws ConnectorException

This method is used if a data set 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.

dsSpec - The current data set specification that the user is editing

property - The DYNAMIC_LIST property to be updated

Returns:

Updated PropertyModel object

Throws:

ConnectorException

Since:

1.0