public class JacksonObjectMapperFactoryBean extends java.lang.Object implements FactoryBean<ObjectMapper>, InitializingBean
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>
Note: This BeanFctory is singleton, so if you need more than one, you'll need to configure multiple instances.
Modifier and Type | Field and Description |
---|---|
private AnnotationIntrospector |
annotationIntrospector |
private java.text.DateFormat |
dateFormat |
private java.util.Map<java.lang.Object,java.lang.Boolean> |
features |
private ObjectMapper |
objectMapper |
Constructor and Description |
---|
JacksonObjectMapperFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
ObjectMapper |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector)
Define annotationIntrospector for
SerializationConfig#setAnnotationIntrospector(AnnotationIntrospector) . |
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(java.text.DateFormat dateFormat)
Define the format for date/time with the given
DateFormat instance. |
void |
setFailOnEmptyBeans(boolean failOnEmptyBeans)
Shortcut for
SerializationConfig.Feature#FAIL_ON_EMPTY_BEANS . |
private void |
setFeatureEnabled(java.lang.Object feature,
boolean enabled) |
void |
setFeaturesToDisable(java.lang.Object[] featuresToDisable)
Specify features to disable.
|
void |
setFeaturesToEnable(java.lang.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(java.lang.String format)
Define the date/time format with the given string, which is in turn used
to create a
SimpleDateFormat . |
private ObjectMapper objectMapper
private java.util.Map<java.lang.Object,java.lang.Boolean> features
private AnnotationIntrospector annotationIntrospector
private java.text.DateFormat dateFormat
public void setObjectMapper(ObjectMapper objectMapper)
public void setAnnotationIntrospector(AnnotationIntrospector annotationIntrospector)
SerializationConfig#setAnnotationIntrospector(AnnotationIntrospector)
.public void setSimpleDateFormat(java.lang.String format)
SimpleDateFormat
.setDateFormat(DateFormat)
public void setDateFormat(java.text.DateFormat dateFormat)
DateFormat
instance.setSimpleDateFormat(String)
public void setAutoDetectFields(boolean autoDetectFields)
SerializationConfig.Feature#AUTO_DETECT_FIELDS
and
DeserializationConfig.Feature#AUTO_DETECT_FIELDS
.public void setAutoDetectGettersSetters(boolean autoDetectGettersSetters)
SerializationConfig.Feature#AUTO_DETECT_GETTERS
and
DeserializationConfig.Feature#AUTO_DETECT_SETTERS
.public void setFailOnEmptyBeans(boolean failOnEmptyBeans)
SerializationConfig.Feature#FAIL_ON_EMPTY_BEANS
.public void setIndentOutput(boolean indentOutput)
SerializationConfig.Feature#INDENT_OUTPUT
.public void setFeaturesToEnable(java.lang.Object[] featuresToEnable)
SerializationConfig.Feature
,
DeserializationConfig.Feature
,
JsonParser.Feature
,
JsonGenerator.Feature
public void setFeaturesToDisable(java.lang.Object[] featuresToDisable)
SerializationConfig.Feature
,
DeserializationConfig.Feature
,
JsonParser.Feature
,
JsonGenerator.Feature
public ObjectMapper getObject()
FactoryBean
As with a BeanFactory
, this allows support for both the
Singleton and Prototype design pattern.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding FactoryBeanNotInitializedException
.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
getObject
in interface FactoryBean<ObjectMapper>
null
)FactoryBeanNotInitializedException
public java.lang.Class<?> getObjectType()
FactoryBean
null
if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
getObjectType
in interface FactoryBean<ObjectMapper>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject()
might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
isSingleton
in interface FactoryBean<ObjectMapper>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()
public void afterPropertiesSet() throws FatalBeanException
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
FatalBeanException
InitializingBean.afterPropertiesSet()
private void setFeatureEnabled(java.lang.Object feature, boolean enabled)