org.springframework.http.converter.json

Class JacksonObjectMapperFactoryBean

java.lang.Object

org.springframework.http.converter.json.JacksonObjectMapperFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<ObjectMapper>, org.springframework.beans.factory.InitializingBean

public class JacksonObjectMapperFactoryBean
extends Object
implements org.springframework.beans.factory.FactoryBean<ObjectMapper>, org.springframework.beans.factory.InitializingBean

A FactoryBean for creating a Jackson ObjectMapper with setters to enable or disable Jackson features from within XML configuration.

Example usage with MappingJacksonHttpMessageConverter:

 <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
        <property name="objectMapper">
                <bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean"
                        p:autoDetectFields="false"
                        p:autoDetectGettersSetters="false"
                        p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
        </property>
 </bean>
 

Example usage with MappingJacksonJsonView:

 <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView">
        <property name="objectMapper">
                <bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean"
                        p:autoDetectFields="false"
                        p:autoDetectGettersSetters="false"
                        p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
        </property>
 </bean>
 

In case there are no specific setters provided (for some rarely used options), you can still use the more general methods setFeaturesToEnable(Object[]) and setFeaturesToDisable(Object[]).

 <bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean">
        <property name="featuresToEnable">
                <array>
                        <util:constant static-field="org.codehaus.jackson.map.SerializationConfig$Feature.WRAP_ROOT_VALUE"/>
                        <util:constant static-field="org.codehaus.jackson.map.SerializationConfig$Feature.CLOSE_CLOSEABLE"/>
                </array>
        </property>
        <property name="featuresToDisable">
                <array>
                        <util:constant static-field="org.codehaus.jackson.map.DeserializationConfig$Feature.USE_ANNOTATIONS"/>
                </array>
        </property>
 </bean>
 

Since:

3.2

Author:

Dmitry Katsubo, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
JacksonObjectMapperFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
ObjectMapper	getObject() Return the singleton ObjectMapper.
Class<?>	getObjectType()
boolean	isSingleton()
void	setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector) Set the AnnotationIntrospector for serialization and deserialization.
void	setAutoDetectFields(boolean autoDetectFields) Shortcut for SerializationConfig.Feature.AUTO_DETECT_FIELDS and DeserializationConfig.Feature.AUTO_DETECT_FIELDS.
void	setAutoDetectGettersSetters(boolean autoDetectGettersSetters) Shortcut for SerializationConfig.Feature.AUTO_DETECT_GETTERS and DeserializationConfig.Feature.AUTO_DETECT_SETTERS.
void	setDateFormat(DateFormat dateFormat) Define the format for date/time with the given DateFormat.
void	setFailOnEmptyBeans(boolean failOnEmptyBeans) Shortcut for SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS.
void	setFeaturesToDisable(Object[] featuresToDisable) Specify features to disable.
void	setFeaturesToEnable(Object[] featuresToEnable) Specify features to enable.
void	setIndentOutput(boolean indentOutput) Shortcut for SerializationConfig.Feature.INDENT_OUTPUT.
void	setObjectMapper(ObjectMapper objectMapper) Set the ObjectMapper instance to use.
void	setSimpleDateFormat(String format) Define the date/time format with a SimpleDateFormat.

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonObjectMapperFactoryBean

public JacksonObjectMapperFactoryBean()

Method Detail

setObjectMapper

public void setObjectMapper(ObjectMapper objectMapper)

Set the ObjectMapper instance to use. If not set an instance will be created using the default constructor.

setDateFormat

public void setDateFormat(DateFormat dateFormat)

Define the format for date/time with the given DateFormat.

See Also:

setSimpleDateFormat(String)

setSimpleDateFormat

public void setSimpleDateFormat(String format)

Define the date/time format with a SimpleDateFormat.

See Also:

setDateFormat(DateFormat)

setAnnotationIntrospector

public void setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector)

Set the AnnotationIntrospector for serialization and deserialization.

See Also:

SerializationConfig.setAnnotationIntrospector(AnnotationIntrospector), DeserializationConfig.setAnnotationIntrospector(AnnotationIntrospector)

setAutoDetectFields

public void setAutoDetectFields(boolean autoDetectFields)

Shortcut for SerializationConfig.Feature.AUTO_DETECT_FIELDS and DeserializationConfig.Feature.AUTO_DETECT_FIELDS.

setAutoDetectGettersSetters

public void setAutoDetectGettersSetters(boolean autoDetectGettersSetters)

Shortcut for SerializationConfig.Feature.AUTO_DETECT_GETTERS and DeserializationConfig.Feature.AUTO_DETECT_SETTERS.

setFailOnEmptyBeans

public void setFailOnEmptyBeans(boolean failOnEmptyBeans)

Shortcut for SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS.

setIndentOutput

public void setIndentOutput(boolean indentOutput)

Shortcut for SerializationConfig.Feature.INDENT_OUTPUT.

setFeaturesToEnable

public void setFeaturesToEnable(Object[] featuresToEnable)

Specify features to enable.

See Also:

SerializationConfig.Feature, DeserializationConfig.Feature, JsonParser.Feature, JsonGenerator.Feature

setFeaturesToDisable

public void setFeaturesToDisable(Object[] featuresToDisable)

Specify features to disable.

See Also:

SerializationConfig.Feature, DeserializationConfig.Feature, JsonParser.Feature, JsonGenerator.Feature

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

getObject

public ObjectMapper getObject()

Return the singleton ObjectMapper.

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<ObjectMapper>

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<ObjectMapper>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<ObjectMapper>