com.prosysopc.ua.stack.builtintypes

Class ExtensionObject

java.lang.Object

com.prosysopc.ua.stack.builtintypes.ExtensionObject

All Implemented Interfaces:

UaNamespaceTranslateable<ExtensionObject>, Cloneable

public class ExtensionObject
extends Object
implements Cloneable, UaNamespaceTranslateable<ExtensionObject>

Extension object contains a Structure which is either XML or binary encoded.

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionObject[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ExtensionObject(ExpandedNodeId typeId) Constructor for ExtensionObject.
ExtensionObject(ExpandedNodeId typeId, byte[] object) Deprecated. use ExtensionObject(ExpandedNodeId, ByteString) instead. This method will convert the given byte[] to ByteString.
ExtensionObject(ExpandedNodeId typeId, ByteString object) Constructor for ExtensionObject.
ExtensionObject(ExpandedNodeId typeId, String object) Constructor for ExtensionObject.
ExtensionObject(ExpandedNodeId typeId, XmlElement object) Constructor for ExtensionObject.
ExtensionObject(Structure encodeable) ExtensionObject that encodes the value later when put into a Encoder.

Method Summary

Modifier and Type	Method and Description
static ExtensionObject	binaryEncode(Structure encodeable, EncoderContext ctx) Create extension object by encoding an encodeable to a binary format using the given context.
static ExtensionObject	binaryEncode(Structure encodeable, EncoderContext ctx, List<Locale> localeHints) Encodes the given Structure to an ExtensionObject using the binary encoding rules.
ExtensionObject	clone()
<T extends IEncodeable> T	decode(EncoderContext ctx) Attempts to decode the extension object using the default serializer of the stack.
<T extends IEncodeable> T	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> T	decode(EncoderContext ctx, NamespaceTable namespaceTable) Decode the extension object.
static ExtensionObject	encode(Structure encodeable, QualifiedName encodingType, EncoderContext ctx) Create extension object by encoding an encodeable to the defined encoding using the default serializer.
boolean	equals(Object obj)
EncodeType	getEncodeType() Returns the type of the raw data returned by getObject().
Object	getObject() Get the object within this ExtensionObject.
ExpandedNodeId	getTypeId() Getter for the field typeId.
int	hashCode()
boolean	isEncoded() Returns true, if the getObject() is encoded value.
static ExtensionObject	jsonEncode(Structure encodeable, EncoderContext ctx, JsonEncodingMode mode) Create an ExtensionObject, where the given Structure is stored as JSON-encoded String.
String	toString()
ExtensionObject	withTranslatedNamespaces(UaNamespaceTranslateable.Context context) Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context.
static ExtensionObject	xmlEncode(Structure encodeable, EncoderContext ctx) Create an ExtensionObject, where the given Structure is stored as XML-encoded String.
static 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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final ExtensionObject[] EMPTY_ARRAY

Constructor Detail

ExtensionObject

public ExtensionObject(ExpandedNodeId typeId)

Constructor for ExtensionObject.

Parameters:

typeId - a ExpandedNodeId object.

ExtensionObject

@Deprecated
public ExtensionObject(ExpandedNodeId typeId,
                                    byte[] object)

Deprecated. use ExtensionObject(ExpandedNodeId, ByteString) instead. This method will convert the given byte[] to ByteString.

Constructor for ExtensionObject.

Parameters:

typeId - a ExpandedNodeId object.

object - an array of byte.

ExtensionObject

public ExtensionObject(ExpandedNodeId typeId,
                       ByteString object)

Constructor for ExtensionObject.

Parameters:

typeId - a ExpandedNodeId object.

object - an array of byte.

ExtensionObject

public ExtensionObject(ExpandedNodeId typeId,
                       String object)

Constructor for ExtensionObject.

Parameters:

typeId - a ExpandedNodeId object.

object - a json encoded object

ExtensionObject

public ExtensionObject(ExpandedNodeId typeId,
                       XmlElement object)

Constructor for ExtensionObject.

Parameters:

typeId - a ExpandedNodeId object.

object - a XmlElement object.

ExtensionObject

public ExtensionObject(Structure encodeable)

ExtensionObject that encodes the value later when put into a Encoder.

Parameters:

encodeable - a Structure that should later be encoded.

Method Detail

binaryEncode

public static ExtensionObject binaryEncode(Structure encodeable,
                                           EncoderContext ctx)
                                    throws EncodingException

Create extension object by encoding an encodeable to a binary format using the given context.

Parameters:

encodeable - encodeable

ctx - a EncoderContext object.

Returns:

binary encoded encodeable

Throws:

EncodingException - on encoding problem

binaryEncode

public static ExtensionObject binaryEncode(Structure encodeable,
                                           EncoderContext ctx,
                                           List<Locale> localeHints)
                                    throws EncodingException

Encodes the given Structure to an ExtensionObject using the binary encoding rules.

Throws:

EncodingException

encode

public static ExtensionObject encode(Structure encodeable,
                                     QualifiedName encodingType,
                                     EncoderContext ctx)
                              throws EncodingException

Create extension object by encoding an encodeable to the defined encoding using the default serializer.

Parameters:

encodeable - the objects to encode

encodingType - the requested encoding type either QualifiedName.DEFAULT_BINARY_ENCODING or QualifiedName.DEFAULT_XML_ENCODING

ctx - a EncoderContext object.

Returns:

the encodeable as an ExtensionObject

Throws:

EncodingException - if the encodingType is unsupported or the encoding fails

jsonEncode

public static ExtensionObject jsonEncode(Structure encodeable,
                                         EncoderContext ctx,
                                         JsonEncodingMode mode)
                                  throws EncodingException

Create an ExtensionObject, where the given Structure is stored as JSON-encoded String.

Throws:

EncodingException

xmlEncode

public static ExtensionObject xmlEncode(Structure encodeable,
                                        EncoderContext ctx)
                                 throws EncodingException

Create an ExtensionObject, where the given Structure is stored as XML-encoded String.

Throws:

EncodingException

xmlEncode

public static ExtensionObject xmlEncode(Structure encodeable,
                                        EncoderContext ctx,
                                        boolean writeXmlNamespaces,
                                        boolean indent,
                                        int indentAmount)
                                 throws EncodingException

Create an ExtensionObject, where the given Structure is stored as XML-encoded String.

Throws:

EncodingException

clone

public ExtensionObject clone()

Overrides:

clone in class Object

decode

public <T extends IEncodeable> T decode(EncoderContext ctx)
                                 throws DecodingException

Attempts to decode the extension object using the default serializer of the stack.

Type Parameters:

T - type

Parameters:

ctx - context

Returns:

decoded object

Throws:

DecodingException - if any.

decode

public <T extends IEncodeable> T decode(EncoderContext ctx,
                                        Class<T> expectedClass,
                                        UnsignedInteger statusCodeOnFailure)
                                 throws StatusException

Casts the data within this object to the expected class (decoding if needed), throwing on failure.

First the data within this object is decoded if needed by using the given context. Then the object is cast to the given class and returned. A StatusException with the given code is thrown if decoding or casting to the correct class fails.

Type Parameters:

T - Generics parameter for the expected class.

Parameters:

ctx - Context for decoding.

expectedClass - The expected class.

statusCodeOnFailure - The error code to be thrown on failure.

Returns:

Decoded object of the expected class.

Throws:

StatusException - If decoding or casting fails.

decode

public <T extends IEncodeable> T decode(EncoderContext ctx,
                                        NamespaceTable namespaceTable)
                                 throws DecodingException

Decode the extension object.

Type Parameters:

T - type

Parameters:

ctx - context

namespaceTable - namespace table

Returns:

decoded object

Throws:

DecodingException - if any.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEncodeType

public EncodeType getEncodeType()

Returns the type of the raw data returned by getObject(). Returns null if this ExtensionObject already contains a Structure.

getObject

public Object getObject()

Get the object within this ExtensionObject. Can either be an already decoded Structure, raw encoded format as either ByteString or XmlElement.

getTypeId

public ExpandedNodeId getTypeId()

Getter for the field typeId.

Returns:

a ExpandedNodeId object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEncoded

public boolean isEncoded()

Returns true, if the getObject() is encoded value. Null is considered to be encoded value.

Returns:

true if value is encoded

toString

public String toString()

Overrides:

toString in class Object

withTranslatedNamespaces

public ExtensionObject withTranslatedNamespaces(UaNamespaceTranslateable.Context context)

Description copied from interface: UaNamespaceTranslateable

Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context. Returning the same object is allowed if the type is immutable and the result is equal to this. Note that for Structure types if the UaDataTypeSpecification translation is active the returned type can be of different java class.

Specified by:

withTranslatedNamespaces in interface UaNamespaceTranslateable<ExtensionObject>