Package de.iip_ecosphere.platform.connectors

Class AbstractThreadedConnector<O,I,CO,CI,M extends ModelAccess>

java.lang.Object

de.iip_ecosphere.platform.connectors.AbstractConnector<O,I,CO,CI>

de.iip_ecosphere.platform.connectors.AbstractThreadedConnector<O,I,CO,CI,M>

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

M - the model access type of the connector

All Implemented Interfaces:

Connector<O,I,CO,CI>, EventHandlingConnector, AbstractModelAccess.NotificationChangedListener

public abstract class AbstractThreadedConnector<O,I,CO,CI,M extends ModelAccess>
extends AbstractConnector<O,I,CO,CI>

Provides a reusable base for connectors that require a ModelAccess instance per calling thread. Extends AbstractConnector implementation using the ProtocolAdapter. Call setModelAccessSupplier(Supplier) (and implicitly AbstractConnector.configureModelAccess(ModelAccess)) before connect(ConnectorParameter). Calls ModelAccess.dispose().

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

AbstractConnector.BasicAdapterProvider

Field Summary

Fields

Modifier and Type	Field	Description
private Map<Thread,M>	accesses
private int	cleanupPeriod
private TimerTask	cleanupTask
private Supplier<M>	modelAccessSupplier
private Timer	timer

Fields inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

DEFAULT_CHANNEL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractThreadedConnector(AdapterSelector<O,I,CO,CI> selector, ProtocolAdapter<O,I,CO,CI>... adapter)	Creates an instance and installs the protocol adapter(s).
protected	AbstractThreadedConnector(ProtocolAdapter<O,I,CO,CI>... adapter)	Creates an instance and installs the protocol adapter(s) with a default selector for the first adapter.

Method Summary

Modifier and Type	Method	Description
protected ProtocolAdapter<O,I,CO,CI>	configureAdapter(ProtocolAdapter<O,I,CO,CI> adapter)	Configures the adapter if needed.
void	connect(ConnectorParameter params)	Connects the connector to the underlying machine/platform.
int	getCleanupPeriod()	Returns the cleanup period.
protected M	getModelAccess()	Returns the model-access instance for the current thread.
protected M	getModelAccess(Thread thread)	Returns the model-access instance for the given thread.
protected Supplier<M>	getModelAccessSupplier()	Returns the model access supplier.
private M	obtainModelAccess(Thread thread)	Returns/allocates a model access object for thread.
protected void	setCleanupPeriod(int cleanupPeriod)	Changes the cleanup period/timeout.
protected void	setModelAccessSupplier(Supplier<M> modelAccessSupplier)	Sets the model access supplier.
protected void	uninstallPollTask()	Uninstall poll task.

Methods inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

checkCache, configureModelAccess, connectImpl, createTlsContext, disconnect, disconnectImpl, dispose, doPolling, enableNotifications, enablePolling, error, getCachingStrategy, getCachingStrategyCls, getConnectorInputType, getConnectorOutputType, getConnectorParameter, getInitCachingStrategyCls, getInstanceIdentification, getProtocolInputType, getProtocolOutputType, getSelector, getStorageValue, initializeModelAccess, initSelector, installPollTask, isPolling, notificationsChanged, notifyDataTimeDifference, notifyReconfigured, read, received, received, request, request, setDataTimeDifference, setDataTimeDifferenceProvider, setInstanceIdentification, setReceptionCallback, setStorageValue, trigger, trigger, useTls, write, writeImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.connectors.Connector

createSharedSpace, disconnectSafe, enabledEncryption, enableSharedSpace, setReceptionCallbackSafe, supportedEncryption

Methods inherited from interface de.iip_ecosphere.platform.connectors.events.EventHandlingConnector

getName

Field Details

timer

private Timer timer

modelAccessSupplier

private Supplier<M extends ModelAccess> modelAccessSupplier

accesses

private Map<Thread,M extends ModelAccess> accesses

cleanupTask

private TimerTask cleanupTask

cleanupPeriod

private int cleanupPeriod

Constructor Details

AbstractThreadedConnector

@SafeVarargs
protected AbstractThreadedConnector(ProtocolAdapter<O,I,CO,CI>... adapter)

Creates an instance and installs the protocol adapter(s) with a default selector for the first adapter. For integration compatibility, connector constructors are supposed to accept a var-arg parameter for adapters.

Parameters:

adapter - the protocol adapter(s)

Throws:

IllegalArgumentException - if adapter is null or empty or adapters are null

See Also:

• setModelAccessSupplier(Supplier)

AbstractThreadedConnector

@SafeVarargs
protected AbstractThreadedConnector(AdapterSelector<O,I,CO,CI> selector,
 ProtocolAdapter<O,I,CO,CI>... adapter)

Creates an instance and installs the protocol adapter(s). For integration compatibility, connector constructors are supposed to accept a var-arg parameter for adapters.

Parameters:

selector - the adapter selector (null leads to a default selector for the first adapter)

adapter - the protocol adapter(s)

Throws:

IllegalArgumentException - if adapter is null or empty or adapters are null

See Also:

• setModelAccessSupplier(Supplier)

Method Details

setModelAccessSupplier

protected void setModelAccessSupplier(Supplier<M> modelAccessSupplier)

Sets the model access supplier. Calls AbstractConnector.configureModelAccess(ModelAccess)

Parameters:

modelAccessSupplier - supplier for model access instances, ignored if null

getModelAccessSupplier

protected Supplier<M> getModelAccessSupplier()

Returns the model access supplier.

Returns:

the supplier for model access instances (may be null if setModelAccessSupplier(Supplier) was not called with an appropriate instance before

obtainModelAccess

private M obtainModelAccess(Thread thread)

Returns/allocates a model access object for thread.

Parameters:

thread - the thread

Returns:

the model access object

configureAdapter

protected ProtocolAdapter<O,I,CO,CI> configureAdapter(ProtocolAdapter<O,I,CO,CI> adapter)

Description copied from class: AbstractConnector

Configures the adapter if needed.

Overrides:

configureAdapter in class AbstractConnector<O,I,CO,CI>

Parameters:

adapter - the adapter

Returns:

adapter

connect

public void connect(ConnectorParameter params)
             throws IOException

Description copied from class: AbstractConnector

Connects the connector to the underlying machine/platform. Calls AbstractConnector.connectImpl(ConnectorParameter) and if successful (no exception thrown) AbstractConnector.initializeModelAccess(). Calls ConnectorRegistry.registerConnector(Connector).

Specified by:

connect in interface Connector<O,I,CO,CI>

Overrides:

connect in class AbstractConnector<O,I,CO,CI>

Parameters:

params - connection parameter

Throws:

IOException - in case that connecting fails

setCleanupPeriod

protected void setCleanupPeriod(int cleanupPeriod)

Changes the cleanup period/timeout.

Parameters:

cleanupPeriod - the period in ms, ignored if not positive

getCleanupPeriod

public int getCleanupPeriod()

Returns the cleanup period.

Returns:

the cleanup period in ms

uninstallPollTask

protected void uninstallPollTask()

Description copied from class: AbstractConnector

Uninstall poll task.

Overrides:

uninstallPollTask in class AbstractConnector<O,I,CO,CI>

getModelAccess

protected M getModelAccess()

Returns the model-access instance for the current thread.

Returns:

the model-access instance, may be null

getModelAccess

protected M getModelAccess(Thread thread)

Returns the model-access instance for the given thread.

Parameters:

thread - the thread to return the model access for

Returns:

the model-access instance, may be null