| Package | Description |
|---|---|
| com.prosysopc.ua.client |
Main client side classes of the SDK.
|
| com.prosysopc.ua.pubsub |
PubSub (Part 14 of the OPC UA Specification) related implementations.
|
| com.prosysopc.ua.server |
Main server side classes of the SDK.
|
| com.prosysopc.ua.stack.application |
The code in this package is for application developer.
|
| com.prosysopc.ua.stack.core | |
| com.prosysopc.ua.stack.transport |
This package contains SecureChannel and related interfaces
|
| com.prosysopc.ua.stack.transport.https |
Code for creating a HTTPS based secure channel
|
| com.prosysopc.ua.stack.transport.tcp.io | |
| com.prosysopc.ua.stack.utils |
Utility classes
|
| com.prosysopc.ua.types.opcua | |
| com.prosysopc.ua.types.opcua.client | |
| com.prosysopc.ua.types.opcua.server |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription[] |
UaClient.discoverEndpoints()
Find the list of server end-points corresponding to
UaClient.getProtocol(). |
EndpointDescription[] |
UaClient.discoverEndpoints(UaApplication.Protocol... protocols)
Find the list of server end-points corresponding to the defined protocols.
|
EndpointDescription |
UaClient.getEndpoint()
The server endpoint that is used.
|
| Modifier and Type | Method and Description |
|---|---|
protected UaAddress |
UaClient.resolveConnectionAddress(UaAddress connectionAddress,
EndpointDescription discoveredEndpoint)
This method is used to resolve the connection address that is used to form the socket
connection to the "actual endpoint" after Discovery has been done (to
UaClient.getAddress()). |
void |
UaLoopbackClient.setEndpoint(EndpointDescription endpoint)
Deprecated.
|
void |
UaClient.setEndpoint(EndpointDescription endpoint)
Use the EndpointDescription to select the server endpoint to connect to.
|
| Modifier and Type | Field and Description |
|---|---|
protected List<EndpointDescription> |
PubSubJsonServerEndpointsMessage.Builder.endpoints |
protected List<EndpointDescription> |
PubSubSecurityConf.Builder.securityKeyServices |
static PubSubConfListFieldSpecification<EndpointDescription> |
PubSubSecurityConf.Fields.SecurityKeyServices |
| Modifier and Type | Method and Description |
|---|---|
List<EndpointDescription> |
PubSubJsonServerEndpointsMessage.getEndpoints() |
List<EndpointDescription> |
PubSubJsonServerEndpointsMessage.Builder.getEndpoints() |
List<EndpointDescription> |
PubSubSecurityConf.getSecurityKeyServices() |
List<EndpointDescription> |
PubSubSecurityConf.Builder.getSecurityKeyServices() |
| Modifier and Type | Method and Description |
|---|---|
PubSubJsonServerEndpointsMessage.Builder |
PubSubJsonServerEndpointsMessage.Builder.addEndpoints(EndpointDescription endpoints)
Adds the value as an element for
PubSubJsonServerEndpointsMessage.getEndpoints(). |
PubSubSecurityConf.Builder |
PubSubSecurityConf.Builder.addSecurityKeyServices(EndpointDescription securityKeyServices)
Adds the value as an element for
PubSubSecurityConf.getSecurityKeyServices(). |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription |
UaServer.getEndpoint(String uri,
SecurityMode securityMode)
Find an endpoint definition for a specific URI & SecurityMode combination
|
EndpointDescription[] |
UaServer.getEndpoints()
Get the list of endpoints.
|
EndpointDescription[] |
SessionManager.getEndpoints() |
EndpointDescription[] |
UaServer.getEndpoints(String uri)
Find all endpoint definitions for a specific URI
|
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription[] |
Client.discoverEndpoints(String discoveryEndpointUrl)
Discover endpoints
|
EndpointDescription[] |
Client.discoverEndpoints(String connectUrl,
String discoveryEndpointUri)
Discover endpoints.
|
EndpointDescription |
Session.getEndpoint()
Getter for the field
endpoint. |
EndpointDescription[] |
Server.getEndpointDescriptions()
getEndpointDescriptions.
|
EndpointDescription[] |
Server.getEndpointDescriptions(SocketAddress requestAddress)
getEndpointDescriptions.
|
| Modifier and Type | Method and Description |
|---|---|
SecureChannel |
Client.createSecureChannel(EndpointDescription endpoint)
Create a secure channel to an endpoint
|
SecureChannel |
Client.createSecureChannel(String connectUrl,
EndpointDescription endpoint)
Create a secure channel to an endpoint.
|
ServiceChannel |
Client.createServiceChannel(EndpointDescription endpoint)
Create a service channel to an endpoint.
|
ServiceChannel |
Client.createServiceChannel(String connectUrl,
EndpointDescription endpoint)
Create a service channel to an endpoint
|
Session |
Client.createSession(SecureChannel channel,
UnsignedInteger maxResponseMessageSize,
Double requestedSessionTimeout,
String sessionName,
EndpointDescription[] discoveredEndpoints)
Create a new session on a server
|
SessionChannel |
Client.createSessionChannel(EndpointDescription endpoint)
Creates a secure channel and an unactivated session channel.
|
SessionChannel |
Client.createSessionChannel(String connectUrl,
EndpointDescription endpoint)
Creates a secure channel and an unactivated session channel.
|
| Constructor and Description |
|---|
CreateSessionResponse(ResponseHeader f_responseHeader,
NodeId f_sessionId,
NodeId f_authenticationToken,
Double f_revisedSessionTimeout,
ByteString f_serverNonce,
ByteString f_serverCertificate,
EndpointDescription[] f_serverEndpoints,
SignedSoftwareCertificate[] f_serverSoftwareCertificates,
SignatureData f_serverSignature,
UnsignedInteger f_maxRequestMessageSize) |
DataSetReaderDataType(String f_name,
Boolean f_enabled,
Object f_publisherId,
UnsignedShort f_writerGroupId,
UnsignedShort f_dataSetWriterId,
DataSetMetaDataType f_dataSetMetaData,
DataSetFieldContentMask f_dataSetFieldContentMask,
Double f_messageReceiveTimeout,
UnsignedInteger f_keyFrameCount,
String f_headerLayoutUri,
MessageSecurityMode f_securityMode,
String f_securityGroupId,
EndpointDescription[] f_securityKeyServices,
KeyValuePair[] f_dataSetReaderProperties,
DataSetReaderTransportDataType f_transportSettings,
DataSetReaderMessageDataType f_messageSettings,
SubscribedDataSetDataType f_subscribedDataSet) |
GetEndpointsResponse(ResponseHeader f_responseHeader,
EndpointDescription[] f_endpoints) |
PubSubConfiguration2DataType(PublishedDataSetDataType[] f_publishedDataSets,
PubSubConnectionDataType[] f_connections,
Boolean f_enabled,
StandaloneSubscribedDataSetDataType[] f_subscribedDataSets,
DataSetMetaDataType[] f_dataSetClasses,
EndpointDescription[] f_defaultSecurityKeyServices,
SecurityGroupDataType[] f_securityGroups,
PubSubKeyPushTargetDataType[] f_pubSubKeyPushTargets,
UnsignedInteger f_configurationVersion,
KeyValuePair[] f_configurationProperties) |
PubSubConfiguration2DataType(StandaloneSubscribedDataSetDataType[] f_subscribedDataSets,
DataSetMetaDataType[] f_dataSetClasses,
EndpointDescription[] f_defaultSecurityKeyServices,
SecurityGroupDataType[] f_securityGroups,
PubSubKeyPushTargetDataType[] f_pubSubKeyPushTargets,
UnsignedInteger f_configurationVersion,
KeyValuePair[] f_configurationProperties) |
PubSubGroupDataType(String f_name,
Boolean f_enabled,
MessageSecurityMode f_securityMode,
String f_securityGroupId,
EndpointDescription[] f_securityKeyServices,
UnsignedInteger f_maxNetworkMessageSize,
KeyValuePair[] f_groupProperties) |
ReaderGroupDataType(String f_name,
Boolean f_enabled,
MessageSecurityMode f_securityMode,
String f_securityGroupId,
EndpointDescription[] f_securityKeyServices,
UnsignedInteger f_maxNetworkMessageSize,
KeyValuePair[] f_groupProperties,
ReaderGroupTransportDataType f_transportSettings,
ReaderGroupMessageDataType f_messageSettings,
DataSetReaderDataType[] f_dataSetReaders) |
WriterGroupDataType(String f_name,
Boolean f_enabled,
MessageSecurityMode f_securityMode,
String f_securityGroupId,
EndpointDescription[] f_securityKeyServices,
UnsignedInteger f_maxNetworkMessageSize,
KeyValuePair[] f_groupProperties,
UnsignedShort f_writerGroupId,
Double f_publishingInterval,
Double f_keepAliveTime,
UnsignedByte f_priority,
String[] f_localeIds,
String f_headerLayoutUri,
WriterGroupTransportDataType f_transportSettings,
WriterGroupMessageDataType f_messageSettings,
DataSetWriterDataType[] f_dataSetWriters) |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription |
TransportChannelSettings.getDescription()
Getter for the field
description. |
EndpointDescription |
ServiceChannel.getEndpointDescription()
getEndpointDescription.
|
EndpointDescription |
SecureChannel.getEndpointDescription()
getEndpointDescription.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TransportChannelSettings.setDescription(EndpointDescription description)
Setter for the field
description. |
| Constructor and Description |
|---|
TransportChannelSettings(EndpointDescription description,
EndpointConfiguration configuration,
Cert clientCertificate,
PrivKey privateKey,
CertificateValidator certificateValidator,
NamespaceTable namespaceUris)
Create Transport channel settings for a opctcp connection
|
TransportChannelSettings(EndpointDescription description,
EndpointConfiguration configuration,
KeyPair keypair,
CertificateValidator certValidator,
org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier)
Create Transport channel settings for a https connection
|
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription |
HttpsClientSecureChannel.getEndpointDescription()
getEndpointDescription.
|
EndpointDescription |
HttpsClient.getEndpointDescription()
getEndpointDescription.
|
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription |
TcpConnection.getEndpointDescription()
Getter for the field
endpointDescription. |
EndpointDescription |
SecureChannelTcp.getEndpointDescription() |
EndpointDescription |
ITransportChannel.getEndpointDescription()
getEndpointDescription.
|
| Modifier and Type | Method and Description |
|---|---|
static EndpointDescription |
EndpointUtil.select(EndpointDescription[] endpoints)
Select an endpoint that is supported by the stack and has the highest security level.
|
static EndpointDescription[] |
EndpointUtil.select(EndpointDescription[] searchSet,
int minKeySize,
int maxKeySize)
select.
|
static EndpointDescription |
EndpointUtil.select(EndpointDescription[] endpoints,
String url)
select.
|
static EndpointDescription[] |
EndpointUtil.select(EndpointDescription[] searchSet,
String url,
String protocol,
MessageSecurityMode mode,
SecurityPolicy policy,
byte[] serverCertificate)
Filter endpoints by various criteria
|
static EndpointDescription[] |
EndpointUtil.selectByMessageSecurityMode(EndpointDescription[] searchSet,
MessageSecurityMode mode)
Selects all endpoints that conform to given message security mode
|
static EndpointDescription[] |
EndpointUtil.selectByProtocol(EndpointDescription[] searchSet,
String protocol)
Selects all endpoints that conform to given protcol
|
static EndpointDescription[] |
EndpointUtil.selectBySecurityPolicy(EndpointDescription[] searchSet,
SecurityPolicy policy)
Selects all endpoints that conform to given message security mode
|
static EndpointDescription[] |
EndpointUtil.selectByUrl(EndpointDescription[] searchSet,
String url)
Selects all endpoints with the given url.
|
static EndpointDescription |
EndpointUtil.selectEndpoint(EndpointDescription[] endpoints)
Select the most suitable endpoint.
|
static EndpointDescription[] |
EndpointUtil.sortBySecurityLevel(EndpointDescription[] set)
Sorts endpoints by their security level.
|
| Modifier and Type | Method and Description |
|---|---|
static UserIdentityToken |
EndpointUtil.createAnonymousIdentityToken(EndpointDescription ep)
Create anonymous user identity token
|
static UserIdentityToken |
EndpointUtil.createIssuedIdentityToken(EndpointDescription ep,
ByteString senderNonce,
byte[] issuedIdentityToken)
Create user identity token based on an issued token.
|
static UserIdentityToken |
EndpointUtil.createUserNameIdentityToken(EndpointDescription ep,
ByteString senderNonce,
String username,
String password)
Create user identity token based on username and password
|
static X509IdentityToken |
EndpointUtil.createX509IdentityToken(EndpointDescription ep,
ByteString serverNonce,
Cert certificate,
PrivateKey key,
SignatureData signatureData)
createX509IdentityToken.
|
static UserTokenPolicy |
EndpointUtil.findUserTokenPolicy(EndpointDescription endpointDescription,
String policyId)
Finds the user token policy with the specified id in the given
EndpointDescription. |
static UserTokenPolicy |
EndpointUtil.findUserTokenPolicy(EndpointDescription endpointDescription,
UserTokenType type)
Finds UserTokenPolicy of given type that this stack can encrypt in the given
EndpointDescription. |
static boolean |
EndpointUtil.needsCertificate(EndpointDescription endpointDescription)
Returns true if the given
EndpointDescription indicates it needs a Certificate to work. |
static EndpointDescription |
EndpointUtil.select(EndpointDescription[] endpoints)
Select an endpoint that is supported by the stack and has the highest security level.
|
static EndpointDescription[] |
EndpointUtil.select(EndpointDescription[] searchSet,
int minKeySize,
int maxKeySize)
select.
|
static EndpointDescription |
EndpointUtil.select(EndpointDescription[] endpoints,
String url)
select.
|
static EndpointDescription[] |
EndpointUtil.select(EndpointDescription[] searchSet,
String url,
String protocol,
MessageSecurityMode mode,
SecurityPolicy policy,
byte[] serverCertificate)
Filter endpoints by various criteria
|
static EndpointDescription[] |
EndpointUtil.selectByMessageSecurityMode(EndpointDescription[] searchSet,
MessageSecurityMode mode)
Selects all endpoints that conform to given message security mode
|
static EndpointDescription[] |
EndpointUtil.selectByProtocol(EndpointDescription[] searchSet,
String protocol)
Selects all endpoints that conform to given protcol
|
static EndpointDescription[] |
EndpointUtil.selectBySecurityPolicy(EndpointDescription[] searchSet,
SecurityPolicy policy)
Selects all endpoints that conform to given message security mode
|
static EndpointDescription[] |
EndpointUtil.selectByUrl(EndpointDescription[] searchSet,
String url)
Selects all endpoints with the given url.
|
static EndpointDescription |
EndpointUtil.selectEndpoint(EndpointDescription[] endpoints)
Select the most suitable endpoint.
|
static EndpointDescription[] |
EndpointUtil.sortBySecurityLevel(EndpointDescription[] set)
Sorts endpoints by their security level.
|
static boolean |
EndpointUtil.supportsUserTokenType(EndpointDescription endpoint,
UserTokenType type)
Tests whether the stack and the given
EndpointDescription supports given token type. |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription[] |
PublishSubscribeType.getDefaultSecurityKeyServices() |
EndpointDescription[] |
PubSubGroupType.getSecurityKeyServices() |
EndpointDescription[] |
DataSetReaderType.getSecurityKeyServices() |
| Modifier and Type | Method and Description |
|---|---|
void |
PublishSubscribeType.setDefaultSecurityKeyServices(EndpointDescription[] value) |
void |
PubSubGroupType.setSecurityKeyServices(EndpointDescription[] value) |
void |
DataSetReaderType.setSecurityKeyServices(EndpointDescription[] value) |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription[] |
PublishSubscribeTypeImplBase.getDefaultSecurityKeyServices() |
EndpointDescription[] |
PubSubGroupTypeImplBase.getSecurityKeyServices() |
EndpointDescription[] |
DataSetReaderTypeImplBase.getSecurityKeyServices() |
| Modifier and Type | Method and Description |
|---|---|
void |
PublishSubscribeTypeImplBase.setDefaultSecurityKeyServices(EndpointDescription[] value) |
void |
PubSubGroupTypeImplBase.setSecurityKeyServices(EndpointDescription[] value) |
void |
DataSetReaderTypeImplBase.setSecurityKeyServices(EndpointDescription[] value) |
| Modifier and Type | Method and Description |
|---|---|
EndpointDescription[] |
PublishSubscribeTypeNodeBase.getDefaultSecurityKeyServices() |
EndpointDescription[] |
PubSubGroupTypeNodeBase.getSecurityKeyServices() |
EndpointDescription[] |
DataSetReaderTypeNodeBase.getSecurityKeyServices() |
| Modifier and Type | Method and Description |
|---|---|
void |
PublishSubscribeTypeNodeBase.setDefaultSecurityKeyServices(EndpointDescription[] value) |
void |
PubSubGroupTypeNodeBase.setSecurityKeyServices(EndpointDescription[] value) |
void |
DataSetReaderTypeNodeBase.setSecurityKeyServices(EndpointDescription[] value) |
Copyright © 2026. All rights reserved.