Jackson2ObjectMapperFactoryBean

<init>

A FactoryBean for creating a Jackson 2.x ObjectMapper (default) or XmlMapper (createXmlMapper property set to true) with setters to enable or disable Jackson features from within XML configuration.

It customizes Jackson defaults properties with the following ones:

• MapperFeature#DEFAULT_VIEW_INCLUSION is disabled
• DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES is disabled

Example usage with MappingJackson2HttpMessageConverter:

 <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> <property name="objectMapper"> <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean" p:autoDetectFields="false" p:autoDetectGettersSetters="false" p:annotationIntrospector-ref="jaxbAnnotationIntrospector" /> </property> </bean> 

Example usage with MappingJackson2JsonView:

 <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"> <property name="objectMapper"> <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean" p:failOnEmptyBeans="false" p:indentOutput="true"> <property name="serializers"> <array> <bean class="org.mycompany.MyCustomSerializer" /> </array> </property> </bean> </property> </bean> 

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

 <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"> <property name="featuresToEnable"> <array> <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/> <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/> </array> </property> <property name="featuresToDisable"> <array> <util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/> </array> </property> </bean> 

It also automatically registers the following well-known modules if they are detected on the classpath:

• jackson-datatype-jdk7: support for Java 7 types like java.nio.file.Path
• jackson-datatype-jdk8: support for other Java 8 types like java.util.Optional
• jackson-datatype-jsr310: support for Java 8 Date & Time API types
• jackson-datatype-joda: support for Joda-Time types
• jackson-module-kotlin: support for Kotlin classes and data classes

In case you want to configure Jackson's ObjectMapper with a custom Module, you can register one or more such Modules by class name via #setModulesToInstall:

 <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"> <property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/> </bean 

Compatible with Jackson 2.6 and higher, as of Spring 4.3.

afterPropertiesSet

getObject

Return the singleton ObjectMapper.

getObjectType

isSingleton

setAnnotationIntrospector

Set an AnnotationIntrospector for both serialization and deserialization.

setApplicationContext

Set the builder ApplicationContext in order to autowire Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).

setAutoDetectFields

Shortcut for MapperFeature#AUTO_DETECT_FIELDS option.

setAutoDetectGettersSetters

Shortcut for MapperFeature#AUTO_DETECT_SETTERS/ MapperFeature#AUTO_DETECT_GETTERS/MapperFeature#AUTO_DETECT_IS_GETTERS options.

setBeanClassLoader

setCreateXmlMapper

If set to true and no custom ObjectMapper has been set, a XmlMapper will be created using its default constructor.

setDateFormat

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

Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.

setDefaultTyping

Specify a TypeResolverBuilder to use for Jackson's default typing.

setDefaultUseWrapper

Define if a wrapper will be used for indexed (List, array) properties or not by default (only applies to XmlMapper).

setDefaultViewInclusion

Shortcut for MapperFeature#DEFAULT_VIEW_INCLUSION option.

setDeserializers

Configure custom deserializers. Each deserializer is registered for the type returned by JsonDeserializer#handledType(), which must not be null.

setDeserializersByType

Configure custom deserializers for the given types.

setFactory

Define the JsonFactory to be used to create the ObjectMapper instance.

setFailOnEmptyBeans

Shortcut for SerializationFeature#FAIL_ON_EMPTY_BEANS option.

setFailOnUnknownProperties

Shortcut for DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES option.

setFeaturesToDisable

Specify features to disable.

setFeaturesToEnable

Specify features to enable.

setFilters

Set the global filters to use in order to support JsonFilter annotated POJO.

setFindModulesViaServiceLoader

Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath. Requires Jackson 2.2 or higher.

If this mode is not set, Spring's Jackson2ObjectMapperFactoryBean itself will try to find the JSR-310 and Joda-Time support modules on the classpath - provided that Java 8 and Joda-Time themselves are available, respectively.

setHandlerInstantiator

Customize the construction of Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).

setIndentOutput

Shortcut for SerializationFeature#INDENT_OUTPUT option.

setLocale

Override the default Locale to use for formatting. Default value used is Locale#getDefault().

setMixIns

Add mix-in annotations to use for augmenting specified class or interface.

setModules

Set a complete list of modules to be registered with the ObjectMapper.

Note: If this is set, no finding of modules is going to happen - not by Jackson, and not by Spring either (see #setFindModulesViaServiceLoader). As a consequence, specifying an empty list here will suppress any kind of module detection.

Specify either this or #setModulesToInstall, not both.

setModulesToInstall

Specify one or more modules by class (or class name in XML) to be registered with the ObjectMapper.

Modules specified here will be registered after Spring's autodetection of JSR-310 and Joda-Time, or Jackson's finding of modules (see #setFindModulesViaServiceLoader), allowing to eventually override their configuration.

Specify either this or #setModules, not both.

setObjectMapper

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

setPropertyNamingStrategy

Specify a com.fasterxml.jackson.databind.PropertyNamingStrategy to configure the ObjectMapper with.

setSerializationInclusion

Set a custom inclusion strategy for serialization.

setSerializers

Configure custom serializers. Each serializer is registered for the type returned by JsonSerializer#handledType(), which must not be null.

setSerializersByType

Configure custom serializers for the given types.

setSimpleDateFormat

Define the date/time format with a SimpleDateFormat.

Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.

setTimeZone

Override the default TimeZone to use for formatting. Default value used is UTC (NOT local timezone).