de.iip_ecosphere.platform.transport.connectors.impl

Class AbstractTransportConnector

java.lang.Object

de.iip_ecosphere.platform.transport.connectors.impl.AbstractTransportConnector

All Implemented Interfaces:

TransportConnector

Direct Known Subclasses:

AbstractMqttTransportConnector, DirectMemoryTransferTransportConnector

public abstract class AbstractTransportConnector
extends Object
implements TransportConnector

An abstract transport connector.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractTransportConnector.AuthenticationConsumer Consumes token authentication data.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,List<ReceptionCallback<?>>>	callbacks
private TransportParameter	params

Fields inherited from interface de.iip_ecosphere.platform.transport.connectors.TransportConnector

EMPTY_PARENT

Constructor Summary

Constructors

Constructor and Description
AbstractTransportConnector()

Method Summary

Modifier and Type	Method and Description
static boolean	applyAuthenticationKey(String authenticationKey, AbstractTransportConnector.AuthenticationConsumer consumer) Tries to apply the given authentication key to the given consumer.
void	connect(TransportParameter params) Connects the underlying connections.
void	detachReceptionCallback(String stream, ReceptionCallback<?> callback) Detaches a reception callback to stream.
void	disconnect() Disconnects the underlying connections.
protected int	getActionTimeout() Returns the timeout for individual send/receive actions.
protected String	getApplicationId() The unique application/client identifier.
static String	getApplicationId(String applicationId, String infix, boolean makeUnique) Creates a unique application/client identifier.
protected List<ReceptionCallback<?>>	getCallback(String stream) The callback for a certain stream.
protected TransportParameter.CloseAction	getCloseAction() Returns the close action.
static String	getKeystorePassword(String keystorePassword) Tries to resolve keystorePassword as key in IdentityStore using token data of a username token if found or keystorePassword as fallback.
static String	getKeystorePassword(TransportParameter params) Tries to resolve TransportParameter.getKeystorePassword() as key in IdentityStore using token data of a username token if found or TransportParameter.getKeystorePassword() as fallback.
protected TransportParameter	getTransportParameter() Returns the transport parameters.
protected boolean	isStreamKnown(String stream) Returns whether a stream name exists, irrespective of a registered callback.
protected <T> void	notifyCallback(String stream, byte[] data) Notifies the callback in stream based on received serialized data.
protected void	registerStream(String stream) Registers a stream name without callback.
protected <T> byte[]	serialize(String stream, T data) Serializes data to stream.
void	setReceptionCallback(String stream, ReceptionCallback<?> callback) Attaches a reception callback to stream.
void	unsubscribe(String stream, boolean delete) Unsubscribes from a channel implicitly subscribed with TransportConnector.setReceptionCallback(String, ReceptionCallback).

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.transport.connectors.TransportConnector

asyncSend, composeStreamName, enabledEncryption, getName, supportedEncryption, syncSend

Field Detail

callbacks

private Map<String,List<ReceptionCallback<?>>> callbacks

params

private TransportParameter params

Constructor Detail

AbstractTransportConnector

public AbstractTransportConnector()

Method Detail

getKeystorePassword

public static String getKeystorePassword(TransportParameter params)

Tries to resolve TransportParameter.getKeystorePassword() as key in IdentityStore using token data of a username token if found or TransportParameter.getKeystorePassword() as fallback.

Parameters:

params - the transport parameter to return the keystore password for

Returns:

the keystore password, either from IdentityStore or as fallback from params

getKeystorePassword

public static String getKeystorePassword(String keystorePassword)

Tries to resolve keystorePassword as key in IdentityStore using token data of a username token if found or keystorePassword as fallback.

Parameters:

keystorePassword - the transport parameter to return the keystore password for

Returns:

the keystore password, either from IdentityStore or as fallback from params

applyAuthenticationKey

public static boolean applyAuthenticationKey(String authenticationKey,
                                             AbstractTransportConnector.AuthenticationConsumer consumer)

Tries to apply the given authentication key to the given consumer.

Parameters:

authenticationKey - the authentication key

consumer - the consumer

Returns:

true for applied, false for ignored/failed

setReceptionCallback

public void setReceptionCallback(String stream,
                                 ReceptionCallback<?> callback)
                          throws IOException

Description copied from interface: TransportConnector

Attaches a reception callback to stream. The callback is called upon a reception. Implicitly subscribes to channel.

Specified by:

setReceptionCallback in interface TransportConnector

Parameters:

stream - the stream to attach the reception to

callback - the callback to attach

Throws:

IOException - in case that problems during registering the callback (e.g., during subscription) happens

detachReceptionCallback

public void detachReceptionCallback(String stream,
                                    ReceptionCallback<?> callback)
                             throws IOException

Description copied from interface: TransportConnector

Detaches a reception callback to stream.

Specified by:

detachReceptionCallback in interface TransportConnector

Parameters:

stream - the stream to detach the reception callback from

callback - the callback to detach

Throws:

IOException - in case that problems during detaching the callback

connect

public void connect(TransportParameter params)
             throws IOException

Description copied from interface: TransportConnector

Connects the underlying connections.

Specified by:

connect in interface TransportConnector

Parameters:

params - the parameters to start the underlying connection

Throws:

IOException - in case that problems during the connection happens

unsubscribe

public void unsubscribe(String stream,
                        boolean delete)
                 throws IOException

Description copied from interface: TransportConnector

Unsubscribes from a channel implicitly subscribed with TransportConnector.setReceptionCallback(String, ReceptionCallback).

Specified by:

unsubscribe in interface TransportConnector

Parameters:

stream - the stream to unsubscribe from

delete - if true, try to delete/clean up the communication side on the server (may not be supported by the implementing connector, is ignored then)

Throws:

IOException - if the action fails for some reason

disconnect

public void disconnect()
                throws IOException

Description copied from interface: TransportConnector

Disconnects the underlying connections. Unsubscribes on all known subscribed depending on TransportParameter.getCloseAction().

Specified by:

disconnect in interface TransportConnector

Throws:

IOException - in case that problems during the disconnect happens

getTransportParameter

protected TransportParameter getTransportParameter()

Returns the transport parameters.

Returns:

the parameters

getActionTimeout

protected int getActionTimeout()

Returns the timeout for individual send/receive actions.

Returns:

the timeout in milliseconds

getCloseAction

protected TransportParameter.CloseAction getCloseAction()

Returns the close action.

Returns:

the close action

getApplicationId

protected String getApplicationId()

The unique application/client identifier. Considers TransportParameter.getApplicationId() and TransportParameter.getAutoApplicationId().

Returns:

the client identifier

getApplicationId

public static String getApplicationId(String applicationId,
                                      String infix,
                                      boolean makeUnique)

Creates a unique application/client identifier.

Parameters:

applicationId - the basic application id (may be null, turned to an empty string then)

infix - an optional infix to be appended to applicationId (may be null, turned to an empty string then)

makeUnique - make unique or just compose given information

Returns:

the client identifier

getCallback

protected List<ReceptionCallback<?>> getCallback(String stream)

The callback for a certain stream.

Parameters:

stream - the stream to return the callback for

Returns:

the callback (may be null for none)

registerStream

protected void registerStream(String stream)

Registers a stream name without callback. A callback may be registered later.

Parameters:

stream - the name of the stream

isStreamKnown

protected boolean isStreamKnown(String stream)

Returns whether a stream name exists, irrespective of a registered callback.

Parameters:

stream - the stream name to look for

Returns:

true if the stream is known, false else

notifyCallback

protected <T> void notifyCallback(String stream,
                                  byte[] data)

Notifies the callback in stream based on received serialized data.

Type Parameters:

T - the type of data

Parameters:

stream - the stream to notify the callback for

data - the received serialized data

serialize

protected <T> byte[] serialize(String stream,
                               T data)
                        throws IOException

Serializes data to stream. [helper]

Type Parameters:

T - the type of the data

Parameters:

stream - the stream to serialize to

data - the data to serialize

Returns:

the serialized bytes

Throws:

IOException - in case that problems occur during serialization