org.mule.runtime.core.api.serialization

Class AbstractSerializationProtocol

java.lang.Object

org.mule.runtime.core.api.serialization.AbstractSerializationProtocol

All Implemented Interfaces:

MuleContextAware, SerializationProtocol

Direct Known Subclasses:

JavaExternalSerializerProtocol

public abstract class AbstractSerializationProtocol
extends Object
implements SerializationProtocol, MuleContextAware

Base class for implementations of SerializationProtocol This class implements all the base behavioral contract allowing its extensions to only care about the actual serialization/deserialization part.

Field Summary

Fields

Modifier and Type	Field and Description
protected MuleContext	muleContext

Constructor Summary

Constructors

Constructor and Description
AbstractSerializationProtocol()

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.
protected abstract <T> T	doDeserialize(InputStream inputStream, ClassLoader classLoader) Deserializes the given inputStream using the provided classLoader.
protected abstract byte[]	doSerialize(Object object) Serializes the given object.
protected <T> T	postInitialize(T object)
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
void	setMuleContext(MuleContext context)

Methods inherited from class java.lang.Object

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

Field Detail

muleContext

protected MuleContext muleContext

Constructor Detail

AbstractSerializationProtocol

public AbstractSerializationProtocol()

Method Detail

doSerialize

protected abstract byte[] doSerialize(Object object)
                               throws Exception

Serializes the given object. Should not care about error handling

Parameters:

object - the object to be serialized

Returns:

an array of bytes

Throws:

Exception - any exception thrown. Base class will handle accordingly

doDeserialize

protected abstract <T> T doDeserialize(InputStream inputStream,
                                       ClassLoader classLoader)
                                throws Exception

Deserializes the given inputStream using the provided classLoader. No need to worry about error handling or deserialization post initialization. Base class does all of that automatically

Parameters:

inputStream - an open InputStream, not to be explicitly closed in this method

classLoader - a ClassLoader

Returns:

a deserialized object

Throws:

Exception

serialize

public byte[] serialize(Object object)
                 throws SerializationException

Serializes the given object into a an array of bytes

Specified by:

serialize in interface SerializationProtocol

Parameters:

object - the object to be serialized. Might be null

Returns:

an array of byte

Throws:

IllegalArgumentException - if object is not a Serializable

SerializationException - in case of unexpected exception

serialize

public void serialize(Object object,
                      OutputStream out)
               throws SerializationException

Serializes the given object and writes the result into out

Specified by:

serialize in interface SerializationProtocol

Parameters:

object - the object to be serialized. Might be null

out - an OutputStream where the result will be written

Throws:

IllegalArgumentException - if object is not a Serializable

SerializationException - in case of unexpected exception

deserialize

public <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 DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Implementation will choose the ClassLoader to use for deserialization.

Specified by:

deserialize in interface SerializationProtocol

Parameters:

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

Returns:

the deserialized object

Throws:

SerializationException - in case of unexpected exception

deserialize

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

Deserializes the given bytes.

If the obtained object implements DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Specified by:

deserialize in interface SerializationProtocol

Parameters:

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

classLoader - the ClassLoader to deserialize with

Returns:

the deserialized object

Throws:

SerializationException - in case of unexpected exception

deserialize

public <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 DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Specified by:

deserialize in interface SerializationProtocol

Parameters:

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

Returns:

the deserialized object

Throws:

SerializationException - in case of unexpected exception

deserialize

public <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 DeserializationPostInitialisable then this serializer will be responsible for properly initializing the object before returning it.

Specified by:

deserialize in interface SerializationProtocol

Parameters:

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

classLoader - the ClassLoader to deserialize with

Returns:

the deserialized object

Throws:

SerializationException - in case of unexpected exception

postInitialize

protected <T> T postInitialize(T object)
                        throws SerializationException

Throws:

SerializationException

setMuleContext

public final void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Parameters:

context - the Mule node.