Package com.inductiveautomation.ignition.common.xmlserialization.deserialization

Class XMLDeserializer

java.lang.Object

com.inductiveautomation.ignition.common.xmlserialization.deserialization.XMLDeserializer

public class XMLDeserializer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassNameResolver	classNameMap
static final ThreadLocal<Version>	FRAMEWORK_VERSION	Will hold the version that the data currently being deserialized was found to be serialized in, if possible.
protected Map<String,DeserializationHandler>	instanceHandlers
protected LoggerEx	log

Constructor Summary

Constructors

Constructor	Description
XMLDeserializer()
XMLDeserializer(ClassNameResolver resolver)

Method Summary

Modifier and Type	Method	Description
void	addHandler(DeserializationHandler handler)
DeserializationContext	deserialize(byte[] bytes)	Deserialize the bytes.
static Object	deserialize(XMLDeserializer deser, byte[] data, LoggerEx log)	Returns the first object found in the root object stream of data.
static Object	deserialize(XMLDeserializer deser, byte[] data, org.apache.log4j.Logger log)	Deprecated. Prefer the overload that accepts a LoggerEx instead.
static Object	deserialize(XMLDeserializer deser, byte[] data, org.slf4j.Logger log)	Deprecated. Prefer the overload that accepts a LoggerEx instead.
DeserializationContext	deserialize(InputStream is)	Deserialize an object graph from an input stream.
DeserializationContext	deserialize(Reader streamReader)	Deserialize an object graph from a reader.
DeserializationContext	deserialize(String xml)	Deserialize an object graph from a reader.
DeserializationContext	deserializeBinary(byte[] bytes)	Deserialize data from a byte[], expected to be in binary format.
DeserializationContext	deserializeBinary(InputStream stream, boolean topAttributesOnly)
List<DeserializationContext>	deserializeMultiple(byte[] bytes, int count)	Special version of deserialization which will deserialize multiple copies of the serialized objects.
DeserializationContext	deserializeXML(Reader streamReader, boolean topAttributesOnly)
ClassNameResolver	getClassNameMap()
XMLDeserializer	initDefaults()	Initializes default handlers in chaining invocation style.
protected DeserializationHandler	lookupHandler(String name)	Finds the deserialization handler registered for the given element name.
Map<String,String>	readRootAttributes(byte[] bytes)	Reads the top element's attributes only.
Map<String,String>	readRootAttributes(InputStream is)	Reads the top element's attributes only.
Map<String,String>	readRootAttributes(Reader streamReader)
Map<String,String>	readRootAttributes(String xml)
String	transcodeToXML(InputStream binary, XMLSerializer serializer)	This function will take serialized data and return it in uncompressed XML format.

Methods inherited from class java.lang.Object

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

Field Details

FRAMEWORK_VERSION

public static final ThreadLocal<Version> FRAMEWORK_VERSION

Will hold the version that the data currently being deserialized was found to be serialized in, if possible. Only non-null during deserialization.

instanceHandlers

protected Map<String,DeserializationHandler> instanceHandlers

classNameMap

protected ClassNameResolver classNameMap

log

protected LoggerEx log

Constructor Details

XMLDeserializer

public XMLDeserializer()

XMLDeserializer

public XMLDeserializer(ClassNameResolver resolver)

Method Details

deserialize

@Deprecated
public static Object deserialize(XMLDeserializer deser,
 byte[] data,
 org.apache.log4j.Logger log)
                          throws SerializationException

Deprecated.

Prefer the overload that accepts a LoggerEx instead.

Throws:

SerializationException

deserialize

@Deprecated(since="8.1.25")
public static Object deserialize(XMLDeserializer deser,
 byte[] data,
 org.slf4j.Logger log)
                          throws SerializationException

Deprecated.

Prefer the overload that accepts a LoggerEx instead.

Throws:

SerializationException

deserialize

public static Object deserialize(XMLDeserializer deser,
 byte[] data,
 LoggerEx log)
                          throws SerializationException

Returns the first object found in the root object stream of data. Reports warnings to log.

Returns:

null if the input data is null or empty. Otherwise, the arbitrary serialized object contained in data.

Throws:

SerializationException - if the data is not valid serialized data, or contains no root objects.

initDefaults

public XMLDeserializer initDefaults()

Initializes default handlers in chaining invocation style. Do not call unlessy you instantiated an XMLDeserializer yourself (generally not the thing to do: get one from your context)

addHandler

public void addHandler(DeserializationHandler handler)

deserialize

public DeserializationContext deserialize(byte[] bytes)
                                   throws SerializationException

Deserialize the bytes. Automatically detects GZip compression and binary vs. XML encoding.

Returns:

DeserializationContext that will contain the root of the serialized object graph, as well as any serialization warnings that occurred.

Throws:

SerializationException

deserialize

public DeserializationContext deserialize(InputStream is)
                                   throws SerializationException

Deserialize an object graph from an input stream. Gzip compression and XML vs binary encoding are automatically detected.

Throws:

SerializationException

deserialize

public DeserializationContext deserialize(String xml)
                                   throws SerializationException

Deserialize an object graph from a reader. Encoding is assumed to be XML

Throws:

SerializationException

deserialize

public DeserializationContext deserialize(Reader streamReader)
                                   throws SerializationException

Deserialize an object graph from a reader. Encoding is assumed to be XML

Throws:

SerializationException

readRootAttributes

public Map<String,String> readRootAttributes(String xml)
                                      throws SerializationException

Throws:

SerializationException

readRootAttributes

public Map<String,String> readRootAttributes(Reader streamReader)
                                      throws SerializationException

Throws:

SerializationException

readRootAttributes

public Map<String,String> readRootAttributes(byte[] bytes)
                                      throws SerializationException

Reads the top element's attributes only. Automatically detects GZip compression and xml vs binary format

Throws:

SerializationException

readRootAttributes

public Map<String,String> readRootAttributes(InputStream is)
                                      throws SerializationException

Reads the top element's attributes only. Automatically detects GZip compression and xml vs binary format.

Throws:

SerializationException

deserializeBinary

public DeserializationContext deserializeBinary(byte[] bytes)
                                         throws SerializationException

Deserialize data from a byte[], expected to be in binary format. Detects GZip automaticaly.

Throws:

SerializationException

deserializeBinary

public DeserializationContext deserializeBinary(InputStream stream,
 boolean topAttributesOnly)
                                         throws SerializationException

Throws:

SerializationException

deserializeXML

public DeserializationContext deserializeXML(Reader streamReader,
 boolean topAttributesOnly)
                                      throws SerializationException

Throws:

SerializationException

transcodeToXML

public String transcodeToXML(InputStream binary,
 XMLSerializer serializer)
                      throws SerializationException

This function will take serialized data and return it in uncompressed XML format. If the data is already in XML format, it will simple be returned as a string If it is in binary format, it will be transcoded first. The stream will be automatically uncompressed if necessary.

Throws:

SerializationException

lookupHandler

protected DeserializationHandler lookupHandler(String name)

Finds the deserialization handler registered for the given element name.

deserializeMultiple

public List<DeserializationContext> deserializeMultiple(byte[] bytes,
 int count)
                                                 throws SerializationException

Special version of deserialization which will deserialize multiple copies of the serialized objects. More efficient than calling deserialize X times, as long as X is greater than one.

Throws:

SerializationException

getClassNameMap

public ClassNameResolver getClassNameMap()