BeanFactory for configuring a Jackson ObjectMapper

The BeanFactory makes it easier to configure a customized Jackson
ObjectMapper (for example enable/disable certain features).
This bean factory is usually used with
MappingJacksonHttpMessageConverter or MappingJacksonJsonView.
See JavaDoc for examples.

Issue: SPR-9125

Author: Dmitry Katsubo

spring-web/src/main/java/org/springframework/web/context/support/JacksonObjectMapperFactoryBean.java

@@ -0,0 +1,250 @@
+/*
+ * Copyright 2002-2012 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.web.context.support;
+
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.codehaus.jackson.JsonGenerator;
+import org.codehaus.jackson.JsonParser;
+import org.codehaus.jackson.map.AnnotationIntrospector;
+import org.codehaus.jackson.map.DeserializationConfig;
+import org.codehaus.jackson.map.ObjectMapper;
+import org.codehaus.jackson.map.SerializationConfig;
+import org.springframework.beans.FatalBeanException;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.InitializingBean;
+
+/**
+ * A FactoryBean for creating a Jackson {@link ObjectMapper} with setters to
+ * enable or disable Jackson features from within XML configuration.
+ *
+ * <p>Example usage with MappingJacksonHttpMessageConverter:</p>
+ * <pre>
+ * &lt;bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
+ * 	&lt;property name="objectMapper">
+ * 		&lt;bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean"
+ * 			p:autoDetectFields="false"
+ * 			p:autoDetectGettersSetters="false"
+ * 			p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
+ * 	&lt;/property>
+ * &lt;/bean>
+ * </pre>
+ *
+ * <p>Example usage with MappingJacksonJsonView:</p>
+ * <pre>
+ * &lt;bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView">
+ * 	&lt;property name="objectMapper">
+ * 		&lt;bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean"
+ * 			p:autoDetectFields="false"
+ * 			p:autoDetectGettersSetters="false"
+ * 			p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
+ * 	&lt;/property>
+ * &lt;/bean>
+ * </pre>
+ *
+ * <p>In case there are no specific setters provided (for some rarely used
+ * options), you can still use the more general methods
+ * {@link #setFeaturesToEnable(Object[])} and {@link #setFeaturesToDisable(Object[])}.
+ *
+ * <pre>
+ * &lt;bean class="org.springframework.web.context.support.JacksonObjectMapperFactoryBean">
+ * 	&lt;property name="featuresToEnable">
+ * 		&lt;array>
+ * 			&lt;util:constant static-field="org.codehaus.jackson.map.SerializationConfig$Feature.WRAP_ROOT_VALUE"/>
+ * 			&lt;util:constant static-field="org.codehaus.jackson.map.SerializationConfig$Feature.CLOSE_CLOSEABLE"/>
+ * 		&lt;/array>
+ * 	&lt;/property>
+ * 	&lt;property name="featuresToDisable">
+ * 		&lt;array>
+ * 			&lt;util:constant static-field="org.codehaus.jackson.map.DeserializationConfig$Feature.USE_ANNOTATIONS"/>
+ * 		&lt;/array>
+ * 	&lt;/property>
+ * &lt;/bean>
+ * </pre>
+ *
+ * <p>Note: This BeanFctory is singleton, so if you need more than one, you'll
+ * need to configure multiple instances.
+ *
+ * @author <a href="mailto:[email protected]">Dmitry Katsubo</a>
+ * @author Rossen Stoyanchev
+ *
+ * @since 3.2
+ */
+public class JacksonObjectMapperFactoryBean implements FactoryBean<ObjectMapper>, InitializingBean {
+
+	private ObjectMapper objectMapper;
+
+	private Map<Object, Boolean> features = new HashMap<Object, Boolean>();
+
+	private AnnotationIntrospector annotationIntrospector;
+
+	private DateFormat dateFormat;
+
+	/**
+	 * Set the ObjectMapper instance to use.
+	 * If not set an instance will be created using the default constructor.
+	 */
+	public void setObjectMapper(ObjectMapper objectMapper) {
+		this.objectMapper = objectMapper;
+	}
+
+	/**
+	 * Define annotationIntrospector for
+	 * {@link SerializationConfig#setAnnotationIntrospector(AnnotationIntrospector)}.
+	 */
+	public void setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector) {
+		this.annotationIntrospector = annotationIntrospector;
+	}
+
+	/**
+	 * Define the date/time format with the given string, which is in turn used
+	 * to create a {@link SimpleDateFormat}.
+	 * @see #setDateFormat(DateFormat)
+	 */
+	public void setSimpleDateFormat(String format) {
+		this.dateFormat = new SimpleDateFormat(format);
+	}
+
+	/**
+	 * Define the format for date/time with the given {@link DateFormat} instance.
+	 * @see #setSimpleDateFormat(String)
+	 */
+	public void setDateFormat(DateFormat dateFormat) {
+		this.dateFormat = dateFormat;
+	}
+
+	/**
+	 * Shortcut for {@link SerializationConfig.Feature#AUTO_DETECT_FIELDS} and
+	 * {@link DeserializationConfig.Feature#AUTO_DETECT_FIELDS}.
+	 */
+	public void setAutoDetectFields(boolean autoDetectFields) {
+		this.features.put(DeserializationConfig.Feature.AUTO_DETECT_FIELDS, Boolean.valueOf(autoDetectFields));
+		this.features.put(SerializationConfig.Feature.AUTO_DETECT_FIELDS, Boolean.valueOf(autoDetectFields));
+	}
+
+	/**
+	 * Shortcut for {@link SerializationConfig.Feature#AUTO_DETECT_GETTERS} and
+	 * {@link DeserializationConfig.Feature#AUTO_DETECT_SETTERS}.
+	 */
+	public void setAutoDetectGettersSetters(boolean autoDetectGettersSetters) {
+		this.features.put(SerializationConfig.Feature.AUTO_DETECT_GETTERS, Boolean.valueOf(autoDetectGettersSetters));
+		this.features.put(DeserializationConfig.Feature.AUTO_DETECT_SETTERS, Boolean.valueOf(autoDetectGettersSetters));
+	}
+
+	/**
+	 * Shortcut for {@link SerializationConfig.Feature#FAIL_ON_EMPTY_BEANS}.
+	 */
+	public void setFailOnEmptyBeans(boolean failOnEmptyBeans) {
+		this.features.put(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, Boolean.valueOf(failOnEmptyBeans));
+	}
+
+	/**
+	 * Shortcut for {@link SerializationConfig.Feature#INDENT_OUTPUT}.
+	 */
+	public void setIndentOutput(boolean indentOutput) {
+		this.features.put(SerializationConfig.Feature.INDENT_OUTPUT, Boolean.valueOf(indentOutput));
+	}
+
+	/**
+	 * Specify features to enable.
+	 * @see SerializationConfig.Feature
+	 * @see DeserializationConfig.Feature
+	 * @see JsonParser.Feature
+	 * @see JsonGenerator.Feature
+	 */
+	public void setFeaturesToEnable(Object[] featuresToEnable) {
+		if (featuresToEnable == null) {
+			throw new FatalBeanException("featuresToEnable property should not be null");
+		}
+		for (Object feature : featuresToEnable) {
+			this.features.put(feature, Boolean.TRUE);
+		}
+	}
+
+	/**
+	 * Specify features to disable.
+	 * @see SerializationConfig.Feature
+	 * @see DeserializationConfig.Feature
+	 * @see JsonParser.Feature
+	 * @see JsonGenerator.Feature
+	 */
+	public void setFeaturesToDisable(Object[] featuresToDisable) {
+		if (featuresToDisable == null) {
+			throw new FatalBeanException("featuresToDisable property should not be null");
+		}
+		for (Object feature : featuresToDisable) {
+			this.features.put(feature, Boolean.FALSE);
+		}
+	}
+
+	public ObjectMapper getObject() {
+		return this.objectMapper;
+	}
+
+	public Class<?> getObjectType() {
+		return ObjectMapper.class;
+	}
+
+	public boolean isSingleton() {
+		return true;
+	}
+
+	/**
+	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
+	 */
+	public void afterPropertiesSet() throws FatalBeanException {
+		if (this.objectMapper == null) {
+			this.objectMapper = new ObjectMapper();
+		}
+
+		if (this.annotationIntrospector != null) {
+			this.objectMapper.getSerializationConfig().setAnnotationIntrospector(annotationIntrospector);
+			this.objectMapper.getDeserializationConfig().setAnnotationIntrospector(annotationIntrospector);
+		}
+
+		if (this.dateFormat != null) {
+			// Deprecated for 1.8+, use
+			// objectMapper.setDateFormat(dateFormat);
+			this.objectMapper.getSerializationConfig().setDateFormat(this.dateFormat);
+		}
+
+		for (Map.Entry<Object, Boolean> entry : features.entrySet()) {
+			setFeatureEnabled(entry.getKey(), entry.getValue().booleanValue());
+		}
+	}
+
+	private void setFeatureEnabled(Object feature, boolean enabled) {
+		if (feature instanceof DeserializationConfig.Feature) {
+			this.objectMapper.configure((DeserializationConfig.Feature) feature, enabled);
+		}
+		else if (feature instanceof SerializationConfig.Feature) {
+			this.objectMapper.configure((SerializationConfig.Feature) feature, enabled);
+		}
+		else if (feature instanceof JsonParser.Feature) {
+			this.objectMapper.configure((JsonParser.Feature) feature, enabled);
+		}
+		else if (feature instanceof JsonGenerator.Feature) {
+			this.objectMapper.configure((JsonGenerator.Feature) feature, enabled);
+		}
+		else {
+			throw new FatalBeanException("Unknown feature class " + feature.getClass().getName());
+		}
+	}
+}