org.mule.runtime.api.serialization

Interface SerializationProtocol

public interface SerializationProtocol

Defines a component capable to serialize/deserialize objects into/from an array of bytes. Unlike usual serializing components, this one doesn't enforce the serialized object to implement Serializable. However, some implementations might require that condition and throw IllegalArgumentException if not met.

Implementations are also responsible for the correct initialization of classes implementing the org.mule.runtime.core.util.store.DeserializationPostInitialisable interface.

Unexpected behavior can result of deserializing objects that were generated with a different implementation of SerializationProtocol.

Implementations are required to be thread-safe

Since:

1.0

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(byte[] bytes) Deserializes the given bytes.
<T> T	deserialize(byte[] bytes, ClassLoader classLoader) Deserializes the given bytes.
<T> T	deserialize(InputStream inputStream) Deserializes the given stream of bytes.
<T> T	deserialize(InputStream inputStream, ClassLoader classLoader) Deserializes the given stream of bytes.
byte[]	serialize(Object object) Serializes the given object into a an array of bytes
void	serialize(Object object, OutputStream out) Serializes the given object and writes the result into out

Method Detail

serialize

byte[] serialize(Object object)
          throws SerializationException

Serializes the given object into a an array of bytes

Parameters:

object - the object to be serialized. Might be null

Returns:

an array of byte

Throws:

SerializationException - in case of unexpected exception

serialize

void serialize(Object object,
               OutputStream out)
        throws SerializationException

Serializes the given object and writes the result into out

Parameters:

object - the object to be serialized. Might be null

out - an OutputStream where the result will be written

Throws:

SerializationException - in case of unexpected exception

deserialize

<T> T deserialize(byte[] bytes)
           throws SerializationException

Deserializes the given bytes. Unexpected behavior can result of deserializing a byte[] that was generated with another implementation.

If the obtained object implements org.mule.runtime.core.util.store.DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Implementation will choose the ClassLoader to use for deserialization.

Parameters:

bytes - an array of byte that an original object was serialized into

Returns:

the deserialized object

Throws:

IllegalArgumentException - if bytes is null

SerializationException - in case of unexpected exception

deserialize

<T> T deserialize(byte[] bytes,
                  ClassLoader classLoader)
           throws SerializationException

Deserializes the given bytes.

If the obtained object implements org.mule.runtime.core.util.store.DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Parameters:

bytes - an array of byte that an original object was serialized into

classLoader - the ClassLoader to deserialize with

Returns:

the deserialized object

Throws:

IllegalArgumentException - if bytes is null

SerializationException - in case of unexpected exception

deserialize

<T> T deserialize(InputStream inputStream)
           throws SerializationException

Deserializes the given stream of bytes.

Implementation will choose the ClassLoader to use for deserialization.

Even if deserialization fails, this method will close the inputStream

If the obtained object implements org.mule.runtime.core.util.store.DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Parameters:

inputStream - a stream of bytes that an original object was serialized into

Returns:

the deserialized object

Throws:

IllegalArgumentException - if inputStream is null

SerializationException - in case of unexpected exception

deserialize

<T> T deserialize(InputStream inputStream,
                  ClassLoader classLoader)
           throws SerializationException

Deserializes the given stream of bytes.

Even if deserialization fails, this method will close the inputStream

If the obtained object implements org.mule.runtime.core.util.store.DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Parameters:

inputStream - a stream of bytes that an original object was serialized into

classLoader - the ClassLoader to deserialize with

Returns:

the deserialized object

Throws:

IllegalArgumentException - if inputStream is null

SerializationException - in case of unexpected exception