com.prosysopc.ua

Class UaApplication

java.lang.Object

com.prosysopc.ua.UaApplication

Direct Known Subclasses:

UaClient, UaServer

public abstract class UaApplication
extends Object

A common base class for client and server applications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaApplication.DiagnosticMask Bits values used to mask the types of vendor-specific diagnostics.
static class	UaApplication.Protocol OPC UA transport protocol alternatives.

Constructor Summary

Constructors

Constructor and Description
UaApplication()

Method Summary

Modifier and Type	Method and Description
static String	formatUri(UaApplication.Protocol protocol, String host, int port, String serverName) Deprecated. Use UaAddress#formatUri(Protocol, String, int, String) instead
abstract UaAddressSpace	getAddressSpace()
AggregateCalculator	getAggregateCalculator()
abstract ApplicationIdentity	getApplicationIdentity() Returns the ApplicationIdentity of this UaApplication.
CertificateValidator	getCertificateValidator()
abstract EncoderContext	getEncoderContext()
DataTypeDictionary	getKnownDataTypeDictionary()
NamespaceTable	getNamespaceTable()
OperationLimits	getOperationLimits()
RegisteredClasses	getRegisteredClasses() Returns the RegisteredClasses object of the application.
static String	getSdkVersion()
abstract ServerTable	getServerTable() Returns the server's ServerTable (from node VariableIdentifiers.Server_ServerArray).
static String	getVersion() Deprecated. use getSdkVersion(), but note that it does not contain the "v" prefix
boolean	isAutoDiscoverCodegenModels() Returns true if CodegenModels should be discovered and registered automatically from classpath.
protected <T extends CodegenModelProvider> void	registerAutoDiscoveredModels(Class<T> clazz) Searches classpath for CodegenModels and registers them.
protected void	registerModelInternal(CodegenModel codegenModel) Register an information model to use in the application.
void	setAutoDiscoverCodegenModels(boolean autoDiscoverCodegenModels) If this is true, then the classpath is searched for CodegenModels and found models are registered automatically.
void	setCertificateValidator(CertificateValidator certificateValidator) Define a certificate validator that checks the server certificate after connect.
void	setOperationLimits(OperationLimits operationLimits) Define the operation limits for the application
protected StatusCode	validateApplicationCertificate(ApplicationIdentity applicationIdentity)

Methods inherited from class java.lang.Object

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

Constructor Detail

UaApplication

public UaApplication()

Method Detail

formatUri

@Deprecated
public static String formatUri(UaApplication.Protocol protocol,
                                            String host,
                                            int port,
                                            String serverName)

Deprecated. Use UaAddress#formatUri(Protocol, String, int, String) instead

Compose a valid OPCUA connection address from the parts. The address will be in the format <protocol>://<host>:<port>/<serverName>, where the last slash ('/') is removed, if serverName is empty.

Parameters:

protocol - The OPC UA transport protocol.

host - Host name or IP address of the computer to connect to.

port - The TCP port number to connect to.

serverName - An optional server name identifier.

Returns:

A string of the format <protocol>://<host>:<port>/<serverName>

getSdkVersion

public static String getSdkVersion()

Returns:

the version of the Prosys OPC UA SDK for Java in "%VERSION%" format.

getVersion

@Deprecated
public static String getVersion()

Deprecated. use getSdkVersion(), but note that it does not contain the "v" prefix

Returns:

the version of the Prosys OPC UA SDK for Java in "v%VERSION%" format.

getAddressSpace

public abstract UaAddressSpace getAddressSpace()

Returns:

the AddressSpace, which provides access to the UA nodes.

getAggregateCalculator

public AggregateCalculator getAggregateCalculator()

getApplicationIdentity

public abstract ApplicationIdentity getApplicationIdentity()

Returns the ApplicationIdentity of this UaApplication.

getCertificateValidator

public CertificateValidator getCertificateValidator()

Returns:

the current certificate validator.

getEncoderContext

public abstract EncoderContext getEncoderContext()

Returns:

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

getKnownDataTypeDictionary

public DataTypeDictionary getKnownDataTypeDictionary()

Returns:

The DataTypeDictionary of known types

getNamespaceTable

public NamespaceTable getNamespaceTable()

Returns:

the address space

getOperationLimits

public OperationLimits getOperationLimits()

Returns:

the operation limits that the application uses

getRegisteredClasses

public RegisteredClasses getRegisteredClasses()

Returns the RegisteredClasses object of the application.

getServerTable

public abstract ServerTable getServerTable()

Returns the server's ServerTable (from node VariableIdentifiers.Server_ServerArray). The indexes of the table are used if References of a node in the server points to another server via ExpandedNodeId.getServerIndex(). The index 0 always means the local server and has the local server's ApplicationUri

isAutoDiscoverCodegenModels

public boolean isAutoDiscoverCodegenModels()

Returns true if CodegenModels should be discovered and registered automatically from classpath.

See Also:

setAutoDiscoverCodegenModels(boolean)

setAutoDiscoverCodegenModels

public void setAutoDiscoverCodegenModels(boolean autoDiscoverCodegenModels)

If this is true, then the classpath is searched for CodegenModels and found models are registered automatically. Default is true.

setCertificateValidator

public void setCertificateValidator(CertificateValidator certificateValidator)

Define a certificate validator that checks the server certificate after connect.

Parameters:

certificateValidator -

setOperationLimits

public void setOperationLimits(OperationLimits operationLimits)

Define the operation limits for the application

Parameters:

operationLimits -

registerAutoDiscoveredModels

protected <T extends CodegenModelProvider> void registerAutoDiscoveredModels(Class<T> clazz)

Searches classpath for CodegenModels and registers them. Requires models are generated together with codegen options that providers marker files for ServiceLoader. NOTE! this performs the action, it is upto the caller to check if it is configured to do this operation.

Type Parameters:

T - interface class extending CodegenModelProvider, either the client or server variant.

registerModelInternal

protected void registerModelInternal(CodegenModel codegenModel)

Register an information model to use in the application. All the types in the model are then available for the application, when it constructs new instances.

Parameters:

codegenModel - the InformationModel created by the codegen.

validateApplicationCertificate

protected StatusCode validateApplicationCertificate(ApplicationIdentity applicationIdentity)

Parameters:

applicationIdentity - the certificate to validate

Returns:

The validation result, if the certificate is valid or there is no validator, returns a good StatusCode. If the certificate is not valid returns a bad StatusCode.