Package de.iip_ecosphere.platform.connectors

Interface ConnectorDescriptor

All Known Implementing Classes:

AbstractPluginChannelConnectorDescriptor, AbstractPluginConnectorDescriptor

public interface ConnectorDescriptor

Describes a connector without instantiating it. Required to use the Java services mechanism to silently register connector classes with the ConnectorRegistry. Per connector type (getConnectorType()) there shall be only a single descriptor (instance)!

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_ID_PREFIX
static final String	PLUGIN_TEST_ID_PREFIX

Method Summary

Modifier and Type	Method	Description
default <O, I, CO, CI, A extends ProtocolAdapter<O, I, CO, CI>> Connector<O,I,CO,CI>	createConnector(Supplier<ConnectorParameter> params, A... adapter)	Creates a connector instance.
<O, I, CO, CI, S extends AdapterSelector<O, I, CO, CI>, A extends ProtocolAdapter<O, I, CO, CI>> Connector<O,I,CO,CI>	createConnector(S selector, Supplier<ConnectorParameter> params, A... adapter)	Creates a connector instance.
Class<?>	getConnectorType()	Returns the type of the connector.
String	getName()	Returns the name of the connector.

Field Details

PLUGIN_ID_PREFIX

static final String PLUGIN_ID_PREFIX

See Also:

• Constant Field Values

PLUGIN_TEST_ID_PREFIX

static final String PLUGIN_TEST_ID_PREFIX

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns the name of the connector.

Returns:

the name

getConnectorType

Class<?> getConnectorType()

Returns the type of the connector.

Returns:

the type

createConnector

default <O,
I,
CO,
CI,
A extends ProtocolAdapter<O,
I,
CO,
CI>>
Connector<O,I,CO,CI> createConnector(Supplier<ConnectorParameter> params,
 A... adapter)

Creates a connector instance.

Type Parameters:

O - the output type from the underlying machine/platform/external sinksource

I - the input type to the underlying machine/platform/external sinksource

CO - the output type of the connector

CI - the input type of the connector

A - the protocol adapter type

Parameters:

params - the connector parameters supplier

adapter - the protocol adapters to create the connector for

Returns:

the created connector

createConnector

<O,
I,
CO,
CI,
S extends AdapterSelector<O,
I,
CO,
CI>,
A extends ProtocolAdapter<O,
I,
CO,
CI>>
Connector<O,I,CO,CI> createConnector(S selector,
 Supplier<ConnectorParameter> params,
 A... adapter)

Creates a connector instance.

Type Parameters:

O - the output type from the underlying machine/platform/external sinksource

I - the input type to the underlying machine/platform/external sinksource

CO - the output type of the connector

CI - the input type of the connector

S - the protocol selector type

A - the protocol adapter type

Parameters:

selector - the protocol selector, may be null for none

params - the connector parameters supplier

adapter - the protocol adapters to create the connector for

Returns:

the created connector