This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 18aa63482affa009015de0644f5250380810cc02
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Tue Oct 29 14:42:46 2019 +0100
CAMEL-14101 - json-jackson dataformat: potential ObjectMapper configuration
clashes
---
.../camel/component/jackson/JacksonDataFormat.java | 1116 ++++++++++----------
.../jackson/JacksonObjectMapperRegistryTest.java | 7 +-
.../camel/model/dataformat/JsonDataFormat.java | 14 +
3 files changed, 590 insertions(+), 547 deletions(-)
diff --git
a/components/camel-jackson/src/main/java/org/apache/camel/component/jackson/JacksonDataFormat.java
b/components/camel-jackson/src/main/java/org/apache/camel/component/jackson/JacksonDataFormat.java
index c412c90..c205e3b 100644
---
a/components/camel-jackson/src/main/java/org/apache/camel/component/jackson/JacksonDataFormat.java
+++
b/components/camel-jackson/src/main/java/org/apache/camel/component/jackson/JacksonDataFormat.java
@@ -53,551 +53,575 @@ import org.apache.camel.support.service.ServiceSupport;
@Dataformat("json-jackson")
public class JacksonDataFormat extends ServiceSupport implements DataFormat,
DataFormatName, CamelContextAware {
- private CamelContext camelContext;
- private ObjectMapper objectMapper;
- private boolean useDefaultObjectMapper = true;
- private Class<? extends Collection> collectionType;
- private List<Module> modules;
- private String moduleClassNames;
- private String moduleRefs;
- private Class<?> unmarshalType;
- private Class<?> jsonView;
- private String include;
- private boolean prettyPrint;
- private boolean allowJmsType;
- private boolean useList;
- private boolean enableJaxbAnnotationModule;
- private String enableFeatures;
- private String disableFeatures;
- private boolean enableJacksonTypeConverter;
- private boolean allowUnmarshallType;
- private boolean contentTypeHeader = true;
- private TimeZone timezone;
-
- /**
- * Use the default Jackson {@link ObjectMapper} and {@link Object}
- */
- public JacksonDataFormat() {
- this(Object.class);
- }
-
- /**
- * Use the default Jackson {@link ObjectMapper} and with a custom unmarshal
- * type
- *
- * @param unmarshalType the custom unmarshal type
- */
- public JacksonDataFormat(Class<?> unmarshalType) {
- this(unmarshalType, null);
- }
-
- /**
- * Use the default Jackson {@link ObjectMapper} and with a custom unmarshal
- * type and JSON view
- *
- * @param unmarshalType the custom unmarshal type
- * @param jsonView marker class to specify properties to be included during
- * marshalling. See also
- * http://wiki.fasterxml.com/JacksonJsonViews
- */
- public JacksonDataFormat(Class<?> unmarshalType, Class<?> jsonView) {
- this(unmarshalType, jsonView, true);
- }
-
- /**
- * Use the default Jackson {@link ObjectMapper} and with a custom unmarshal
- * type and JSON view
- *
- * @param unmarshalType the custom unmarshal type
- * @param jsonView marker class to specify properties to be included during
- * marshalling. See also
- * http://wiki.fasterxml.com/JacksonJsonViews
- * @param enableJaxbAnnotationModule if it is true, will enable the
- * JaxbAnnotationModule.
- */
- public JacksonDataFormat(Class<?> unmarshalType, Class<?> jsonView,
boolean enableJaxbAnnotationModule) {
- this.unmarshalType = unmarshalType;
- this.jsonView = jsonView;
- this.enableJaxbAnnotationModule = enableJaxbAnnotationModule;
- }
-
- /**
- * Use a custom Jackson mapper and and unmarshal type
- *
- * @param mapper the custom mapper
- * @param unmarshalType the custom unmarshal type
- */
- public JacksonDataFormat(ObjectMapper mapper, Class<?> unmarshalType) {
- this(mapper, unmarshalType, null);
- }
-
- /**
- * Use a custom Jackson mapper, unmarshal type and JSON view
- *
- * @param mapper the custom mapper
- * @param unmarshalType the custom unmarshal type
- * @param jsonView marker class to specify properties to be included during
- * marshalling. See also
- * http://wiki.fasterxml.com/JacksonJsonViews
- */
- public JacksonDataFormat(ObjectMapper mapper, Class<?> unmarshalType,
Class<?> jsonView) {
- this.objectMapper = mapper;
- this.unmarshalType = unmarshalType;
- this.jsonView = jsonView;
- }
-
- @Override
- public String getDataFormatName() {
- return "json-jackson";
- }
-
- @Override
- public CamelContext getCamelContext() {
- return camelContext;
- }
-
- @Override
- public void setCamelContext(CamelContext camelContext) {
- this.camelContext = camelContext;
- }
-
- @Override
- public void marshal(Exchange exchange, Object graph, OutputStream stream)
throws Exception {
- this.objectMapper.writerWithView(jsonView).writeValue(stream, graph);
-
- if (contentTypeHeader) {
- if (exchange.hasOut()) {
- exchange.getOut().setHeader(Exchange.CONTENT_TYPE,
"application/json");
- } else {
- exchange.getIn().setHeader(Exchange.CONTENT_TYPE,
"application/json");
- }
- }
- }
-
- @Override
- public Object unmarshal(Exchange exchange, InputStream stream) throws
Exception {
-
- // is there a header with the unmarshal type?
- Class<?> clazz = unmarshalType;
- String type = null;
- if (allowUnmarshallType) {
- type = exchange.getIn().getHeader(JacksonConstants.UNMARSHAL_TYPE,
String.class);
- }
- if (type == null && isAllowJmsType()) {
- type = exchange.getIn().getHeader("JMSType", String.class);
- }
- if (type != null) {
- clazz =
exchange.getContext().getClassResolver().resolveMandatoryClass(type);
- }
- if (collectionType != null) {
- CollectionType collType =
objectMapper.getTypeFactory().constructCollectionType(collectionType, clazz);
- return this.objectMapper.readValue(stream, collType);
- } else {
- return this.objectMapper.readValue(stream, clazz);
- }
- }
-
- // Properties
- //
-------------------------------------------------------------------------
-
- public ObjectMapper getObjectMapper() {
- return this.objectMapper;
- }
-
- public void setObjectMapper(ObjectMapper objectMapper) {
- this.objectMapper = objectMapper;
- }
-
- public boolean isUseDefaultObjectMapper() {
- return useDefaultObjectMapper;
- }
-
- public void setUseDefaultObjectMapper(boolean useDefaultObjectMapper) {
- this.useDefaultObjectMapper = useDefaultObjectMapper;
- }
-
- public Class<?> getUnmarshalType() {
- return this.unmarshalType;
- }
-
- public void setUnmarshalType(Class<?> unmarshalType) {
- this.unmarshalType = unmarshalType;
- }
-
- public Class<? extends Collection> getCollectionType() {
- return collectionType;
- }
-
- public void setCollectionType(Class<? extends Collection> collectionType) {
- this.collectionType = collectionType;
- }
-
- public Class<?> getJsonView() {
- return jsonView;
- }
-
- public void setJsonView(Class<?> jsonView) {
- this.jsonView = jsonView;
- }
-
- public String getInclude() {
- return include;
- }
-
- public void setInclude(String include) {
- this.include = include;
- }
-
- public boolean isAllowJmsType() {
- return allowJmsType;
- }
-
- public boolean isPrettyPrint() {
- return prettyPrint;
- }
-
- public void setPrettyPrint(boolean prettyPrint) {
- this.prettyPrint = prettyPrint;
- }
-
- public boolean isUseList() {
- return useList;
- }
-
- public void setUseList(boolean useList) {
- this.useList = useList;
- }
-
- public boolean isEnableJaxbAnnotationModule() {
- return enableJaxbAnnotationModule;
- }
-
- public void setEnableJaxbAnnotationModule(boolean
enableJaxbAnnotationModule) {
- this.enableJaxbAnnotationModule = enableJaxbAnnotationModule;
- }
-
- public List<Module> getModules() {
- return modules;
- }
-
- /**
- * To use custom Jackson {@link Module}s
- */
- public void setModules(List<Module> modules) {
- this.modules = modules;
- }
-
- public String getModuleClassNames() {
- return moduleClassNames;
- }
-
- /**
- * To use the custom Jackson module
- */
- public void addModule(Module module) {
- if (this.modules == null) {
- this.modules = new ArrayList<>();
- }
- this.modules.add(module);
- }
-
- /**
- * To use custom Jackson {@link Module}s specified as a String with FQN
- * class names. Multiple classes can be separated by comma.
- */
- public void setModuleClassNames(String moduleClassNames) {
- this.moduleClassNames = moduleClassNames;
- }
-
- public String getModuleRefs() {
- return moduleRefs;
- }
-
- /**
- * To use custom Jackson modules referred from the Camel registry. Multiple
- * modules can be separated by comma.
- */
- public void setModuleRefs(String moduleRefs) {
- this.moduleRefs = moduleRefs;
- }
-
- /**
- * Uses {@link java.util.ArrayList} when unmarshalling.
- */
- public void useList() {
- setCollectionType(ArrayList.class);
- }
-
- /**
- * Uses {@link java.util.HashMap} when unmarshalling.
- */
- public void useMap() {
- setCollectionType(null);
- setUnmarshalType(HashMap.class);
- }
-
- /**
- * Allows jackson to use the <tt>JMSType</tt> header as an indicator what
- * the classname is for unmarshaling json content to POJO
- * <p/>
- * By default this option is <tt>false</tt>.
- */
- public void setAllowJmsType(boolean allowJmsType) {
- this.allowJmsType = allowJmsType;
- }
-
- public boolean isEnableJacksonTypeConverter() {
- return enableJacksonTypeConverter;
- }
-
- /**
- * If enabled then Jackson is allowed to attempt to be used during Camels
- * <a href="https://camel.apache.org/type-converter.html";>type
converter</a>
- * as a {@link org.apache.camel.FallbackConverter} that attempts to convert
- * POJOs to/from {@link Map}/{@link List} types.
- * <p/>
- * This should only be enabled when desired to be used.
- */
- public void setEnableJacksonTypeConverter(boolean
enableJacksonTypeConverter) {
- this.enableJacksonTypeConverter = enableJacksonTypeConverter;
- }
-
- public boolean isAllowUnmarshallType() {
- return allowUnmarshallType;
- }
-
- /**
- * If enabled then Jackson is allowed to attempt to use the
- * CamelJacksonUnmarshalType header during the unmarshalling.
- * <p/>
- * This should only be enabled when desired to be used.
- */
- public void setAllowUnmarshallType(boolean allowJacksonUnmarshallType) {
- this.allowUnmarshallType = allowJacksonUnmarshallType;
- }
-
- public boolean isContentTypeHeader() {
- return contentTypeHeader;
- }
-
- /**
- * If enabled then Jackson will set the Content-Type header to
- * <tt>application/json</tt> when marshalling.
- */
- public void setContentTypeHeader(boolean contentTypeHeader) {
- this.contentTypeHeader = contentTypeHeader;
- }
-
- public TimeZone getTimezone() {
- return timezone;
- }
-
- /**
- * If set then Jackson will use the Timezone when
marshalling/unmarshalling.
- */
- public void setTimezone(TimeZone timezone) {
- this.timezone = timezone;
- }
-
- public String getEnableFeatures() {
- return enableFeatures;
- }
-
- /**
- * Set of features to enable on the Jackson {@link ObjectMapper}. The
- * features should be a name that matches a enum from
- * {@link SerializationFeature}, {@link DeserializationFeature}, or
- * {@link MapperFeature}.
- */
- public void setEnableFeatures(String enableFeatures) {
- this.enableFeatures = enableFeatures;
- }
-
- public String getDisableFeatures() {
- return disableFeatures;
- }
-
- /**
- * Set of features to disable on the Jackson {@link ObjectMapper}. The
- * features should be a name that matches a enum from
- * {@link SerializationFeature}, {@link DeserializationFeature}, or
- * {@link MapperFeature}.
- */
- public void setDisableFeatures(String disableFeatures) {
- this.disableFeatures = disableFeatures;
- }
-
- public void enableFeature(SerializationFeature feature) {
- if (enableFeatures == null) {
- enableFeatures = feature.name();
- } else {
- enableFeatures += "," + feature.name();
- }
- }
-
- public void enableFeature(DeserializationFeature feature) {
- if (enableFeatures == null) {
- enableFeatures = feature.name();
- } else {
- enableFeatures += "," + feature.name();
- }
- }
-
- public void enableFeature(MapperFeature feature) {
- if (enableFeatures == null) {
- enableFeatures = feature.name();
- } else {
- enableFeatures += "," + feature.name();
- }
- }
-
- public void disableFeature(SerializationFeature feature) {
- if (disableFeatures == null) {
- disableFeatures = feature.name();
- } else {
- disableFeatures += "," + feature.name();
- }
- }
-
- public void disableFeature(DeserializationFeature feature) {
- if (disableFeatures == null) {
- disableFeatures = feature.name();
- } else {
- disableFeatures += "," + feature.name();
- }
- }
-
- public void disableFeature(MapperFeature feature) {
- if (disableFeatures == null) {
- disableFeatures = feature.name();
- } else {
- disableFeatures += "," + feature.name();
- }
- }
-
- @Override
- protected void doStart() throws Exception {
- if (objectMapper == null) {
- // lookup if there is a single default mapper we can use
- if (useDefaultObjectMapper && camelContext != null) {
- Set<ObjectMapper> set =
camelContext.getRegistry().findByType(ObjectMapper.class);
- if (set.size() == 1) {
- objectMapper = set.iterator().next();
- log.info("Found single ObjectMapper in Registry to use:
{}", objectMapper);
- } else if (set.size() > 1) {
- log.debug("Found {} ObjectMapper in Registry cannot use as
default as there are more than one instance.", set.size());
- }
- }
- if (objectMapper == null) {
- objectMapper = new ObjectMapper();
- log.debug("Creating new ObjectMapper to use: {}",
objectMapper);
- }
- }
-
- if (enableJaxbAnnotationModule) {
- // Enables JAXB processing
- JaxbAnnotationModule module = new JaxbAnnotationModule();
- log.debug("Registering JaxbAnnotationModule: {}", module);
- objectMapper.registerModule(module);
- }
-
- if (useList) {
- setCollectionType(ArrayList.class);
- }
- if (include != null) {
- JsonInclude.Include inc =
getCamelContext().getTypeConverter().mandatoryConvertTo(JsonInclude.Include.class,
include);
- objectMapper.setSerializationInclusion(inc);
- }
- if (prettyPrint) {
- objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
- }
-
- if (enableFeatures != null) {
- Iterator<?> it = ObjectHelper.createIterator(enableFeatures);
- while (it.hasNext()) {
- String enable = it.next().toString();
- // it can be different kind
- SerializationFeature sf =
getCamelContext().getTypeConverter().tryConvertTo(SerializationFeature.class,
enable);
- if (sf != null) {
- objectMapper.enable(sf);
- continue;
- }
- DeserializationFeature df =
getCamelContext().getTypeConverter().tryConvertTo(DeserializationFeature.class,
enable);
- if (df != null) {
- objectMapper.enable(df);
- continue;
- }
- MapperFeature mf =
getCamelContext().getTypeConverter().tryConvertTo(MapperFeature.class, enable);
- if (mf != null) {
- objectMapper.enable(mf);
- continue;
- }
- throw new IllegalArgumentException("Enable feature: " + enable
- + " cannot be converted to
an accepted enum of types
[SerializationFeature,DeserializationFeature,MapperFeature]");
- }
- }
- if (disableFeatures != null) {
- Iterator<?> it = ObjectHelper.createIterator(disableFeatures);
- while (it.hasNext()) {
- String disable = it.next().toString();
- // it can be different kind
- SerializationFeature sf =
getCamelContext().getTypeConverter().tryConvertTo(SerializationFeature.class,
disable);
- if (sf != null) {
- objectMapper.disable(sf);
- continue;
- }
- DeserializationFeature df =
getCamelContext().getTypeConverter().tryConvertTo(DeserializationFeature.class,
disable);
- if (df != null) {
- objectMapper.disable(df);
- continue;
- }
- MapperFeature mf =
getCamelContext().getTypeConverter().tryConvertTo(MapperFeature.class, disable);
- if (mf != null) {
- objectMapper.disable(mf);
- continue;
- }
- throw new IllegalArgumentException("Disable feature: " +
disable
- + " cannot be converted to
an accepted enum of types
[SerializationFeature,DeserializationFeature,MapperFeature]");
- }
- }
-
- if (modules != null) {
- for (Module module : modules) {
- log.debug("Registering module: {}", module);
- objectMapper.registerModules(module);
- }
- }
- if (moduleClassNames != null) {
- Iterable<?> it = ObjectHelper.createIterable(moduleClassNames);
- for (Object o : it) {
- String name = o.toString();
- Class<Module> clazz =
camelContext.getClassResolver().resolveMandatoryClass(name, Module.class);
- Module module = camelContext.getInjector().newInstance(clazz);
- log.debug("Registering module: {} -> {}", name, module);
- objectMapper.registerModule(module);
- }
- }
- if (moduleRefs != null) {
- Iterable<?> it = ObjectHelper.createIterable(moduleRefs);
- for (Object o : it) {
- String name = o.toString();
- if (name.startsWith("#")) {
- name = name.substring(1);
- }
- Module module =
CamelContextHelper.mandatoryLookup(camelContext, name, Module.class);
- log.debug("Registering module: {} -> {}", name, module);
- objectMapper.registerModule(module);
- }
- }
- if (org.apache.camel.util.ObjectHelper.isNotEmpty(timezone)) {
- log.debug("Setting timezone to Object Mapper: {}", timezone);
- objectMapper.setTimeZone(timezone);
- }
- }
-
- @Override
- protected void doStop() throws Exception {
- // noop
- }
+ private CamelContext camelContext;
+ private ObjectMapper objectMapper;
+ private boolean useDefaultObjectMapper = true;
+ private Class<? extends Collection> collectionType;
+ private List<Module> modules;
+ private String moduleClassNames;
+ private String moduleRefs;
+ private Class<?> unmarshalType;
+ private Class<?> jsonView;
+ private String include;
+ private boolean prettyPrint;
+ private boolean allowJmsType;
+ private boolean useList;
+ private boolean enableJaxbAnnotationModule;
+ private String enableFeatures;
+ private String disableFeatures;
+ private boolean enableJacksonTypeConverter;
+ private boolean allowUnmarshallType;
+ private boolean contentTypeHeader = true;
+ private TimeZone timezone;
+ private boolean autoDiscoverObjectMapper;
+
+ /**
+ * Use the default Jackson {@link ObjectMapper} and {@link Object}
+ */
+ public JacksonDataFormat() {
+ this(Object.class);
+ }
+
+ /**
+ * Use the default Jackson {@link ObjectMapper} and with a custom
unmarshal type
+ *
+ * @param unmarshalType the custom unmarshal type
+ */
+ public JacksonDataFormat(Class<?> unmarshalType) {
+ this(unmarshalType, null);
+ }
+
+ /**
+ * Use the default Jackson {@link ObjectMapper} and with a custom
unmarshal type
+ * and JSON view
+ *
+ * @param unmarshalType the custom unmarshal type
+ * @param jsonView marker class to specify properties to be
included during
+ * marshalling. See also
+ * http://wiki.fasterxml.com/JacksonJsonViews
+ */
+ public JacksonDataFormat(Class<?> unmarshalType, Class<?> jsonView) {
+ this(unmarshalType, jsonView, true);
+ }
+
+ /**
+ * Use the default Jackson {@link ObjectMapper} and with a custom
unmarshal type
+ * and JSON view
+ *
+ * @param unmarshalType the custom unmarshal type
+ * @param jsonView marker class to specify properties
to be
+ * included during marshalling. See
also
+ *
http://wiki.fasterxml.com/JacksonJsonViews
+ * @param enableJaxbAnnotationModule if it is true, will enable the
+ * JaxbAnnotationModule.
+ */
+ public JacksonDataFormat(Class<?> unmarshalType, Class<?> jsonView,
boolean enableJaxbAnnotationModule) {
+ this.unmarshalType = unmarshalType;
+ this.jsonView = jsonView;
+ this.enableJaxbAnnotationModule = enableJaxbAnnotationModule;
+ }
+
+ /**
+ * Use a custom Jackson mapper and and unmarshal type
+ *
+ * @param mapper the custom mapper
+ * @param unmarshalType the custom unmarshal type
+ */
+ public JacksonDataFormat(ObjectMapper mapper, Class<?> unmarshalType) {
+ this(mapper, unmarshalType, null);
+ }
+
+ /**
+ * Use a custom Jackson mapper, unmarshal type and JSON view
+ *
+ * @param mapper the custom mapper
+ * @param unmarshalType the custom unmarshal type
+ * @param jsonView marker class to specify properties to be
included during
+ * marshalling. See also
+ * http://wiki.fasterxml.com/JacksonJsonViews
+ */
+ public JacksonDataFormat(ObjectMapper mapper, Class<?> unmarshalType,
Class<?> jsonView) {
+ this.objectMapper = mapper;
+ this.unmarshalType = unmarshalType;
+ this.jsonView = jsonView;
+ }
+
+ @Override
+ public String getDataFormatName() {
+ return "json-jackson";
+ }
+
+ @Override
+ public CamelContext getCamelContext() {
+ return camelContext;
+ }
+
+ @Override
+ public void setCamelContext(CamelContext camelContext) {
+ this.camelContext = camelContext;
+ }
+
+ @Override
+ public void marshal(Exchange exchange, Object graph, OutputStream
stream) throws Exception {
+ this.objectMapper.writerWithView(jsonView).writeValue(stream,
graph);
+
+ if (contentTypeHeader) {
+ if (exchange.hasOut()) {
+
exchange.getOut().setHeader(Exchange.CONTENT_TYPE, "application/json");
+ } else {
+
exchange.getIn().setHeader(Exchange.CONTENT_TYPE, "application/json");
+ }
+ }
+ }
+
+ @Override
+ public Object unmarshal(Exchange exchange, InputStream stream) throws
Exception {
+
+ // is there a header with the unmarshal type?
+ Class<?> clazz = unmarshalType;
+ String type = null;
+ if (allowUnmarshallType) {
+ type =
exchange.getIn().getHeader(JacksonConstants.UNMARSHAL_TYPE, String.class);
+ }
+ if (type == null && isAllowJmsType()) {
+ type = exchange.getIn().getHeader("JMSType",
String.class);
+ }
+ if (type != null) {
+ clazz =
exchange.getContext().getClassResolver().resolveMandatoryClass(type);
+ }
+ if (collectionType != null) {
+ CollectionType collType =
objectMapper.getTypeFactory().constructCollectionType(collectionType, clazz);
+ return this.objectMapper.readValue(stream, collType);
+ } else {
+ return this.objectMapper.readValue(stream, clazz);
+ }
+ }
+
+ // Properties
+ //
-------------------------------------------------------------------------
+
+ public ObjectMapper getObjectMapper() {
+ return this.objectMapper;
+ }
+
+ public void setObjectMapper(ObjectMapper objectMapper) {
+ this.objectMapper = objectMapper;
+ }
+
+ public boolean isUseDefaultObjectMapper() {
+ return useDefaultObjectMapper;
+ }
+
+ public void setUseDefaultObjectMapper(boolean useDefaultObjectMapper) {
+ this.useDefaultObjectMapper = useDefaultObjectMapper;
+ }
+
+ public Class<?> getUnmarshalType() {
+ return this.unmarshalType;
+ }
+
+ public void setUnmarshalType(Class<?> unmarshalType) {
+ this.unmarshalType = unmarshalType;
+ }
+
+ public Class<? extends Collection> getCollectionType() {
+ return collectionType;
+ }
+
+ public void setCollectionType(Class<? extends Collection>
collectionType) {
+ this.collectionType = collectionType;
+ }
+
+ public Class<?> getJsonView() {
+ return jsonView;
+ }
+
+ public void setJsonView(Class<?> jsonView) {
+ this.jsonView = jsonView;
+ }
+
+ public String getInclude() {
+ return include;
+ }
+
+ public void setInclude(String include) {
+ this.include = include;
+ }
+
+ public boolean isAllowJmsType() {
+ return allowJmsType;
+ }
+
+ public boolean isPrettyPrint() {
+ return prettyPrint;
+ }
+
+ public void setPrettyPrint(boolean prettyPrint) {
+ this.prettyPrint = prettyPrint;
+ }
+
+ public boolean isUseList() {
+ return useList;
+ }
+
+ public void setUseList(boolean useList) {
+ this.useList = useList;
+ }
+
+ public boolean isEnableJaxbAnnotationModule() {
+ return enableJaxbAnnotationModule;
+ }
+
+ public void setEnableJaxbAnnotationModule(boolean
enableJaxbAnnotationModule) {
+ this.enableJaxbAnnotationModule = enableJaxbAnnotationModule;
+ }
+
+ public List<Module> getModules() {
+ return modules;
+ }
+
+ /**
+ * To use custom Jackson {@link Module}s
+ */
+ public void setModules(List<Module> modules) {
+ this.modules = modules;
+ }
+
+ public String getModuleClassNames() {
+ return moduleClassNames;
+ }
+
+ /**
+ * To use the custom Jackson module
+ */
+ public void addModule(Module module) {
+ if (this.modules == null) {
+ this.modules = new ArrayList<>();
+ }
+ this.modules.add(module);
+ }
+
+ /**
+ * To use custom Jackson {@link Module}s specified as a String with FQN
class
+ * names. Multiple classes can be separated by comma.
+ */
+ public void setModuleClassNames(String moduleClassNames) {
+ this.moduleClassNames = moduleClassNames;
+ }
+
+ public String getModuleRefs() {
+ return moduleRefs;
+ }
+
+ /**
+ * To use custom Jackson modules referred from the Camel registry.
Multiple
+ * modules can be separated by comma.
+ */
+ public void setModuleRefs(String moduleRefs) {
+ this.moduleRefs = moduleRefs;
+ }
+
+ /**
+ * Uses {@link java.util.ArrayList} when unmarshalling.
+ */
+ public void useList() {
+ setCollectionType(ArrayList.class);
+ }
+
+ /**
+ * Uses {@link java.util.HashMap} when unmarshalling.
+ */
+ public void useMap() {
+ setCollectionType(null);
+ setUnmarshalType(HashMap.class);
+ }
+
+ /**
+ * Allows jackson to use the <tt>JMSType</tt> header as an indicator
what the
+ * classname is for unmarshaling json content to POJO
+ * <p/>
+ * By default this option is <tt>false</tt>.
+ */
+ public void setAllowJmsType(boolean allowJmsType) {
+ this.allowJmsType = allowJmsType;
+ }
+
+ public boolean isEnableJacksonTypeConverter() {
+ return enableJacksonTypeConverter;
+ }
+
+ /**
+ * If enabled then Jackson is allowed to attempt to be used during
Camels
+ * <a href="https://camel.apache.org/type-converter.html";>type
converter</a> as
+ * a {@link org.apache.camel.FallbackConverter} that attempts to
convert POJOs
+ * to/from {@link Map}/{@link List} types.
+ * <p/>
+ * This should only be enabled when desired to be used.
+ */
+ public void setEnableJacksonTypeConverter(boolean
enableJacksonTypeConverter) {
+ this.enableJacksonTypeConverter = enableJacksonTypeConverter;
+ }
+
+ public boolean isAllowUnmarshallType() {
+ return allowUnmarshallType;
+ }
+
+ /**
+ * If enabled then Jackson is allowed to attempt to use the
+ * CamelJacksonUnmarshalType header during the unmarshalling.
+ * <p/>
+ * This should only be enabled when desired to be used.
+ */
+ public void setAllowUnmarshallType(boolean allowJacksonUnmarshallType) {
+ this.allowUnmarshallType = allowJacksonUnmarshallType;
+ }
+
+ public boolean isContentTypeHeader() {
+ return contentTypeHeader;
+ }
+
+ /**
+ * If enabled then Jackson will set the Content-Type header to
+ * <tt>application/json</tt> when marshalling.
+ */
+ public void setContentTypeHeader(boolean contentTypeHeader) {
+ this.contentTypeHeader = contentTypeHeader;
+ }
+
+ public TimeZone getTimezone() {
+ return timezone;
+ }
+
+ /**
+ * If set then Jackson will use the Timezone when
marshalling/unmarshalling.
+ */
+ public void setTimezone(TimeZone timezone) {
+ this.timezone = timezone;
+ }
+
+ public boolean isAutoDiscoverObjectMapper() {
+ return autoDiscoverObjectMapper;
+ }
+
+ /**
+ * If set to true then Jackson will lookup for an objectMapper into the
registry
+ */
+ public void setAutoDiscoverObjectMapper(boolean
autoDiscoverObjectMapper) {
+ this.autoDiscoverObjectMapper = autoDiscoverObjectMapper;
+ }
+
+ public String getEnableFeatures() {
+ return enableFeatures;
+ }
+
+ /**
+ * Set of features to enable on the Jackson {@link ObjectMapper}. The
features
+ * should be a name that matches a enum from {@link
SerializationFeature},
+ * {@link DeserializationFeature}, or {@link MapperFeature}.
+ */
+ public void setEnableFeatures(String enableFeatures) {
+ this.enableFeatures = enableFeatures;
+ }
+
+ public String getDisableFeatures() {
+ return disableFeatures;
+ }
+
+ /**
+ * Set of features to disable on the Jackson {@link ObjectMapper}. The
features
+ * should be a name that matches a enum from {@link
SerializationFeature},
+ * {@link DeserializationFeature}, or {@link MapperFeature}.
+ */
+ public void setDisableFeatures(String disableFeatures) {
+ this.disableFeatures = disableFeatures;
+ }
+
+ public void enableFeature(SerializationFeature feature) {
+ if (enableFeatures == null) {
+ enableFeatures = feature.name();
+ } else {
+ enableFeatures += "," + feature.name();
+ }
+ }
+
+ public void enableFeature(DeserializationFeature feature) {
+ if (enableFeatures == null) {
+ enableFeatures = feature.name();
+ } else {
+ enableFeatures += "," + feature.name();
+ }
+ }
+
+ public void enableFeature(MapperFeature feature) {
+ if (enableFeatures == null) {
+ enableFeatures = feature.name();
+ } else {
+ enableFeatures += "," + feature.name();
+ }
+ }
+
+ public void disableFeature(SerializationFeature feature) {
+ if (disableFeatures == null) {
+ disableFeatures = feature.name();
+ } else {
+ disableFeatures += "," + feature.name();
+ }
+ }
+
+ public void disableFeature(DeserializationFeature feature) {
+ if (disableFeatures == null) {
+ disableFeatures = feature.name();
+ } else {
+ disableFeatures += "," + feature.name();
+ }
+ }
+
+ public void disableFeature(MapperFeature feature) {
+ if (disableFeatures == null) {
+ disableFeatures = feature.name();
+ } else {
+ disableFeatures += "," + feature.name();
+ }
+ }
+
+ @Override
+ protected void doStart() throws Exception {
+ boolean objectMapperFoundRegistry = false;
+ if (objectMapper == null) {
+ // lookup if there is a single default mapper we can use
+ if (useDefaultObjectMapper && camelContext != null) {
+ if (isAutoDiscoverObjectMapper()) {
+ Set<ObjectMapper> set =
camelContext.getRegistry().findByType(ObjectMapper.class);
+ if (set.size() == 1) {
+ objectMapper =
set.iterator().next();
+ log.info("Found single
ObjectMapper in Registry to use: {}", objectMapper);
+ objectMapperFoundRegistry =
true;
+ } else if (set.size() > 1) {
+ log.debug(
+ "Found {}
ObjectMapper in Registry cannot use as default as there are more than one
instance.",
+ set.size());
+ }
+ } else {
+ log.warn("The option
autoDiscoverObjectMapper is set to false, Camel won't search in the registry");
+ }
+ }
+ if (objectMapper == null) {
+ objectMapper = new ObjectMapper();
+ log.debug("Creating new ObjectMapper to use:
{}", objectMapper);
+ }
+ }
+
+ if (!objectMapperFoundRegistry) {
+ if (enableJaxbAnnotationModule) {
+ // Enables JAXB processing
+ JaxbAnnotationModule module = new
JaxbAnnotationModule();
+ log.debug("Registering JaxbAnnotationModule:
{}", module);
+ objectMapper.registerModule(module);
+ }
+
+ if (useList) {
+ setCollectionType(ArrayList.class);
+ }
+ if (include != null) {
+ JsonInclude.Include inc =
getCamelContext().getTypeConverter()
+
.mandatoryConvertTo(JsonInclude.Include.class, include);
+ objectMapper.setSerializationInclusion(inc);
+ }
+ if (prettyPrint) {
+
objectMapper.enable(SerializationFeature.INDENT_OUTPUT);
+ }
+
+ if (enableFeatures != null) {
+ Iterator<?> it =
ObjectHelper.createIterator(enableFeatures);
+ while (it.hasNext()) {
+ String enable = it.next().toString();
+ // it can be different kind
+ SerializationFeature sf =
getCamelContext().getTypeConverter()
+
.tryConvertTo(SerializationFeature.class, enable);
+ if (sf != null) {
+ objectMapper.enable(sf);
+ continue;
+ }
+ DeserializationFeature df =
getCamelContext().getTypeConverter()
+
.tryConvertTo(DeserializationFeature.class, enable);
+ if (df != null) {
+ objectMapper.enable(df);
+ continue;
+ }
+ MapperFeature mf =
getCamelContext().getTypeConverter().tryConvertTo(MapperFeature.class, enable);
+ if (mf != null) {
+ objectMapper.enable(mf);
+ continue;
+ }
+ throw new
IllegalArgumentException("Enable feature: " + enable
+ + " cannot be converted
to an accepted enum of types
[SerializationFeature,DeserializationFeature,MapperFeature]");
+ }
+ }
+ if (disableFeatures != null) {
+ Iterator<?> it =
ObjectHelper.createIterator(disableFeatures);
+ while (it.hasNext()) {
+ String disable = it.next().toString();
+ // it can be different kind
+ SerializationFeature sf =
getCamelContext().getTypeConverter()
+
.tryConvertTo(SerializationFeature.class, disable);
+ if (sf != null) {
+ objectMapper.disable(sf);
+ continue;
+ }
+ DeserializationFeature df =
getCamelContext().getTypeConverter()
+
.tryConvertTo(DeserializationFeature.class, disable);
+ if (df != null) {
+ objectMapper.disable(df);
+ continue;
+ }
+ MapperFeature mf =
getCamelContext().getTypeConverter().tryConvertTo(MapperFeature.class, disable);
+ if (mf != null) {
+ objectMapper.disable(mf);
+ continue;
+ }
+ throw new
IllegalArgumentException("Disable feature: " + disable
+ + " cannot be converted
to an accepted enum of types
[SerializationFeature,DeserializationFeature,MapperFeature]");
+ }
+ }
+
+ if (modules != null) {
+ for (Module module : modules) {
+ log.debug("Registering module: {}",
module);
+ objectMapper.registerModules(module);
+ }
+ }
+ if (moduleClassNames != null) {
+ Iterable<?> it =
ObjectHelper.createIterable(moduleClassNames);
+ for (Object o : it) {
+ String name = o.toString();
+ Class<Module> clazz =
camelContext.getClassResolver().resolveMandatoryClass(name, Module.class);
+ Module module =
camelContext.getInjector().newInstance(clazz);
+ log.debug("Registering module: {} ->
{}", name, module);
+ objectMapper.registerModule(module);
+ }
+ }
+ if (moduleRefs != null) {
+ Iterable<?> it =
ObjectHelper.createIterable(moduleRefs);
+ for (Object o : it) {
+ String name = o.toString();
+ if (name.startsWith("#")) {
+ name = name.substring(1);
+ }
+ Module module =
CamelContextHelper.mandatoryLookup(camelContext, name, Module.class);
+ log.debug("Registering module: {} ->
{}", name, module);
+ objectMapper.registerModule(module);
+ }
+ }
+ if
(org.apache.camel.util.ObjectHelper.isNotEmpty(timezone)) {
+ log.debug("Setting timezone to Object Mapper:
{}", timezone);
+ objectMapper.setTimeZone(timezone);
+ }
+ }
+ }
+
+ @Override
+ protected void doStop() throws Exception {
+ // noop
+ }
}
diff --git
a/components/camel-jackson/src/test/java/org/apache/camel/component/jackson/JacksonObjectMapperRegistryTest.java
b/components/camel-jackson/src/test/java/org/apache/camel/component/jackson/JacksonObjectMapperRegistryTest.java
index 9eac4be..fc106ba 100644
---
a/components/camel-jackson/src/test/java/org/apache/camel/component/jackson/JacksonObjectMapperRegistryTest.java
+++
b/components/camel-jackson/src/test/java/org/apache/camel/component/jackson/JacksonObjectMapperRegistryTest.java
@@ -16,6 +16,7 @@
*/
package org.apache.camel.component.jackson;
+import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
@@ -25,11 +26,12 @@ import org.apache.camel.BindToRegistry;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.component.mock.MockEndpoint;
import org.apache.camel.test.junit4.CamelTestSupport;
+import org.junit.Before;
import org.junit.Test;
public class JacksonObjectMapperRegistryTest extends CamelTestSupport {
- private JacksonDataFormat df = new JacksonDataFormat();
+ private JacksonDataFormat df;
@BindToRegistry("myMapper")
private ObjectMapper objectMapper = new ObjectMapper();
@@ -60,6 +62,9 @@ public class JacksonObjectMapperRegistryTest extends
CamelTestSupport {
return new RouteBuilder() {
@Override
public void configure() throws Exception {
+ df = new JacksonDataFormat();
+ df.setAutoDiscoverObjectMapper(true);
+
from("direct:in").marshal(df);
from("direct:back").unmarshal(df).to("mock:reverse");
}
diff --git
a/core/camel-core-engine/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java
b/core/camel-core-engine/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java
index 5f77a15..cde365e 100644
---
a/core/camel-core-engine/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java
+++
b/core/camel-core-engine/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java
@@ -76,6 +76,9 @@ public class JsonDataFormat extends DataFormatDefinition {
private Boolean allowUnmarshallType;
@XmlAttribute
private String timezone;
+ @XmlAttribute
+ private boolean autoDiscoverObjectMapper;
+
public JsonDataFormat() {
super("json");
@@ -365,6 +368,17 @@ public class JsonDataFormat extends DataFormatDefinition {
public void setTimezone(String timezone) {
this.timezone = timezone;
}
+
+ public boolean isAutoDiscoverObjectMapper() {
+ return autoDiscoverObjectMapper;
+ }
+
+ /**
+ * If set to true then Jackson will lookup for an objectMapper into the
registry
+ */
+ public void setAutoDiscoverObjectMapper(boolean
autoDiscoverObjectMapper) {
+ this.autoDiscoverObjectMapper = autoDiscoverObjectMapper;
+ }
@Override
public String getDataFormatName() {
