| Package | Description |
|---|---|
| com.prosysopc.ua |
Common classes for client and server side.
|
| 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.builtintypes |
OPC UA Part 6 defines 25 builtin types.
|
| com.prosysopc.ua.stack.encoding |
This folder contains serialization interfaces and serialization implementations
|
| com.prosysopc.ua.stack.encoding.binary |
The implementation of binary serialization
|
| com.prosysopc.ua.stack.encoding.json | |
| com.prosysopc.ua.stack.encoding.xml |
The implementation of xml serialization.
|
| 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.transport.tcp.nio | |
| com.prosysopc.ua.stack.utils |
Utility classes
|
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
UaBinaryFile.getContext()
Returns the
EncoderContext that was used to decode the UaBinaryFile.getBody() part of the
UABinaryFileDataType, the header of the UABinaryFileDataType defines custom
types, the core NamespaceTable.OPCUA_NAMESPACE types are always included. |
EncoderContext |
UaAddressSpace.getEncoderContext()
Returns the
EncoderContext. |
abstract EncoderContext |
UaApplication.getEncoderContext() |
EncoderContext |
ModelParserBase.getEncoderContext() |
EncoderContext |
UaNamespaceTranslateable.Context.getTypeSpecificationTarget() |
| Modifier and Type | Method and Description |
|---|---|
static UaBinaryFile |
UaBinaryFile.from(EncoderContext context,
Object body,
String schemaLocation,
KeyValuePair... fileHeader)
Creates
UaBinaryFile based on the given data. |
static UaBinaryFile |
UaBinaryFile.from(EncoderContext context,
UABinaryFileDataType data)
Returns
UaBinaryFile that wraps the given data and context. |
Set<AddNodesItem> |
UaNodeSet.nodesToAddNodesItem(EncoderContext target)
Converts the
UaNodeSet.getNodes() data to AddNodesItem data the context of the given
EncoderContext. |
Set<AddReferencesItem> |
UaNodeSet.referencesToAddReferencesItem(EncoderContext target)
Converts the
UaNodeSet.getReferences() data to AddReferencesItem data the context of the
given EncoderContext. |
UaNamespaceTranslateable.Context |
UaNamespaceTranslateable.Context.withTranslateDataTypeSpecifications(EncoderContext targetEncoderContext,
Consumer<UaDataTypeSpecification> consumer)
Returns a
UaNamespaceTranslateable.Context that will also translate UaDataTypeSpecifications of all
UaOptionSets, Enumerations and Structures. |
| Constructor and Description |
|---|
ContentFilterBuilder(EncoderContext encoderContext)
Deprecated.
|
InternalDataTypeSchemaHeaderTypeInjector(DataTypeSchemaHeader data,
EncoderContext context) |
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
UaLoopbackClient.getEncoderContext() |
EncoderContext |
UaClient.getEncoderContext() |
EncoderContext |
AddressSpace.getEncoderContext() |
| Modifier and Type | Method and Description |
|---|---|
static PubSubConf.MapKind<Map<String,String>> |
PubSubConf.MapKind.flatRecursive(EncoderContext encoderContext)
Returns a Map with string keys and data.
|
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
UaServer.getEncoderContext() |
protected EncoderContext |
ServiceHandler.getEncoderContext() |
EncoderContext |
NodeManagerTable.getEncoderContext() |
| Modifier and Type | Method and Description |
|---|---|
protected static ExtensionObject |
ServiceHandler.toExtensionObject(ServiceContext serviceContext,
Structure data,
QualifiedName dataEncoding,
EncoderContext encoderContext) |
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
Server.getEncoderContext()
getEncoderContext.
|
EncoderContext |
Client.getEncoderContext()
getEncoderContext.
|
EncoderContext |
Application.getEncoderContext()
Getter for the field
encoderContext. |
| Modifier and Type | Method and Description |
|---|---|
static ExtensionObject |
ExtensionObject.binaryEncode(Structure encodeable,
EncoderContext ctx)
Create extension object by encoding an encodeable to a binary format using the given context.
|
static ExtensionObject |
ExtensionObject.binaryEncode(Structure encodeable,
EncoderContext ctx,
List<Locale> localeHints)
Encodes the given Structure to an ExtensionObject using the binary encoding rules.
|
<T extends IEncodeable> |
ExtensionObject.decode(EncoderContext ctx)
Attempts to decode the extension object using the default serializer of the stack.
|
<T extends IEncodeable> |
ExtensionObject.decode(EncoderContext ctx,
Class<T> expectedClass,
UnsignedInteger statusCodeOnFailure)
Casts the data within this object to the expected class (decoding if needed), throwing on
failure.
|
<T extends IEncodeable> |
ExtensionObject.decode(EncoderContext ctx,
NamespaceTable namespaceTable)
Decode the extension object.
|
static Variant |
Variant.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId)
Get a new Variant instance initialized to a default value of a DataType.
|
static DataValue |
DataValue.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId)
Get a new DataValue instance initialized to a default value of a DataType.
|
static Variant |
Variant.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
int valueRank) |
static DataValue |
DataValue.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
int valueRank) |
static Variant |
Variant.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
UaArrayDimensions arrayDimensions)
Get a new Variant instance initialized to a default value of a DataType.
|
static DataValue |
DataValue.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
UaArrayDimensions arrayDimensions)
Get a new DataValue instance initialized to a default value of a DataType.
|
static Variant |
Variant.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
UnsignedInteger[] arrayDimensions)
Get a new Variant instance initialized to a default value of a DataType.
|
static DataValue |
DataValue.defaultValue(EncoderContext encoderContext,
UaNodeId dataTypeId,
UnsignedInteger[] arrayDimensions)
Get a new DataValue instance initialized to a default value of a DataType.
|
static ExtensionObject |
ExtensionObject.encode(Structure encodeable,
QualifiedName encodingType,
EncoderContext ctx)
Create extension object by encoding an encodeable to the defined encoding using
the default serializer. |
static ExtensionObject |
ExtensionObject.jsonEncode(Structure encodeable,
EncoderContext ctx,
JsonEncodingMode mode)
Create an
ExtensionObject, where the given Structure is stored as JSON-encoded String. |
static ExtensionObject |
ExtensionObject.xmlEncode(Structure encodeable,
EncoderContext ctx)
Create an
ExtensionObject, where the given Structure is stored as XML-encoded String. |
static ExtensionObject |
ExtensionObject.xmlEncode(Structure encodeable,
EncoderContext ctx,
boolean writeXmlNamespaces,
boolean indent,
int indentAmount)
Create an
ExtensionObject, where the given Structure is stored as XML-encoded String. |
| Modifier and Type | Field and Description |
|---|---|
protected EncoderContext |
AbstractDecoder.ctx |
protected EncoderContext |
AbstactEncoder.ctx |
| Modifier and Type | Method and Description |
|---|---|
static EncoderContext |
EncoderContext.coreNamespaceOnly()
Returns an unmodifiable
EncoderContext instance that only handles the core namespace
(NamespaceTable.OPCUA_NAMESPACE). |
static EncoderContext |
EncoderContext.getDefaultInstance()
Deprecated.
This method should not be called, instead use the EncoderContext from UaClient or
UaServer. This context can only handle the
NamespaceTable.OPCUA_NAMESPACE. |
EncoderContext |
IEncoder.getEncoderContext()
Returns
EncoderContext of this encoder. |
EncoderContext |
IDecoder.getEncoderContext()
Returns
EncoderContext of this decoder. |
EncoderContext |
AbstractDecoder.getEncoderContext() |
EncoderContext |
AbstactEncoder.getEncoderContext() |
EncoderContext |
EncoderContext.shallowCopy()
Returns a new EncoderContext with same values.
|
| Constructor and Description |
|---|
AbstactEncoder(EncoderContext ctx) |
AbstractDecoder(EncoderContext ctx) |
| Constructor and Description |
|---|
BinaryDecoder(EncoderContext encoderContext,
byte[] buf)
Constructor for BinaryDecoder.
|
BinaryDecoder(EncoderContext encoderContext,
byte[] buf,
int off,
int len)
Constructor for BinaryDecoder.
|
BinaryDecoder(EncoderContext encoderContext,
ByteBuffer buf)
Create byte buffer decoder.
|
BinaryDecoder(EncoderContext encoderContext,
ByteString buf) |
BinaryDecoder(EncoderContext encoderContext,
ByteString buf,
int off,
int len) |
BinaryDecoder(EncoderContext encoderContext,
IBinaryReadable in)
Constructor for BinaryDecoder.
|
BinaryDecoder(EncoderContext encoderContext,
InputStream is,
int limit)
Constructor for BinaryDecoder.
|
BinaryEncoder(EncoderContext encoderContext,
byte[] buffer)
Creates
BinaryEncoder with the given EncoderContext that writes to the given
buffer. |
BinaryEncoder(EncoderContext encoderContext,
byte[] buffer,
int offset,
int length)
Creates
BinaryEncoder with the given EncoderContext that writes to the given
buffer starting from the given offset and only writing up-to the given length. |
BinaryEncoder(EncoderContext encoderContext,
ByteBuffer buf)
Creates
BinaryEncoder with the given EncoderContext that writes to the given
buffer. |
BinaryEncoder(EncoderContext encoderContext,
IBinaryWriteable out)
Creates
BinaryEncoder with the given EncoderContext that writes to the given
stream. |
BinaryEncoder(EncoderContext encoderContext,
OutputStream os)
Creates
BinaryEncoder with the given EncoderContext that writes to the given
stream. |
| Constructor and Description |
|---|
JsonDecoder(EncoderContext ctx)
Creates new
JsonDecoder using the given EncoderContext. |
JsonEncoder(EncoderContext encoderContext,
JsonEncodingMode mode,
Writer writer)
Creates a new
JsonEncoder that will write to the given output. |
| Constructor and Description |
|---|
XmlDecoder(XmlElement element,
EncoderContext encoderContext)
Constructor for XmlDecoder.
|
XmlDecoder(XMLStreamReader reader,
EncoderContext encoderContext)
Constructor for XmlDecoder.
|
XmlEncoder(EncoderContext encoderContext)
Creates a new
XmlEncoder that will write to the given output. |
XmlEncoder(EncoderContext encoderContext,
boolean writeNamespaces)
Creates a new
XmlEncoder. |
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
EndpointServer.getEncoderContext()
getEncoderContext.
|
EncoderContext |
ServiceChannel.getMessageContext()
getMessageContext.
|
EncoderContext |
SecureChannel.getMessageContext()
getMessageContext.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ServiceChannel.initialize(String url,
TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
void |
SecureChannel.initialize(String connectUrl,
TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
void |
ServiceChannel.initialize(TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
void |
SecureChannel.initialize(TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
HttpsServerEndpointHandler.getEncoderContext()
getEncoderContext.
|
EncoderContext |
HttpsServer.getEncoderContext()
getEncoderContext.
|
EncoderContext |
HttpsClientSecureChannel.getMessageContext()
getMessageContext.
|
EncoderContext |
HttpsClient.getMessageContext()
getMessageContext.
|
| Modifier and Type | Method and Description |
|---|---|
void |
HttpsClientSecureChannel.initialize(String url,
TransportChannelSettings tcs,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
void |
HttpsClient.initialize(String connectUrl,
TransportChannelSettings tcs,
EncoderContext ctx) |
void |
HttpsClientSecureChannel.initialize(TransportChannelSettings tcs,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
TcpConnection.getMessageContext()
getMessageContext.
|
EncoderContext |
SecureChannelTcp.getMessageContext() |
EncoderContext |
ITransportChannel.getMessageContext()
getMessageContext.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TcpConnection.initialize(InetSocketAddress addr,
TransportChannelSettings settings,
EncoderContext ctx)
Set connection configuration parameters.
|
void |
SecureChannelTcp.initialize(InetSocketAddress addr,
TransportChannelSettings settings,
EncoderContext ctx)
Configure the secure channel.
|
void |
IConnection.initialize(InetSocketAddress addr,
TransportChannelSettings settings,
EncoderContext ctx)
Set connection configuration parameters.
|
void |
TcpConnection.initialize(String url,
TransportChannelSettings settings,
EncoderContext ctx) |
void |
SecureChannelTcp.initialize(String url,
TransportChannelSettings settings,
EncoderContext ctx)
Configure the secure channel.
|
void |
ITransportChannel.initialize(String url,
TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL.
|
void |
TcpConnection.initialize(TransportChannelSettings settings,
EncoderContext ctx)
initialize.
|
void |
SecureChannelTcp.initialize(TransportChannelSettings settings,
EncoderContext ctx)
Configure the secure channel.
|
| Modifier and Type | Method and Description |
|---|---|
EncoderContext |
OpcTcpServer.getEncoderContext()
getEncoderContext.
|
| Constructor and Description |
|---|
ChunksToMessage(TcpConnectionParameters ctx,
EncoderContext encoderCtx,
Class<? extends AbstractUaTcpCommMessage> expectedType,
ByteBuffer... plaintexts)
Constructor for ChunksToMessage.
|
MessageToChunks(IEncodeable msg,
TcpConnectionParameters ctx,
EncoderContext encoderCtx,
ChunkFactory chunkFactory,
MessageType type)
Constructor for MessageToChunks.
|
SecureInputMessageBuilder(Object token,
SecureInputMessageBuilder.MessageListener listener,
TcpConnectionParameters ctx,
EncoderContext encoderCtx,
AtomicInteger expectedSequenceNumber)
Create message builder.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
MultiDimensionArrayUtils.toString(Object object,
EncoderContext ctx)
Format object to String, try decoding
ExtensionObjects with the given context. |
Copyright © 2026. All rights reserved.