org.springframework.integration.json

Class JsonToObjectTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.json.JsonToObjectTransformer

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, NamedComponent, Transformer

public class JsonToObjectTransformer
extends AbstractTransformer
implements org.springframework.beans.factory.BeanClassLoaderAware

Transformer implementation that converts a JSON string payload into an instance of the provided target Class. By default this transformer uses JacksonJsonObjectMapperProvider factory to get an instance of Jackson 1 or Jackson 2 JSON-processor JsonObjectMapper implementation depending on the jackson-databind or jackson-mapper-asl libs on the classpath. Any other JsonObjectMapper implementation can be provided.

Since:

2.0

Author:

Mark Fisher, Artem Bilan

See Also:

JsonObjectMapper, JacksonJsonObjectMapperProvider

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
JsonToObjectTransformer()
JsonToObjectTransformer(java.lang.Class<?> targetClass)
JsonToObjectTransformer(java.lang.Class<?> targetClass, JsonObjectMapper<?> jsonObjectMapper)
JsonToObjectTransformer(java.lang.Class<?> targetClass, java.lang.Object objectMapper) Deprecated. in favor of JsonToObjectTransformer(Class, JsonObjectMapper)
JsonToObjectTransformer(JsonObjectMapper<?> jsonObjectMapper)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	doTransform(Message<?> message) Subclasses must implement this method to provide the transformation logic.
void	setBeanClassLoader(java.lang.ClassLoader classLoader)

Methods inherited from class org.springframework.integration.transformer.AbstractTransformer

transform

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getComponentType, getConversionService, getIntegrationProperties, getIntegrationProperty, getTaskScheduler, onInit, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonToObjectTransformer

public JsonToObjectTransformer()

JsonToObjectTransformer

public JsonToObjectTransformer(java.lang.Class<?> targetClass)

JsonToObjectTransformer

@Deprecated
public JsonToObjectTransformer(java.lang.Class<?> targetClass,
                                  java.lang.Object objectMapper)
                        throws java.lang.ClassNotFoundException

Deprecated. in favor of JsonToObjectTransformer(Class, JsonObjectMapper)

Backward compatibility - allows existing configurations using Jackson 1.x to inject an ObjectMapper directly.

Throws:

java.lang.ClassNotFoundException

JsonToObjectTransformer

public JsonToObjectTransformer(JsonObjectMapper<?> jsonObjectMapper)

JsonToObjectTransformer

public JsonToObjectTransformer(java.lang.Class<?> targetClass,
                       JsonObjectMapper<?> jsonObjectMapper)

Method Detail

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

doTransform

protected java.lang.Object doTransform(Message<?> message)
                                throws java.lang.Exception

Description copied from class: AbstractTransformer

Subclasses must implement this method to provide the transformation logic. If the return value is itself a Message, it will be used as the result. Otherwise, any non-null return value will be used as the payload of the result Message.

Specified by:

doTransform in class AbstractTransformer

Throws:

java.lang.Exception