com.prosysopc.ua.stack.encoding.xml

Class XmlEncoder

java.lang.Object

com.prosysopc.ua.stack.encoding.AbstactEncoder

com.prosysopc.ua.stack.encoding.xml.XmlEncoder

All Implemented Interfaces:

IEncoder

public class XmlEncoder
extends AbstactEncoder
implements IEncoder

Encodes built-in types, Enumerations, Structures and Messages.

An EncoderContext must be set before use.

Null valued arguments are encoded with default empty values (for UA types not having a Null encoding) when encoder mode is NonStrict, which is the default mode.

See Also:

the decoder equivalent of this class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPC_UA_TYPES_NAMESPACE

Fields inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

ctx

Constructor Summary

Constructors

Constructor and Description
XmlEncoder(EncoderContext encoderContext) Creates a new XmlEncoder that will write to the given output.
XmlEncoder(EncoderContext encoderContext, boolean writeNamespaces) Creates a new XmlEncoder.

Method Summary

Modifier and Type	Method and Description
String	getDefaultNamespace()
EncoderMode	getEncoderType() getEncoderType.
String	getEncoding()
int	getIndentAmount()
List<Locale>	getLocales() The current Locale preferences.
int	getMaxDiagnosticInfoNestingLevel()
boolean	isIndent()
boolean	isOmitXmlDeclaration()
void	put(String fieldName, Object value, UaNodeId dataTypeId, int dimensions) Encodes the given field.
void	putRawVariant(Variant value, String xmlNamespace) Encode raw Variant value, i.e.
void	setDefaultNamespace(String defaultNamespace)
void	setEncoderMode(EncoderMode type) Set encoding mode.
void	setEncoding(String encoding)
void	setIndent(boolean indent)
void	setIndentAmount(int indentAmount)
void	setMaxDiagnosticInfoNestingLevel(int maxDiagnosticInfoNestingLevel)
void	setOmitXmlDeclaration(boolean omitXmlDeclaration)
void	write(Writer writer) Writes XML to the given output.

Methods inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

getEncoderContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.stack.encoding.IEncoder

getEncoderContext, putBoolean, putBooleanArray, putBooleanArray, putByte, putByteArray, putByteArray, putByteString, putByteStringArray, putByteStringArray, putDataValue, putDataValueArray, putDataValueArray, putDateTime, putDateTimeArray, putDateTimeArray, putDiagnosticInfo, putDiagnosticInfoArray, putDiagnosticInfoArray, putDouble, putDouble, putDoubleArray, putDoubleArray, putExpandedNodeId, putExpandedNodeIdArray, putExpandedNodeIdArray, putExtensionObject, putExtensionObjectArray, putExtensionObjectArray, putFloat, putFloat, putFloatArray, putFloatArray, putGuid, putGuidArray, putGuidArray, putInt16, putInt16, putInt16Array, putInt16Array, putInt32, putInt32, putInt32Array, putInt32Array, putInt32Array, putInt64, putInt64, putInt64Array, putInt64Array, putLocalizedText, putLocalizedTextArray, putLocalizedTextArray, putNodeId, putNodeIdArray, putNodeIdArray, putQualifiedName, putQualifiedNameArray, putQualifiedNameArray, putSByte, putSByte, putSByte, putSByteArray, putSByteArray, putStatusCode, putStatusCodeArray, putStatusCodeArray, putString, putStringArray, putStringArray, putUInt16, putUInt16Array, putUInt16Array, putUInt32, putUInt32Array, putUInt32Array, putUInt64, putUInt64Array, putUInt64Array, putVariant, putVariantArray, putXmlElement, putXmlElementArray, putXmlElementArray

Field Detail

OPC_UA_TYPES_NAMESPACE

public static final String OPC_UA_TYPES_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

XmlEncoder

public XmlEncoder(EncoderContext encoderContext)
           throws EncodingException

Creates a new XmlEncoder that will write to the given output.

Throws:

EncodingException

XmlEncoder

public XmlEncoder(EncoderContext encoderContext,
                  boolean writeNamespaces)
           throws EncodingException

Creates a new XmlEncoder.

Throws:

EncodingException

Method Detail

getDefaultNamespace

public String getDefaultNamespace()

getEncoderType

public EncoderMode getEncoderType()

getEncoderType.

Returns:

a EncoderMode object.

getEncoding

public String getEncoding()

getIndentAmount

public int getIndentAmount()

getLocales

public List<Locale> getLocales()

Description copied from interface: IEncoder

The current Locale preferences. When encoding localized data, the first index is preferred, then second etc., until there is a direct match. If there are no direct matches (or this list is empty), one of the values or an "invariant locale" (i.e. typically the one for locale==null case) value is returned. Note! this is only used in the server side, in the client side there is only a single locale at a time (when encoding messages to be sent to the server), while the server will encode the messages based on the client's localization preferences.

Specified by:

getLocales in interface IEncoder

getMaxDiagnosticInfoNestingLevel

public int getMaxDiagnosticInfoNestingLevel()

isIndent

public boolean isIndent()

isOmitXmlDeclaration

public boolean isOmitXmlDeclaration()

put

public void put(String fieldName,
                Object value,
                UaNodeId dataTypeId,
                int dimensions)
         throws EncodingException

Description copied from interface: IEncoder

Encodes the given field.

Specified by:

put in interface IEncoder

Parameters:

fieldName - the name of the field (not used in all encodings e.g. Binary encodings do not typically use a name, but JSON does).

value - the value for the field, possibly null.

dataTypeId - the OPC UA DataType of the field, not null.

dimensions - the dimensions of the field, 0 if scalar, 1 if 1-dim array, etc.).

Throws:

EncodingException - in case the value cannot be encoded. Possible errors are e.g. giving wrong DataType for a given value, giving wrong dimensions or giving values that are too large for limits of the IEncoder.getEncoderContext().

putRawVariant

public void putRawVariant(Variant value,
                          String xmlNamespace)
                   throws EncodingException

Encode raw Variant value, i.e. without an outer "field" element i.e. this outputs the Variant's element directly.

Throws:

EncodingException

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

setEncoderMode

public void setEncoderMode(EncoderMode type)

Set encoding mode. If Strict, null values cannot be encoded. If Slack then nulls are encoded with empty default values.

Parameters:

type - encoder type

setEncoding

public void setEncoding(String encoding)

setIndent

public void setIndent(boolean indent)

setIndentAmount

public void setIndentAmount(int indentAmount)

setMaxDiagnosticInfoNestingLevel

public void setMaxDiagnosticInfoNestingLevel(int maxDiagnosticInfoNestingLevel)

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean omitXmlDeclaration)

write

public void write(Writer writer)
           throws EncodingException

Writes XML to the given output.

Throws:

EncodingException