Package org.camunda.spin.plugin.impl

Class SpinObjectValueSerializer

java.lang.Object

org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer<T>

org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer<ObjectValue>

org.camunda.bpm.engine.impl.variable.serializer.AbstractObjectValueSerializer

org.camunda.spin.plugin.impl.SpinObjectValueSerializer

All Implemented Interfaces:

TypedValueSerializer<ObjectValue>

public class SpinObjectValueSerializer
extends AbstractObjectValueSerializer

Implementation of a TypedValueSerializer for ObjectValues using a Spin-provided DataFormat to serialize and deserialize java objects.

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
protected org.camunda.spin.spi.DataFormat<?>	dataFormat
protected java.lang.String	name
protected org.camunda.spin.DeserializationTypeValidator	validator

Fields inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer

serializationDataFormat

Fields inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer

BINARY_VALUE_TYPES, valueType

Constructor Summary

Constructors

Constructor	Description
SpinObjectValueSerializer(java.lang.String name, org.camunda.spin.spi.DataFormat<?> dataFormat)

Method Summary

Modifier and Type	Method	Description
protected boolean	canSerializeValue(java.lang.Object value)	return true if this serializer is able to serialize the provided object.
protected java.lang.Object	deserializeFromByteArray(byte[] bytes, java.lang.String objectTypeName)	Deserialize the object from a byte array.
java.lang.String	getName()	The name of this serializer.
protected java.lang.String	getTypeNameForDeserialized(java.lang.Object deserializedObject)	Returns the type name for the deserialized object.
protected org.camunda.spin.DeserializationTypeValidator	getValidator(ProcessEngineConfigurationImpl processEngineConfiguration)
protected boolean	isSerializationTextBased()	Return true if the serialization is text based.
protected byte[]	serializeToByteArray(java.lang.Object deserializedObject)	Implementations must return a byte[] representation of the provided object.

Methods inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractObjectValueSerializer

convertToTypedValue, createDeserializedValue, createSerializedValue, deserializeFromByteArray, getObjectTypeName, isMutableValue, readObjectNameFromFields, updateTypedValue, writeToValueFields

Methods inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer

canWriteValue, getSerializationDataformat, getSerializedBytesValue, getSerializedStringValue, readSerializedValueFromFields, readValue, writeValue

Methods inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer

canHandle, getType

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

dataFormat

protected org.camunda.spin.spi.DataFormat<?> dataFormat

validator

protected org.camunda.spin.DeserializationTypeValidator validator

Constructor Detail

SpinObjectValueSerializer

public SpinObjectValueSerializer(java.lang.String name,
                                 org.camunda.spin.spi.DataFormat<?> dataFormat)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TypedValueSerializer

The name of this serializer. The name is used when persisting the ValueFields populated by this serializer.

Returns:

the name of this serializer.

isSerializationTextBased

protected boolean isSerializationTextBased()

Description copied from class: AbstractObjectValueSerializer

Return true if the serialization is text based. Return false otherwise

Specified by:

isSerializationTextBased in class AbstractObjectValueSerializer

getTypeNameForDeserialized

protected java.lang.String getTypeNameForDeserialized(java.lang.Object deserializedObject)

Description copied from class: AbstractObjectValueSerializer

Returns the type name for the deserialized object.

Specified by:

getTypeNameForDeserialized in class AbstractObjectValueSerializer

Parameters:

deserializedObject - . Guaranteed not to be null

Returns:

the type name fot the object.

serializeToByteArray

protected byte[] serializeToByteArray(java.lang.Object deserializedObject)
                               throws java.lang.Exception

Description copied from class: AbstractObjectValueSerializer

Implementations must return a byte[] representation of the provided object. The object is guaranteed not to be null.

Specified by:

serializeToByteArray in class AbstractObjectValueSerializer

Parameters:

deserializedObject - the object to serialize

Returns:

the byte array value of the object

Throws:

java.lang.Exception

deserializeFromByteArray

protected java.lang.Object deserializeFromByteArray(byte[] bytes,
                                                    java.lang.String objectTypeName)
                                             throws java.lang.Exception

Description copied from class: AbstractObjectValueSerializer

Deserialize the object from a byte array.

Specified by:

deserializeFromByteArray in class AbstractObjectValueSerializer

Parameters:

bytes - the object to deserialize

objectTypeName - the type name of the object to deserialize

Returns:

the deserialized object

Throws:

java.lang.Exception

canSerializeValue

protected boolean canSerializeValue(java.lang.Object value)

Description copied from class: AbstractSerializableValueSerializer

return true if this serializer is able to serialize the provided object.

Specified by:

canSerializeValue in class AbstractSerializableValueSerializer<ObjectValue>

Parameters:

value - the object to test (guaranteed to be a non-null value)

Returns:

true if the serializer can handle the object.

getValidator

protected org.camunda.spin.DeserializationTypeValidator getValidator(ProcessEngineConfigurationImpl processEngineConfiguration)