org.openmrs.serialization

Class SimpleXStreamSerializer

java.lang.Object

org.openmrs.serialization.SimpleXStreamSerializer

All Implemented Interfaces:

OpenmrsSerializer

@Component(value="simpleXStreamSerializer")
public class SimpleXStreamSerializer
extends Object
implements OpenmrsSerializer

This serializer uses the xstream library to serialize and deserialize objects.
All classes are automatically aliased. So a serialization of the Patient class will not be: <org.openmrs.Patient ...> <element ... </org.openmrs.Patient> but instead will be: <patient ...> <element ... </patient>

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
SimpleXStreamSerializer() Default Constructor
SimpleXStreamSerializer(AdministrationService adminService)
SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXStream) Deprecated. since 2.7.0, 2.6.2, 2.5.13 use SimpleXStreamSerializer(XStream, AdministrationService)
SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXStream, AdministrationService adminService)

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(String serializedObject, Class<? extends T> clazz) Deserialize the given string into a full object
com.thoughtworks.xstream.XStream	getXstream() Expose the xstream object, so that module can config with xstream as need
void	initXStream(com.thoughtworks.xstream.XStream newXStream) Setups permissions and default attributes.
String	serialize(Object o) Turn the current object into an identifying string that can be retrieved later
static void	setupXStreamSecurity(com.thoughtworks.xstream.XStream newXStream, AdministrationService adminService) Setups XStream security using AdministrationService.getSerializerWhitelistTypes()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

SimpleXStreamSerializer

public SimpleXStreamSerializer()
                        throws SerializationException

Default Constructor

Throws:

SerializationException

SimpleXStreamSerializer

public SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXStream)
                        throws SerializationException

Deprecated. since 2.7.0, 2.6.2, 2.5.13 use SimpleXStreamSerializer(XStream, AdministrationService)

Constructor that takes a custom XStream object. Please note that it is deprecated since it now requires AdministrationService to fully configure whitelists defined via GPs.

Parameters:

customXStream -

Throws:

SerializationException

SimpleXStreamSerializer

public SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXStream,
                               AdministrationService adminService)
                        throws SerializationException

Throws:

SerializationException

SimpleXStreamSerializer

@Autowired
public SimpleXStreamSerializer(AdministrationService adminService)

Method Detail

setupXStreamSecurity

public static void setupXStreamSecurity(com.thoughtworks.xstream.XStream newXStream,
                                        AdministrationService adminService)

Setups XStream security using AdministrationService.getSerializerWhitelistTypes()

Parameters:

newXStream -

adminService -

Since:

2.7.0, 2.6.2, 2.5.13

initXStream

public void initXStream(com.thoughtworks.xstream.XStream newXStream)

Setups permissions and default attributes.

Parameters:

newXStream -

Since:

2.7.0, 2.6.2, 2.5.13

getXstream

public com.thoughtworks.xstream.XStream getXstream()

Expose the xstream object, so that module can config with xstream as need

Returns:

xstream can be configured by module

serialize

public String serialize(Object o)
                 throws SerializationException

Description copied from interface: OpenmrsSerializer

Turn the current object into an identifying string that can be retrieved later

Specified by:

serialize in interface OpenmrsSerializer

Parameters:

o - - the object to serialize

Returns:

String representing this object

Throws:

SerializationException

See Also:

Should not serialize proxies

deserialize

public <T> T deserialize(String serializedObject,
                         Class<? extends T> clazz)
                  throws SerializationException

Description copied from interface: OpenmrsSerializer

Deserialize the given string into a full object

Specified by:

deserialize in interface OpenmrsSerializer

Parameters:

serializedObject - - String to deserialize

clazz - - The class to deserialize the Object into

Returns:

hydrated object of the appropriate type

Throws:

SerializationException

See Also:

Should not deserialize proxies Should ignore entities Should not deserialize classes that are not whitelisted Should deserialize whitelisted packages Should deserialize whitelisted classes and packages Should deserialize whitelisted hierarchies