de.iip_ecosphere.platform.connectors.aas

Class AasConnector<CO,CI>

java.lang.Object

de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

de.iip_ecosphere.platform.connectors.aas.AasConnector<CO,CI>

Type Parameters:

CO - the output type to the IIP-Ecosphere platform

CI - the input type from the IIP-Ecosphere platform

All Implemented Interfaces:

de.iip_ecosphere.platform.connectors.Connector<Object,Object,CO,CI>, de.iip_ecosphere.platform.connectors.model.AbstractModelAccess.NotificationChangedListener

@MachineConnector(hasModel=true,
                  supportsModelStructs=false,
                  supportsEvents=false)
public class AasConnector<CO,CI>
extends de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

A generic Asset Administration Shell connector. We use hierarchical names to identify sub-models and elements within. Requires the the registry URL part, e.g. "registry" in ConnectorParameter.getEndpointPath(). The ConnectorParameter.getApplicationId() denotes the AASs to operate on. If the application id is

1. a non-wildcard string, the uniquely denoted AAS is used for reading and writing/calling.
2. a wildcard string in Java String Regex format, the denoted AAS are used for reading. AAS names are updated during polling. Currently, only the first matching AAS is enabled for writing/calling.

If the application id starts with a known AAS identifier schema, the id is parsed into that and utilized to obtain the AAS, e.g., iri:urn:... Without, the connector tries to obtain a registry based on an AAS short id, which currently may fail.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AasConnector.AasModelAccess Implements the model access for AAS.
static class	AasConnector.Descriptor The descriptor of this connector (see META-INF/services).

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,de.iip_ecosphere.platform.support.aas.Aas>	connectedAAS
private static Object	DUMMY
private de.iip_ecosphere.platform.support.aas.AasFactory	factory
private AtomicBoolean	inPolling
private static org.slf4j.Logger	LOGGER
private String	nonPollingAas
private de.iip_ecosphere.platform.connectors.ConnectorParameter	params
private Pattern	pattern
private String	pollingAas
private Thread	pollingThread
private de.iip_ecosphere.platform.support.aas.Registry	registry

Constructor Summary

Constructors

Constructor and Description
AasConnector(de.iip_ecosphere.platform.support.aas.AasFactory factory, de.iip_ecosphere.platform.connectors.AdapterSelector<Object,Object,CO,CI> selector, de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter) Creates an instance and installs the protocol adapter.
AasConnector(de.iip_ecosphere.platform.support.aas.AasFactory factory, de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter) Creates an instance and installs the protocol adapter.
AasConnector(de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter) Creates an instance and installs the protocol adapter.

Method Summary

Modifier and Type	Method and Description
protected void	connectImpl(de.iip_ecosphere.platform.connectors.ConnectorParameter params)
protected void	disconnectImpl()
void	dispose()
protected void	doPolling()
String	enabledEncryption()
protected void	error(String message, Throwable th)
String	getName()
protected Object	read()
String	supportedEncryption()
private boolean	updateAas() Updates the AAS.
protected void	writeImpl(Object data)

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

configureModelAccess, connect, disconnect, enableNotifications, enablePolling, getConnectorInputType, getConnectorOutputType, getConnectorParameter, getProtocolInputType, getProtocolOutputType, getSelector, initializeModelAccess, installPollTask, isPolling, notificationsChanged, received, received, request, setReceptionCallback, uninstallPollTask, write

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

DUMMY

private static final Object DUMMY

connectedAAS

private Map<String,de.iip_ecosphere.platform.support.aas.Aas> connectedAAS

factory

private de.iip_ecosphere.platform.support.aas.AasFactory factory

params

private de.iip_ecosphere.platform.connectors.ConnectorParameter params

pattern

private Pattern pattern

registry

private de.iip_ecosphere.platform.support.aas.Registry registry

inPolling

private AtomicBoolean inPolling

pollingAas

private transient String pollingAas

pollingThread

private transient Thread pollingThread

nonPollingAas

private String nonPollingAas

Constructor Detail

AasConnector

@SafeVarargs
public AasConnector(de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter)

Creates an instance and installs the protocol adapter.

Parameters:

adapter - the protocol adapter

Throws:

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

AasConnector

@SafeVarargs
public AasConnector(de.iip_ecosphere.platform.support.aas.AasFactory factory,
                                 de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter)

Creates an instance and installs the protocol adapter.

Parameters:

factory - define the AasFactory to use, if null use AasFactory.getInstance()

adapter - the protocol adapter(s)

Throws:

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

AasConnector

@SafeVarargs
public AasConnector(de.iip_ecosphere.platform.support.aas.AasFactory factory,
                                 de.iip_ecosphere.platform.connectors.AdapterSelector<Object,Object,CO,CI> selector,
                                 de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<Object,Object,CO,CI>... adapter)

Creates an instance and installs the protocol adapter.

Parameters:

factory - define the AasFactory to use, if null use AasFactory.getInstance()

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

Method Detail

connectImpl

protected void connectImpl(de.iip_ecosphere.platform.connectors.ConnectorParameter params)
                    throws IOException

Specified by:

connectImpl in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

Throws:

IOException

updateAas

private boolean updateAas()

Updates the AAS.

Returns:

true if new AAS were added, false else

doPolling

protected void doPolling()

Overrides:

doPolling in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

disconnectImpl

protected void disconnectImpl()
                       throws IOException

Specified by:

disconnectImpl in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

Throws:

IOException

dispose

public void dispose()

getName

public String getName()

writeImpl

protected void writeImpl(Object data)
                  throws IOException

Specified by:

writeImpl in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

Throws:

IOException

read

protected Object read()
               throws IOException

Specified by:

read in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

Throws:

IOException

error

protected void error(String message,
                     Throwable th)

Specified by:

error in class de.iip_ecosphere.platform.connectors.AbstractConnector<Object,Object,CO,CI>

supportedEncryption

public String supportedEncryption()

enabledEncryption

public String enabledEncryption()