de.iip_ecosphere.platform.connectors.opcuav1

Class OpcUaConnector<CO,CI>

java.lang.Object

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

de.iip_ecosphere.platform.connectors.opcuav1.OpcUaConnector<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<DataItem,Object,CO,CI>, de.iip_ecosphere.platform.connectors.model.AbstractModelAccess.NotificationChangedListener

@MachineConnector
public class OpcUaConnector<CO,CI>
extends de.iip_ecosphere.platform.connectors.AbstractConnector<DataItem,Object,CO,CI>

Implements the generic OPC UA connector. Do not rename, this class is referenced in META-INF/services. For custom types such as structs, the following must apply:

• A class implements the datatype and its fields.
• The class declares an accessible static field named BINARY_ENCODING_ID of type ExpandedNodeId.
• The class declares a top-level inner class called "Codec" of type GenericDataTypeCodec having an accessible no-arg constructor.
• Value constructor parameters and accessors shall be based on Java types rather than OPC/Milo types
• Such custom types must be registered through ModelAccess.registerCustomType(Class) in ConnectorOutputTypeTranslator.initializeModelAccess().

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpcUaConnector.Descriptor The descriptor of this connector (see META-INF/services).
private class	OpcUaConnector.FallbackIdentityProder A fallback identity provider.
private static class	OpcUaConnector.NodeCacheEntry Realizes a node cache entry with value lifetime.
protected class	OpcUaConnector.OpcUaModelAccess Implements the model access for OPC UA.

Field Summary

Fields

Modifier and Type	Field and Description
private org.eclipse.milo.opcua.sdk.client.OpcUaClient	client
private static DataItem	DUMMY
private static String	FIELD_BINARY_ENCODING_ID
private static org.slf4j.Logger	LOGGER
static String	NAME The name of this connector.
private de.iip_ecosphere.platform.connectors.ConnectorParameter	params
static char	SEPARATOR_CHAR Denotes the path separator for qualified model names.
static String	SEPARATOR_STRING Denotes the path separator for qualified model names (as String).
static String	TOP_OBJECTS Denotes the top-level folder "Objects".
static String	TOP_TYPES Denotes the top-level folder "Types".
static String	TOP_VIEWS Denotes the top-level folder "Views".

Constructor Summary

Constructors

Constructor and Description
OpcUaConnector(de.iip_ecosphere.platform.connectors.AdapterSelector<DataItem,Object,CO,CI> selector, de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<DataItem,Object,CO,CI>... adapter) Creates an instance and installs the protocol adapter(s).
OpcUaConnector(de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<DataItem,Object,CO,CI>... adapter) Creates an instance and installs the protocol adapter(s).

Method Summary

Modifier and Type	Method and Description
private org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfigBuilder	configure(org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfigBuilder configBuilder) Does the basic configuration of the OPC UA client.
protected void	connectImpl(de.iip_ecosphere.platform.connectors.ConnectorParameter params)
protected void	disconnectImpl()
void	dispose()
String	enabledEncryption()
protected Predicate<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription>	endpointFilter(de.iip_ecosphere.platform.connectors.ConnectorParameter params) Provides a filter for OPC UA endpoints in case that multiple are present.
protected void	error(String message, Throwable th)
private String	getEndpointUrl(de.iip_ecosphere.platform.connectors.ConnectorParameter params) Construct the endpoint URL.
protected org.eclipse.milo.opcua.sdk.client.api.identity.IdentityProvider	getIdentityProvider(de.iip_ecosphere.platform.connectors.ConnectorParameter params) Returns the identity provider by translating the token information in params to Milo specific token information.
private de.iip_ecosphere.platform.support.identities.IdentityToken	getIdToken(String endpointUrl) Returns the id token for an endpoint URL considering ConnectorParameter.ANY_ENDPOINT.
String	getName()
protected DataItem	read()
String	supportedEncryption()
protected void	writeImpl(Object data)

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

configureModelAccess, connect, disconnect, doPolling, 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

NAME

public static final String NAME

The name of this connector.

See Also:

Constant Field Values

TOP_OBJECTS

public static final String TOP_OBJECTS

Denotes the top-level folder "Objects".

See Also:

Constant Field Values

TOP_TYPES

public static final String TOP_TYPES

Denotes the top-level folder "Types".

See Also:

Constant Field Values

TOP_VIEWS

public static final String TOP_VIEWS

Denotes the top-level folder "Views".

See Also:

Constant Field Values

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

Denotes the path separator for qualified model names.

See Also:

Constant Field Values

SEPARATOR_STRING

public static final String SEPARATOR_STRING

Denotes the path separator for qualified model names (as String).

See Also:

Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

DUMMY

private static final DataItem DUMMY

FIELD_BINARY_ENCODING_ID

private static final String FIELD_BINARY_ENCODING_ID

See Also:

Constant Field Values

client

private org.eclipse.milo.opcua.sdk.client.OpcUaClient client

params

private de.iip_ecosphere.platform.connectors.ConnectorParameter params

Constructor Detail

OpcUaConnector

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

Creates an instance and installs the protocol adapter(s).

Parameters:

adapter - the protocol adapter(s)

Throws:

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

OpcUaConnector

@SafeVarargs
public OpcUaConnector(de.iip_ecosphere.platform.connectors.AdapterSelector<DataItem,Object,CO,CI> selector,
                                   de.iip_ecosphere.platform.connectors.types.ProtocolAdapter<DataItem,Object,CO,CI>... adapter)

Creates an instance and installs the protocol adapter(s).

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

Method Detail

getEndpointUrl

private String getEndpointUrl(de.iip_ecosphere.platform.connectors.ConnectorParameter params)

Construct the endpoint URL.

Parameters:

params - the connector parameters

Returns:

the endpoint URL

connectImpl

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

Specified by:

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

Throws:

IOException

endpointFilter

protected Predicate<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription> endpointFilter(de.iip_ecosphere.platform.connectors.ConnectorParameter params)

Provides a filter for OPC UA endpoints in case that multiple are present.

Parameters:

params - the connector parameters

Returns:

the endpoint filter

configure

private org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfigBuilder configure(org.eclipse.milo.opcua.sdk.client.api.config.OpcUaClientConfigBuilder configBuilder)

Does the basic configuration of the OPC UA client.

Parameters:

configBuilder - the configuration builder

Returns:

configBuilder

getIdToken

private de.iip_ecosphere.platform.support.identities.IdentityToken getIdToken(String endpointUrl)

Returns the id token for an endpoint URL considering ConnectorParameter.ANY_ENDPOINT.

Parameters:

endpointUrl - the endpoint URL

Returns:

the identity token

getIdentityProvider

protected org.eclipse.milo.opcua.sdk.client.api.identity.IdentityProvider getIdentityProvider(de.iip_ecosphere.platform.connectors.ConnectorParameter params)

Returns the identity provider by translating the token information in params to Milo specific token information.

Parameters:

params - the connector params

Returns:

the identity provider

disconnectImpl

protected void disconnectImpl()
                       throws IOException

Specified by:

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

Throws:

IOException

getName

public String getName()

dispose

public void dispose()

writeImpl

protected void writeImpl(Object data)
                  throws IOException

Specified by:

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

Throws:

IOException

read

protected DataItem read()
                 throws IOException

Specified by:

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

Throws:

IOException

error

protected void error(String message,
                     Throwable th)

Specified by:

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

supportedEncryption

public String supportedEncryption()

enabledEncryption

public String enabledEncryption()