com.prosysopc.ua

Class UaBinaryFile

java.lang.Object

com.prosysopc.ua.UaBinaryFile

public class UaBinaryFile
extends Object

Contains support for parsing UABinaryFileDataType from file. The result of the parsing is the UABinaryFileDataType and an EncoderContext that contains the custom DataTypes defined in the header.

Method Summary

Modifier and Type	Method and Description
static UaBinaryFile	from(EncoderContext context, Object body, String schemaLocation, KeyValuePair... fileHeader) Creates UaBinaryFile based on the given data.
static UaBinaryFile	from(EncoderContext context, UABinaryFileDataType data) Returns UaBinaryFile that wraps the given data and context.
Object	getBody() Convenience method for getData() and then UABinaryFileDataType.getBody().
EncoderContext	getContext() Returns the EncoderContext that was used to decode the getBody() part of the UABinaryFileDataType, the header of the UABinaryFileDataType defines custom types, the core NamespaceTable.OPCUA_NAMESPACE types are always included.
UABinaryFileDataType	getData() Returns the parsed UABinaryFileDataType.
static UaBinaryFile	parse(InputStream inputStream) Parses the given InputStream, throws DecodingException on failure.
ByteString	toBinary() Returns the encoded contents, which should be written to a filename.uabinary file.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static UaBinaryFile from(EncoderContext context,
                                Object body,
                                String schemaLocation,
                                KeyValuePair... fileHeader)

Creates UaBinaryFile based on the given data. Note that custom datatypes are not yet supported, thus the given body shall be a type that can be put into Variant and be of DataType(s) that belong to the core UA Namespace.

from

public static UaBinaryFile from(EncoderContext context,
                                UABinaryFileDataType data)

Returns UaBinaryFile that wraps the given data and context. The given EncoderContext shall contain all type definitions used by the data and the same types must also be present in the UABinaryFileDataType's DataTypeSchemaHeader part.

parse

public static UaBinaryFile parse(InputStream inputStream)
                          throws DecodingException

Parses the given InputStream, throws DecodingException on failure.

Throws:

DecodingException

getBody

public Object getBody()

Convenience method for getData() and then UABinaryFileDataType.getBody().

getContext

public EncoderContext getContext()

Returns the EncoderContext that was used to decode the getBody() part of the UABinaryFileDataType, the header of the UABinaryFileDataType defines custom types, the core NamespaceTable.OPCUA_NAMESPACE types are always included.

getData

public UABinaryFileDataType getData()

Returns the parsed UABinaryFileDataType.

toBinary

public ByteString toBinary()
                    throws EncodingException

Returns the encoded contents, which should be written to a filename.uabinary file. Throws EncodingException if the data cannot be encoded.

Throws:

EncodingException