Package de.iip_ecosphere.platform.connectors

Class DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator

java.lang.Object

de.iip_ecosphere.platform.connectors.DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator

All Implemented Interfaces:

ConnectorFactoryDescriptor.ConnectorFactoryCreator

Enclosing class:

DefaultConnectorFactoryDescriptor

public static class DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator
extends Object
implements ConnectorFactoryDescriptor.ConnectorFactoryCreator

Default (type-safe) creator implementation.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private Supplier<ConnectorParameter>	connSupplier
private Map<Class<?>,DefaultConnectorFactoryDescriptor.SerializerSupplier<?>>	inputSerializerSupplier
private Map<Class<?>,DefaultConnectorFactoryDescriptor.SerializerSupplier<?>>	outputSerializerSupplier
private DefaultConnectorFactoryDescriptor.ProtocolAdapterSupplier<?,?,?,?>	protoSupplier
private String	serviceId

Constructor Summary

Constructors

Constructor	Description
DefaultConnectorFactoryCreator(String serviceId)	Creates a factory creator instance for a given servuceId.

Method Summary

Modifier and Type	Method	Description
<T> ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>	createChanneledInputSerializer(Class<T> cls)	Creates a channeled input serializer for the given serviceId and the given type cls.
<T> ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>	createChanneledOutputSerializer(Class<T> cls)	Creates a channeled output serializer for the given serviceId and the given type cls.
ConnectorParameter	createConnectorParameter()	Creates the default connector parameter instance.
<O, I, CO, CI> ProtocolAdapter<O,I,CO,CI>[]	createProtocolAdapter(de.iip_ecosphere.platform.support.metrics.MetricsProvider metrics, File log, Supplier<String> inPathSupplier, Supplier<String> outPathSupplier, Class<O> oClass, Class<I> iClass, Class<CO> coClass, Class<CI> ciClass)	Creates the default connector protocol adapter.
String	getPluginId()	Returns the associated plugin id.
<O, I, CO, CI> DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator	supply(DefaultConnectorFactoryDescriptor.PathSupplier<ProtocolAdapter<O,I,CO,CI>> protoSupplier, Class<O> oClass, Class<I> iClass, Class<CO> coClass, Class<CI> ciClass)	Adds a protocol adapter supplier.
DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator	supply(Supplier<ConnectorParameter> connSupplier)	Adds a connector parameter supplier.
<T> DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator	supplyForInput(Supplier<ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>> supplier, Class<T> cls)	Adds an input serializer supplier.
<T> DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator	supplyForOutput(Supplier<ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>> supplier, Class<T> cls)	Adds an output serializer supplier.
<O, I, CO, CI> DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator	supplyMulti(DefaultConnectorFactoryDescriptor.PathSupplier<ProtocolAdapter<O,I,CO,CI>[]> protoSupplier, Class<O> oClass, Class<I> iClass, Class<CO> coClass, Class<CI> ciClass)	Adds a protocol adapter supplier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serviceId

private String serviceId

connSupplier

private Supplier<ConnectorParameter> connSupplier

protoSupplier

private DefaultConnectorFactoryDescriptor.ProtocolAdapterSupplier<?,?,?,?> protoSupplier

inputSerializerSupplier

private Map<Class<?>,DefaultConnectorFactoryDescriptor.SerializerSupplier<?>> inputSerializerSupplier

outputSerializerSupplier

private Map<Class<?>,DefaultConnectorFactoryDescriptor.SerializerSupplier<?>> outputSerializerSupplier

Constructor Details

DefaultConnectorFactoryCreator

public DefaultConnectorFactoryCreator(String serviceId)

Creates a factory creator instance for a given servuceId. Requires calls to the supplier-methods after instance creation.

Parameters:

serviceId - the service id

Method Details

supply

public DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator supply(Supplier<ConnectorParameter> connSupplier)

Adds a connector parameter supplier.

Parameters:

connSupplier - the supplier to be called, may be null but then createConnectorParameter() will return null

Returns:

this for chaining

supply

public <O,
I,
CO,
CI>
DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator supply(DefaultConnectorFactoryDescriptor.PathSupplier<ProtocolAdapter<O,I,CO,CI>> protoSupplier,
 Class<O> oClass,
 Class<I> iClass,
 Class<CO> coClass,
 Class<CI> ciClass)

Adds a protocol adapter supplier.

Type Parameters:

O - the output type from the underlying machine/platform

I - the input type to the underlying machine/platform

CO - the output type of the connector

CI - the input type of the connector

Parameters:

protoSupplier - the supplier to be called, may be null, will return null

oClass - the type for O

iClass - the type for I

coClass - the type for CO

ciClass - the type for CI

Returns:

this for chaining

supplyMulti

public <O,
I,
CO,
CI>
DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator supplyMulti(DefaultConnectorFactoryDescriptor.PathSupplier<ProtocolAdapter<O,I,CO,CI>[]> protoSupplier,
 Class<O> oClass,
 Class<I> iClass,
 Class<CO> coClass,
 Class<CI> ciClass)

Adds a protocol adapter supplier.

Type Parameters:

O - the output type from the underlying machine/platform

I - the input type to the underlying machine/platform

CO - the output type of the connector

CI - the input type of the connector

Parameters:

protoSupplier - the supplier to be called, may be null, will return null

oClass - the type for O

iClass - the type for I

coClass - the type for CO

ciClass - the type for CI

Returns:

this for chaining

supplyForInput

public <T>
DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator supplyForInput(Supplier<ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>> supplier,
 Class<T> cls)

Adds an input serializer supplier.

Type Parameters:

T - the data type

Parameters:

supplier - the supplier

cls - the data type class

Returns:

this for chaining

supplyForOutput

public <T>
DefaultConnectorFactoryDescriptor.DefaultConnectorFactoryCreator supplyForOutput(Supplier<ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T>> supplier,
 Class<T> cls)

Adds an output serializer supplier.

Type Parameters:

T - the data type

Parameters:

supplier - the supplier

cls - the data type class

Returns:

this for chaining

getPluginId

public String getPluginId()

Description copied from interface: ConnectorFactoryDescriptor.ConnectorFactoryCreator

Returns the associated plugin id.

Specified by:

getPluginId in interface ConnectorFactoryDescriptor.ConnectorFactoryCreator

Returns:

the plugin id

createConnectorParameter

public ConnectorParameter createConnectorParameter()

Description copied from interface: ConnectorFactoryDescriptor.ConnectorFactoryCreator

Creates the default connector parameter instance.

Specified by:

createConnectorParameter in interface ConnectorFactoryDescriptor.ConnectorFactoryCreator

Returns:

the connector parameter

createProtocolAdapter

public <O,
I,
CO,
CI> ProtocolAdapter<O,I,CO,CI>[] createProtocolAdapter(de.iip_ecosphere.platform.support.metrics.MetricsProvider metrics,
 File log,
 Supplier<String> inPathSupplier,
 Supplier<String> outPathSupplier,
 Class<O> oClass,
 Class<I> iClass,
 Class<CO> coClass,
 Class<CI> ciClass)

Description copied from interface: ConnectorFactoryDescriptor.ConnectorFactoryCreator

Creates the default connector protocol adapter.

Specified by:

createProtocolAdapter in interface ConnectorFactoryDescriptor.ConnectorFactoryCreator

Type Parameters:

O - the output type from the underlying machine/platform

I - the input type to the underlying machine/platform

CO - the output type of the connector

CI - the input type of the connector

Parameters:

metrics - the metrics provider to use, null for no metric measurements

log - the log file to use to record individual measurements in experiments, null for no logging. Only becomes active if metrics is not null

inPathSupplier - function returning the actual input base path to use for data accesses, may be null

outPathSupplier - function returning the actual output base path to use for data accesses, may be null

oClass - the actual type of O

iClass - the actual type of I

coClass - the actual type of CO

ciClass - the actual type of CI

Returns:

the connector protocol adapter

createChanneledInputSerializer

public <T>
ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T> createChanneledInputSerializer(Class<T> cls)

Description copied from interface: ConnectorFactoryDescriptor.ConnectorFactoryCreator

Creates a channeled input serializer for the given serviceId and the given type cls.

Specified by:

createChanneledInputSerializer in interface ConnectorFactoryDescriptor.ConnectorFactoryCreator

Type Parameters:

T - the data type

Parameters:

cls - the data type

Returns:

the serializer or null if unknown

createChanneledOutputSerializer

public <T>
ChanneledConnectorOutputTypeAdapter.ChanneledSerializer<T> createChanneledOutputSerializer(Class<T> cls)

Description copied from interface: ConnectorFactoryDescriptor.ConnectorFactoryCreator

Creates a channeled output serializer for the given serviceId and the given type cls.

Specified by:

createChanneledOutputSerializer in interface ConnectorFactoryDescriptor.ConnectorFactoryCreator

Type Parameters:

T - the data type

Parameters:

cls - the data type

Returns:

the serializer or null if unknown