com.prosysopc.ua.client

Class UaLoopbackClient

java.lang.Object

com.prosysopc.ua.UaApplication

com.prosysopc.ua.client.UaClient

com.prosysopc.ua.client.UaLoopbackClient

public class UaLoopbackClient
extends UaClient

UaClient, that directly sends service calls (inside java) to an UaServer instance. Instances of this class are only designed to be instantiated by the SDK and constructors of this class can change at will. Methods related to connecting and connection parameters shall not be called and are marked as Deprecated (as this client is always "connected"). All operations performed by this client is equal to the Session.INTERNAL_SESSION of the server, i.e. there is no "user" per se, but in practice this means this client can access anything in the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaLoopbackClient.InternalEndpointServiceRequest Internal, but used from multiple packages.

Nested classes/interfaces inherited from class com.prosysopc.ua.UaApplication

UaApplication.DiagnosticMask, UaApplication.Protocol

Field Summary

Fields inherited from class com.prosysopc.ua.client.UaClient

MAX_CACHE_AGE

Constructor Summary

Constructors

Constructor and Description
UaLoopbackClient(UaServer server, Consumer<EndpointServiceRequest<?,?>> requestConsumer) Internal (but used from other packages, thus public).

Method Summary

Modifier and Type	Method and Description
void	connect() Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.
protected ServiceContext	createServiceContext(ServiceRequest<ServiceResponse> request) Create a ServiceContext for the given request.
void	disconnect() Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.
void	disconnect(long timeout) Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.
void	disconnect(long timeout, TimeUnit timeUnit) Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.
void	disconnect(UnsignedInteger timeout) Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.
OperationLimits	getActualOperationLimits() Returns the actual operation limits i.e.
ApplicationIdentity	getApplicationIdentity() Deprecated. use UaServer.getApplicationIdentity() instead directly.
EncoderContext	getEncoderContext()
NamespaceTable	getNamespaceTable() The server NamespaceTable.
NamespaceTable	getNamespaceTable(boolean forceRefresh) The server NamespaceTable.
SecurityMode	getSecurityMode() Deprecated. concept doesn't apply.
ServerStatusDataType	getServerStatus() The status of the server that we are connected.
UserIdentity	getUserIdentity() Deprecated. UaLoopbackClient identity is equals to Session.INTERNAL_SESSION.
boolean	hasConnected() The UaLoopbackClient is always connected, always returns true.
boolean	hasConnection() The UaLoopbackClient is always connected, always returns true.
boolean	isAutoReconnect() Automatic reconnection setting.
boolean	isConnected() Deprecated. use hasConnection() or hasConnected() instead.
void	setAddress(String address) Deprecated.
void	setAddress(UaAddress address) Deprecated.
void	setEndpoint(EndpointDescription endpoint) Deprecated.
void	setReverseAddress(UaAddress clientListenAddress) Deprecated.
void	setSecurityMode(SecurityMode securityMode) Deprecated.
void	setUri(String uri) Deprecated.
void	setUserIdentity(UserIdentity userIdentity) Deprecated. UaLoopbackClient identity is equals to Session.INTERNAL_SESSION.
void	start()
void	stop()

Methods inherited from class com.prosysopc.ua.client.UaClient

addServerStatusListener, addSubscription, addSubscriptionAck, call, call, callAsync, discoverEndpoints, discoverEndpoints, getActualPublishRequestSetpoint, getAddress, getAddressSpace, getAuditEntryId, getCommErrorCodes, getConnectTimeout, getDefaultMaxAge, getDefaultProtocol, getDefaultTimestampsToReturn, getEndpoint, getEndpointConfiguration, getHost, getHttpsSecurityPolicies, getHttpsSettings, getLastOperationDiagnostics, getLastResponseTimestamp, getLastServiceDiagnostics, getLastServiceResult, getListener, getLocale, getMaxResponseMessageSize, getOperationDiagnosticMask, getPort, getProtocol, getPublishRequestFactor, getPublishRequestSetpoint, getPublishRequestTimeout, getReverseAddress, getReverseConnectionListener, getSecureChannel, getServerIdentity, getServerName, getServerState, getServerStatusError, getServerTable, getServerTable, getServerTimeDifference, getServiceDiagnosticMask, getSession, getSessionName, getSessionTimeout, getSocketFactory, getStatusCheckInterval, getStatusCheckTimeout, getSubscription, getSubscriptionById, getSubscriptionCount, getSubscriptions, getSupportedSecurityModes, getSupportedUserIdentityTokens, getTimeout, getTypeDictionary, getUri, hasServerStatusListener, hasSubscription, historyDeleteAtTimes, historyDeleteEvents, historyDeleteModified, historyDeleteRaw, historyRead, historyReadAsync, historyReadAtTimes, historyReadAtTimes, historyReadAtTimes, historyReadEvents, historyReadEvents, historyReadModified, historyReadModified, historyReadProcessed, historyReadProcessed, historyReadRaw, historyReadRaw, historyReadRaw, historyUpdate, historyUpdateAsync, historyUpdateData, historyUpdateEvent, historyUpdateStructureData, isInitTypeDictionaryAutoUsage, isInitTypeDictionaryOnConnect, isInitTypeDictionaryShallow, isInReverseMode, isKeepSubscriptions, isUseCommErrorCodes, isValidateCreateSessionResponseCert, isValidateDiscoveredEndpoints, isValidateNonceLength, read, readAsync, readAttribute, readAttribute, readAttribute, readAttribute, readAttribute, readAttribute, readAttributes, readAttributes, readAttributes, readAttributes, readAttributes, readAttributes, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, readValues, reconnect, registerModel, removeServerStatusListener, removeSubscription, removeSubscriptions, removeSubscriptionsAsync, resetEndpoint, resetPublishRequestSetpoint, resetSubscriptionsAfterRemove, resolveConnectionAddress, serviceRequest, serviceRequestAsync, sessionlessRequest, setApplicationIdentity, setAuditEntryId, setAutoReconnect, setConnectTimeout, setConnectTimeout, setDefaultMaxAge, setDefaultProtocol, setDefaultTimestampsToReturn, setHttpsSecurityPolicies, setInitTypeDictionaryAutoUsage, setInitTypeDictionaryOnConnect, setInitTypeDictionaryShallow, setKeepSubscriptions, setListener, setLocale, setMaxResponseMessageSize, setMaxResponseMessageSize, setOperationDiagnosticMask, setPublishRequestFactor, setPublishRequestSetpoint, setPublishRequestTimeout, setPublishRequestTimeout, setPublishRequestTimeout, setReverseConnectionListener, setReversePort, setServiceDiagnosticMask, setSessionName, setSessionTimeout, setSessionTimeout, setSocketFactory, setStatusCheckInterval, setStatusCheckInterval, setStatusCheckTimeout, setStatusCheckTimeout, setTimeout, setTimeout, setTimeout, setUseCommErrorCodes, setValidateCreateSessionResponseCert, setValidateDiscoveredEndpoints, setValidateNonceLength, updateServerStatus, validateServiceRequest, write, writeAsync, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeAttribute, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue, writeValue, writeValues, writeValues, writeValues, writeValues, writeValues, writeValues

Methods inherited from class com.prosysopc.ua.UaApplication

formatUri, getAggregateCalculator, getCertificateValidator, getKnownDataTypeDictionary, getOperationLimits, getRegisteredClasses, getSdkVersion, getVersion, isAutoDiscoverCodegenModels, registerAutoDiscoveredModels, registerModelInternal, setAutoDiscoverCodegenModels, setCertificateValidator, setOperationLimits, validateApplicationCertificate

Methods inherited from class java.lang.Object

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

Constructor Detail

UaLoopbackClient

public UaLoopbackClient(UaServer server,
                        Consumer<EndpointServiceRequest<?,?>> requestConsumer)

Internal (but used from other packages, thus public).

Method Detail

connect

@Deprecated
public void connect()
                          throws ServiceException,
                                 ConnectException,
                                 SessionActivationException,
                                 InvalidServerEndpointException

Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.

Do not use.

Overrides:

connect in class UaClient

Throws:

ServiceException - if there are service call errors while discovering the endpoints or adding the subscriptions to the server. Note that all the exceptions below are also subclasses of ServiceException.

ConnectException - if the connection fails

SessionActivationException - if the session cannot be activated with the UserIdentity

InvalidServerEndpointException - If the server endpoint defined by the parameters is not found from the servers list of supported endpoints

disconnect

@Deprecated
public void disconnect()

Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.

Do not use.

Overrides:

disconnect in class UaClient

disconnect

@Deprecated
public void disconnect(long timeout)

Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.

Do not use.

Overrides:

disconnect in class UaClient

Parameters:

timeout - timeout (in milliseconds) for the CloseSession call. Must be a positive value. 0 tells it to wait infinitely for a response.

disconnect

@Deprecated
public void disconnect(long timeout,
                                    TimeUnit timeUnit)

Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.

Do not use.

Overrides:

disconnect in class UaClient

See Also:

UaClient.disconnect(long)

disconnect

@Deprecated
public void disconnect(UnsignedInteger timeout)

Deprecated. UaLoopbackClient cannot be connected or disconnected, it is always connected.

Do not use.

Overrides:

disconnect in class UaClient

Parameters:

timeout - timeout (in milliseconds) for the CloseSession call. UnsignedInteger.ZERO tells it to wait infinitely for a response.

getActualOperationLimits

public OperationLimits getActualOperationLimits()

Description copied from class: UaClient

Returns the actual operation limits i.e. the minimum of client and server limits calculated during connect, before that returns same as UaApplication.getOperationLimits().

Overrides:

getActualOperationLimits in class UaClient

getApplicationIdentity

@Deprecated
public ApplicationIdentity getApplicationIdentity()

Deprecated. use UaServer.getApplicationIdentity() instead directly.

This method returns the ApplicationIdentity of the server.

Overrides:

getApplicationIdentity in class UaClient

Returns:

the current identity of the client application. Use UaClient.setApplicationIdentity(com.prosysopc.ua.ApplicationIdentity) to define it, before connecting to the server.

getEncoderContext

public EncoderContext getEncoderContext()

Overrides:

getEncoderContext in class UaClient

Returns:

the encoder context, which is used for mapping namespaces and nodeIds in the stack layer.

getNamespaceTable

public NamespaceTable getNamespaceTable()

Description copied from class: UaClient

The server NamespaceTable. Use the NamespaceTable to convert between NodeId and ExpandedNodeId and to find the list of namespaces that the server uses.

The table is requested from the server (from NodeId Server_NamespaceArray) when first accessed. Otherwise, it is returned from the cache. Use UaClient.getNamespaceTable(boolean) to force a refresh.

Overrides:

getNamespaceTable in class UaClient

Returns:

the namespaceTable

getNamespaceTable

public NamespaceTable getNamespaceTable(boolean forceRefresh)
                                 throws ServiceException,
                                        StatusException

Description copied from class: UaClient

The server NamespaceTable. Use the NamespaceTable to convert between NodeId and ExpandedNodeId and to find the list of namespaces that the server uses.

The table is requested from the server (from NodeId Server_NamespaceArray) when first accessed. It is available only when UaClient.isConnected is true.

Overrides:

getNamespaceTable in class UaClient

Parameters:

forceRefresh - request that the array is refreshed from the server, even if it has been read already

Returns:

the namespaceTable

Throws:

ServiceException - if the namespace array could not be read

StatusException - if the namespace array read from the server is not valid

getSecurityMode

@Deprecated
public SecurityMode getSecurityMode()

Deprecated. concept doesn't apply.

The SecurityMode doesn't apply to the loopback client as it directly sends the request to the UaServer object given as the constructor parameter. This method always returns SecurityMode.NONE.

Overrides:

getSecurityMode in class UaClient

Returns:

the current security mode used in communications.

getServerStatus

public ServerStatusDataType getServerStatus()
                                     throws StatusException,
                                            ServerConnectionException

Description copied from class: UaClient

The status of the server that we are connected. The status is updated every statusCheckInterval. Whenever it changes, you get a StatusChange event, which you can listen to. Or you can listen to StateChange, which is called whenever the server state changes.

Note that the status is only available when the client UaClient.hasConnected().

Note also that UaClient.getServerState() returns the State part of the status - also when the status cannot be read, so it is easier to use for plain state checking.

Overrides:

getServerStatus in class UaClient

Returns:

The current server status

Throws:

StatusException - if the server status could not be read from the server. Read the StatusCode of the exception to learn the reason for that. The same status is also available from ServerStatusError

ServerConnectionException - if we are not connected to the server, in which case the status is not available

See Also:

UaClient.getServerTimeDifference()

getUserIdentity

@Deprecated
public UserIdentity getUserIdentity()

Deprecated. UaLoopbackClient identity is equals to Session.INTERNAL_SESSION.

Do not use. This method returns null.

Overrides:

getUserIdentity in class UaClient

Returns:

the user identity used.

hasConnected

public boolean hasConnected()

The UaLoopbackClient is always connected, always returns true.

Overrides:

hasConnected in class UaClient

hasConnection

public boolean hasConnection()

The UaLoopbackClient is always connected, always returns true.

Overrides:

hasConnection in class UaClient

isAutoReconnect

public boolean isAutoReconnect()

Description copied from class: UaClient

Automatic reconnection setting. When true, the UaClient will try to reconnect automatically to the server, when communication fails.

Overrides:

isAutoReconnect in class UaClient

Returns:

the doAutoReconnect

isConnected

@Deprecated
public boolean isConnected()

Deprecated. use hasConnection() or hasConnected() instead.

Deprecated, use hasConnection() or hasConnected() instead.

Overrides:

isConnected in class UaClient

setAddress

@Deprecated
public void setAddress(String address)

Deprecated.

Description copied from class: UaClient

Define the connection address of the OPC UA server as a string.

The address identifies the OPC UA server that we try to connect to. The computer defined by Host of the address must be reachable. If DNS is not available, you can use the IP address of the computer instead.

You cannot change the address when UaClient.isConnected.

Equals to calling setAddress(UaAddress.parse(address));

Overrides:

setAddress in class UaClient

Parameters:

address - The connection address of the server. The address is expected to be in format '://:[/]'. See UaAddress.parse(java.lang.String) for details.

See Also:

UaClient.setAddress(UaAddress)

setAddress

@Deprecated
public void setAddress(UaAddress address)

Deprecated.

Description copied from class: UaClient

Define the connection address to the OPC UA server.

The address identifies the OPC UA server that we try to connect to. The computer defined by Host of the address must be reachable. If DNS is not available, you can use the IP address of the computer instead.

You cannot change the address after calling UaClient.connect(), that is when UaClient.isConnected.

Overrides:

setAddress in class UaClient

Parameters:

address - server address to connect to.

See Also:

UaClient.connect()

setEndpoint

@Deprecated
public void setEndpoint(EndpointDescription endpoint)

Deprecated.

Description copied from class: UaClient

Use the EndpointDescription to select the server endpoint to connect to.

Note: Must be not UaClient.hasConnected() when changing the endpoint.

Overrides:

setEndpoint in class UaClient

Parameters:

endpoint - the endpoint to use.

See Also:

UaClient.setAddress(java.lang.String)

setReverseAddress

@Deprecated
public void setReverseAddress(UaAddress clientListenAddress)

Deprecated.

Description copied from class: UaClient

Defines a client-side socket address for an OPC UA Reverse Connection.

When you call UaClient.connect(), the client will start listening to server-initiated connections at this address, according to the OPC UA Specification Part 6. The transport protocol must be 'opc.tcp' and ServerName should be empty. Naturally, the hostname must correspond to an actual hostname or IP address of the local machine.

If you do not want to specify the hostname and only wish to bind to all local addresses you can use UaClient.setReversePort(int) instead to set a wildcard address. Alternatively, you can create a wildcard address with UaAddress.wildcardOpcTcp(int)).

You can use UaClient.setReverseConnectionListener(ReverseConnectionListener) to define a custom handler that can validate that the incoming calls are coming from an expected server. If UaClient.getSecurityMode() defines a secure connection the server certificate must be trusted in order to enable the connection as well.

Overrides:

setReverseAddress in class UaClient

See Also:

UaClient.isInReverseMode(), UaClient.setReversePort(int), UaClient.setReverseConnectionListener(ReverseConnectionListener)

setSecurityMode

@Deprecated
public void setSecurityMode(SecurityMode securityMode)

Deprecated.

Description copied from class: UaClient

Define the security mode to connect to.

SecurityMode is a combination of MessageSecurityMode and SecurityPolicy. You can use the predefined constants in SecurityMode as a parameter instead of defining your own values.

You cannot change the setting when UaClient.isConnected.

Overrides:

setSecurityMode in class UaClient

Parameters:

securityMode - the new security mode

setUri

@Deprecated
public void setUri(String uri)

Deprecated.

Description copied from class: UaClient

The connection address of the OPC UA server. The URI is used to locate the server at UaClient.connect() call.

The server will be connected using the host name and port. It is then queried for endpoints and a suitable one will be picked, even when no exact match is found. In that case a warning message will be display in the log messages.

You cannot change the setting when UaClient.isConnected.

Overrides:

setUri in class UaClient

Parameters:

uri - The server URI to set.

setUserIdentity

@Deprecated
public void setUserIdentity(UserIdentity userIdentity)
                                  throws SessionActivationException

Deprecated. UaLoopbackClient identity is equals to Session.INTERNAL_SESSION.

Do not use.

Overrides:

setUserIdentity in class UaClient

Parameters:

userIdentity - the new identity. If null, the default, anonymous authentication is set

Throws:

SessionActivationException - if the session activation fails with the new identity

start

public void start()

stop

public void stop()

createServiceContext

protected ServiceContext createServiceContext(ServiceRequest<ServiceResponse> request)

Create a ServiceContext for the given request. By default this method return ServiceContext.INTERNAL_OPERATION_CONTEXT, but it can be overriden here, if needed.