org.springframework.amqp.support.converter

Class DefaultClassMapper

java.lang.Object

org.springframework.amqp.support.converter.DefaultClassMapper

All Implemented Interfaces:

ClassMapper, org.springframework.beans.factory.InitializingBean

public class DefaultClassMapper
extends java.lang.Object
implements ClassMapper, org.springframework.beans.factory.InitializingBean

Maps to/from JSON using type information in the MessageProperties; the default name of the message property containing the type is "__TypeId__". An optional property setDefaultType(Class) is provided that allows mapping to a statically defined type, if no message property is found in the message properties. setIdClassMapping(Map) can be used to map tokens in the "__TypeId__" header to classes. If this class is not a Spring-managed bean, call afterPropertiesSet() to set up the class to id mapping.

Author:

Mark Pollack, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CLASSID_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultClassMapper()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	fromClass(java.lang.Class<?> clazz, MessageProperties properties)
java.lang.String	getClassIdFieldName() The name of the header that contains the type id.
void	setDefaultMapClass(java.lang.Class<?> defaultMapClass) Set the type of Map to use.
void	setDefaultType(java.lang.Class<?> defaultType) The type returned by toClass(MessageProperties) if no type information is found in the message properties.
void	setIdClassMapping(java.util.Map<java.lang.String,java.lang.Class<?>> idClassMapping) Set a map of type Ids (in the "__TypeId__" header) to classes.
void	setTrustedPackages(java.lang.String... trustedPackages) Specify a set of packages to trust during deserialization.
java.lang.Class<?>	toClass(MessageProperties properties)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLASSID_FIELD_NAME

public static final java.lang.String DEFAULT_CLASSID_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultClassMapper

public DefaultClassMapper()

Method Detail

setDefaultType

public void setDefaultType(java.lang.Class<?> defaultType)

The type returned by toClass(MessageProperties) if no type information is found in the message properties.

Parameters:

defaultType - the defaultType to set.

setDefaultMapClass

public void setDefaultMapClass(java.lang.Class<?> defaultMapClass)

Set the type of Map to use. For outbound messages, set the "__TypeId__" header to HashTable. For inbound messages, if the "__TypeId__" header is Hashtable convert to this class.

Parameters:

defaultMapClass - the map class.

Since:

2.0

See Also:

DEFAULT_CLASSID_FIELD_NAME

getClassIdFieldName

public java.lang.String getClassIdFieldName()

The name of the header that contains the type id.

Returns:

"__TypeId__"

See Also:

DEFAULT_CLASSID_FIELD_NAME

setIdClassMapping

public void setIdClassMapping(java.util.Map<java.lang.String,java.lang.Class<?>> idClassMapping)

Set a map of type Ids (in the "__TypeId__" header) to classes. For outbound messages, if the class is not in this map, the "__TypeId__" header is set to the fully qualified class name.

Parameters:

idClassMapping - the map of IDs to classes.

setTrustedPackages

public void setTrustedPackages(java.lang.String... trustedPackages)

Specify a set of packages to trust during deserialization. The asterisk (*) means trust all.

Parameters:

trustedPackages - the trusted Java packages for deserialization

Since:

1.6.11

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Creates the reverse mapping from class to type id.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

fromClass

public void fromClass(java.lang.Class<?> clazz,
                      MessageProperties properties)

Specified by:

fromClass in interface ClassMapper

toClass

public java.lang.Class<?> toClass(MessageProperties properties)

Specified by:

toClass in interface ClassMapper