io.cdap.cdap.etl.api.connector

Interface Connector

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

BatchConnector<KEY_IN,VAL_IN>, DirectConnector

public interface Connector
extends Closeable

A connector is a plugin which is able to explore and sample an external resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_TYPE

Method Summary

Modifier and Type	Method and Description
BrowseDetail	browse(ConnectorContext context, BrowseRequest request) Browse the resources on the given request.
default void	close()
default void	configure(ConnectorConfigurer configurer) Configure this connector, for example, the database connector will need to load the jdbc driver.
ConnectorSpec	generateSpec(ConnectorContext context, ConnectorSpecRequest path) Generate spec based on the given path, the spec should contain all the properties associated with the path.
void	test(ConnectorContext context) Test if the connector is able to connect to the resource

Field Detail

PLUGIN_TYPE

static final String PLUGIN_TYPE

See Also:

Constant Field Values

Method Detail

configure

default void configure(ConnectorConfigurer configurer)
                throws IOException

Configure this connector, for example, the database connector will need to load the jdbc driver. This method is guaranteed to be called before any other method in this class.

Throws:

IOException

test

void test(ConnectorContext context)
   throws ValidationException

Test if the connector is able to connect to the resource

Parameters:

context - context for the connector

Throws:

ValidationException - if the connector is not able to connect to the source

browse

BrowseDetail browse(ConnectorContext context,
                    BrowseRequest request)
             throws IOException

Browse the resources on the given request. The browse request expects a path to represent the hierarchy of the resource. The path is expected to be separated by '/'. If the given path is not browsable, the result will contain the information on the current path. For example, for a file based connector, the path will just be the file/directory path for a database connector, the path can be {database}/{table}

Parameters:

context - context for the connector

request - the browse request

Throws:

IOException

generateSpec

ConnectorSpec generateSpec(ConnectorContext context,
                           ConnectorSpecRequest path)
                    throws IOException

Generate spec based on the given path, the spec should contain all the properties associated with the path. For example, for bigquery, this can be a map containing "datasets": {dataset}, "table": {table}

Parameters:

context - context for the connector

path - the path of the entity

Returns:

the spec which contains all the properties associated with the path

Throws:

IOException

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException