test.de.iip_ecosphere.platform.connectors

Class AbstractSerializingConnectorTest

java.lang.Object

test.de.iip_ecosphere.platform.connectors.AbstractSerializingConnectorTest

public abstract class AbstractSerializingConnectorTest
extends Object

Generic re-usable test for serializing connectors, i.e., internal byte[] types.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractSerializingConnectorTest.ConnectorParameterConfigurer Allows to configure the connector parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CMD_CHANNEL
private static String	PROD_CHANNEL

Constructor Summary

Constructors

Constructor and Description
AbstractSerializingConnectorTest()

Method Summary

Modifier and Type	Method and Description
protected abstract de.iip_ecosphere.platform.transport.connectors.TransportParameter.TransportParameterBuilder	configureTransportParameter(de.iip_ecosphere.platform.transport.connectors.TransportParameter.TransportParameterBuilder builder) Configures the transport parameters used to connect the instance from createConnector(ChannelProtocolAdapter).
protected abstract de.iip_ecosphere.platform.connectors.Connector<byte[],byte[],test.de.iip_ecosphere.platform.transport.Product,test.de.iip_ecosphere.platform.transport.Command>	createConnector(de.iip_ecosphere.platform.connectors.types.ChannelProtocolAdapter<byte[],byte[],test.de.iip_ecosphere.platform.transport.Product,test.de.iip_ecosphere.platform.transport.Command> adapter) Creates the connector to be tested.
protected de.iip_ecosphere.platform.connectors.ConnectorParameter	createConnectorParameter(de.iip_ecosphere.platform.support.ServerAddress addr, AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer) Creates the coonnector parameter instance.
protected abstract de.iip_ecosphere.platform.support.Server	createTestServer(de.iip_ecosphere.platform.support.ServerAddress addr, File configDir) Creates the test server to test against.
protected abstract de.iip_ecosphere.platform.transport.connectors.TransportConnector	createTransportConnector() Returns the transport connector to test against behind the test server.
protected de.iip_ecosphere.platform.transport.connectors.TransportParameter	createTransportParameter(de.iip_ecosphere.platform.support.ServerAddress addr, test.de.iip_ecosphere.platform.transport.AbstractTransportConnectorTest.TransportParameterConfigurer configurer) Creates the transport parameter instance.
protected void	doTest(de.iip_ecosphere.platform.support.ServerAddress addr, AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer) Implements a MQTT connector test.
protected abstract AbstractSerializingConnectorTest.ConnectorParameterConfigurer	getConfigurer() Returns the test configurer (for TLS tests).
protected abstract Class<? extends de.iip_ecosphere.platform.connectors.ConnectorDescriptor>	getConnectorDescriptor() Returns the connector descriptor for createConnector(ChannelProtocolAdapter).
protected abstract boolean	implementsEncryption() Returns whether the connector implementation supports encryption.
void	testConnector() Tests the connector through explicitly setting/resetting the factory implementation.
private void	testEnc(de.iip_ecosphere.platform.connectors.Connector<?,?,?,?> connector, AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer, boolean connected) Tests encryption statements of connector, i.e., Connector.supportedEncryption() and Connector.enabledEncryption().
void	testTlsConnector() Tests the TLS connector through explicitly setting/resetting the factory implementation.

Methods inherited from class java.lang.Object

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

Field Detail

CMD_CHANNEL

private static final String CMD_CHANNEL

See Also:

Constant Field Values

PROD_CHANNEL

private static final String PROD_CHANNEL

See Also:

Constant Field Values

Constructor Detail

AbstractSerializingConnectorTest

public AbstractSerializingConnectorTest()

Method Detail

createConnector

protected abstract de.iip_ecosphere.platform.connectors.Connector<byte[],byte[],test.de.iip_ecosphere.platform.transport.Product,test.de.iip_ecosphere.platform.transport.Command> createConnector(de.iip_ecosphere.platform.connectors.types.ChannelProtocolAdapter<byte[],byte[],test.de.iip_ecosphere.platform.transport.Product,test.de.iip_ecosphere.platform.transport.Command> adapter)

Creates the connector to be tested.

Parameters:

adapter - the protocol adapter used to create the connector

Returns:

the connector instance

getConnectorDescriptor

protected abstract Class<? extends de.iip_ecosphere.platform.connectors.ConnectorDescriptor> getConnectorDescriptor()

Returns the connector descriptor for createConnector(ChannelProtocolAdapter).

Returns:

the connector descriptor

createTestServer

protected abstract de.iip_ecosphere.platform.support.Server createTestServer(de.iip_ecosphere.platform.support.ServerAddress addr,
                                                                             File configDir)

Creates the test server to test against.

Parameters:

addr - the server address (schema may be ignored)

configDir - specific configuration directory for this test server, may be null for none

Returns:

the server instance

createTransportConnector

protected abstract de.iip_ecosphere.platform.transport.connectors.TransportConnector createTransportConnector()

Returns the transport connector to test against behind the test server.

Returns:

the transport connector

configureTransportParameter

protected abstract de.iip_ecosphere.platform.transport.connectors.TransportParameter.TransportParameterBuilder configureTransportParameter(de.iip_ecosphere.platform.transport.connectors.TransportParameter.TransportParameterBuilder builder)

Configures the transport parameters used to connect the instance from createConnector(ChannelProtocolAdapter).

Parameters:

builder - the parameter builder

Returns:

builder

testConnector

public void testConnector()
                   throws IOException

Tests the connector through explicitly setting/resetting the factory implementation. Builds up a Server based on #createTestServer(ServerAddress) that the test is self-contained.

Throws:

IOException - in case that connection/communication fails

testTlsConnector

public void testTlsConnector()
                      throws IOException

Tests the TLS connector through explicitly setting/resetting the factory implementation. Builds up a Server based on #createTestServer(ServerAddress) that the test is self-contained.

Throws:

IOException - in case that connection/communication fails

See Also:

getConfigurer()

getConfigurer

protected abstract AbstractSerializingConnectorTest.ConnectorParameterConfigurer getConfigurer()

Returns the test configurer (for TLS tests).

Returns:

the test configurer, may be null for none, i.e., no TLS tests

implementsEncryption

protected abstract boolean implementsEncryption()

Returns whether the connector implementation supports encryption.

Returns:

true for supported, false for not supported

createConnectorParameter

protected de.iip_ecosphere.platform.connectors.ConnectorParameter createConnectorParameter(de.iip_ecosphere.platform.support.ServerAddress addr,
                                                                                           AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer)

Creates the coonnector parameter instance.

Parameters:

addr - the server address (schema is ignored)

configurer - the parameter configurer, may be null for none

Returns:

the transport parameter

createTransportParameter

protected de.iip_ecosphere.platform.transport.connectors.TransportParameter createTransportParameter(de.iip_ecosphere.platform.support.ServerAddress addr,
                                                                                                     test.de.iip_ecosphere.platform.transport.AbstractTransportConnectorTest.TransportParameterConfigurer configurer)

Creates the transport parameter instance. Uses #configureTransportParameter(TransportParameterBuilder) for basic, test-wide configuration.

Parameters:

addr - the server address (schema is ignored)

configurer - the parameter configurer, may be null for none

Returns:

the transport parameter

doTest

protected void doTest(de.iip_ecosphere.platform.support.ServerAddress addr,
                      AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer)
               throws IOException

Implements a MQTT connector test.

Parameters:

addr - the server address (schema is ignored)

configurer - the parameter configurer, may be null for none

Throws:

IOException - in case that connection/communication fails

testEnc

private void testEnc(de.iip_ecosphere.platform.connectors.Connector<?,?,?,?> connector,
                     AbstractSerializingConnectorTest.ConnectorParameterConfigurer configurer,
                     boolean connected)

Tests encryption statements of connector, i.e., Connector.supportedEncryption() and Connector.enabledEncryption().

Parameters:

connector - the connector instance to test

configurer - the configurer indicating whether encryption shall be activated if connected

connected - whether the connector is supposed to be connected