[CONF] Apache Camel JSON
Claus Ibsen edited the page:
JSON
...
Code Block
language
xml
from uri=direct:inPojoAgeView/
marshal
json library=Jackson unmarshalTypeName=org.apache.camel.component.jackson.TestPojoView jsonView=org.apache.camel.component.jackson.Views$Age/
/marshal
Setting serialization include option for Jackson marshal
Available as of Camel 2.13.3/2.14
If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, then you need to set either an annotation on the pojo,
Code Block
@JsonInclude(Include.NON_NULL)
public class MyPojo {
...
}
But this requires you to include that annotation in your pojo source code. You can also configure the Camel JsonDataFormat to set the include option, as shown below:
Code Block
JacksonDataFormat format = new
[CONF] Apache Camel JSON
Claus Ibsen edited the page: JSON ... Code Block dataFormats json id=json library=Jackson include=NOT_NULL/ /dataFormats Unmarshalling from json to POJO with dynamic class name Available as of Camel 2.14 If you use jackson to unmarshal json to POJO, then you can now specify a header in the message that indicate which class name to unmarshal to. The header has key CamelJacksonUnmarshalTypeif that header is present in the message, then Jackson will use that as FQN for the POJO class to unmarshal the json payload as. Notice that behavior is enabled out of the box from Camel 2.14 onwards. For JMS end users there is the JMSType header from the JMS spec that indicates that also. To enable support for JMSType you would need to turn that on, on the jackson data format as shown: Code Block JacksonDataFormat format = new JacksonDataFormat(); format.setAllowJmsType(true); Or from XML DSL you configure this as Code Block dataFormats json id=json library=Jackson allowJmsType=true/ /dataFormats Dependencies for XStream To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format. ...
[CONF] Apache Camel JSON
willem jiang edited the page:
JSON
Comment: Fix the typo of JSON
...
Note that the weight field is missing in the resulting JSON:
Code Block
{age:30, heightweight:19070}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
...
View Online Like View Changes
Stop watching space Manage Notifications
This message was sent by Atlassian Confluence 5.0.3, Team Collaboration Software
[CONF] Apache Camel JSON
Daniel Kulp edited the page: JSON ... Then we can configure the org.apache.camel.component.gson.GsonDataFormat in a Spring XML files as shown below. Notice we use fieldNamingPolicy property to set the field mapping. This property is an enum from GSon com.google.gson.FieldNamingPolicy which has a number of pre defined mappings. If you need full control you can use the property FieldNamingStrategy and implement a custom com.google.gson.FieldNamingStrategy where you can control the mapping. Code Block title Configuring GsonDataFromat in Spring XML file xml:title Configuring GsonDataFormat in Spring XML file language xml !-- define the gson data format, where we configure the data format using the properties -- bean id=gson class=org.apache.camel.component.gson.GsonDataFormat !-- we want to unmarshal to person pojo -- property name=unmarshalType value=org.apache.camel.component.gson.PersonPojo/ !-- we want to map fields to use lower case and underscores -- property name=fieldNamingPolicy value=LOWER_CASE_WITH_UNDERSCORES/ /bean And use it in Camel routes by referring to its bean id as shown: Code Block
[CONF] Apache Camel JSON
JSON
Page edited by Babak Vahdat
Changes (1)
...
h3. Include/Exclude fields using the {{jsonView}} attribute with {{JacksonDataFormat}} *Available as of Camel 2.12* As an example of using this attribute you can instead of: {code:java} JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class); from(direct:inPojoAgeView). marshal(ageViewFormat); {code} Directly specify the [JSON view|http://wiki.fasterxml.com/JacksonJsonViews] inside the Java DSL as: {code:java} from(direct:inPojoAgeView). marshal().json(TestPojoView.class, Views.Age.class); {code} And the same in XML DSL: {code:java} from uri=direct:inPojoAgeView/ marshal json library=Jackson unmarshalTypeName=org.apache.camel.component.jackson.TestPojoView jsonView=org.apache.camel.component.jackson.Views$Age/ /marshal {code}
h3. Dependencies for XStream
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Direct, bi-directional JSON = XML conversionsAs of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the camel-xmljson data format, which is documented separately.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Configuring field naming policy
Available as of Camel 2.11
The GSON library supports specifying policies and strategies for mapping from json to POJO fields. A common naming convention is to map json fields using lower case with underscores.
We may have this JSON string
[CONF] Apache Camel JSON
JSON
Page edited by Babak Vahdat
Changes (1)
...
{code}
Directly specify the your [JSON view|http://wiki.fasterxml.com/JacksonJsonViews] inside the Java DSL as:
{code:java}
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Direct, bi-directional JSON = XML conversionsAs of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the camel-xmljson data format, which is documented separately.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Configuring field naming policy
Available as of Camel 2.11
The GSON library supports specifying policies and strategies for mapping from json to POJO fields. A common naming convention is to map json fields using lower case with underscores.
We may have this JSON string
{
"id" : 123,
"first_name" : "Donald"
"last_name" : "Duck"
}
Which we want to map to a POJO that has getter/setters as
public class PersonPojo {
private int id;
private String firstName;
private String lastName;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
}
Then we can configure the
[CONF] Apache Camel JSON
JSON
Page edited by Claus Ibsen
Changes (1)
...
The line above will exclude fields annotated with {{@ExcludeAge}} when marshalling to JSON.
h3. Configuring field naming policy *Available as of Camel 2.11* The GSON library supports specifying policies and strategies for mapping from json to POJO fields. A common naming convention is to map json fields using lower case with underscores. We may have this JSON string {code} { id : 123, first_name : Donald last_name : Duck } {code} Which we want to map to a POJO that has getter/setters as {code:java:title=PersonPojo.java} public class PersonPojo { private int id; private String firstName; private String lastName; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getFirstName() { return firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } } {code} Then we can configure the {{org.apache.camel.component.gson.GsonDataFormat}} in a Spring XML files as shown below. Notice we use {{fieldNamingPolicy}} property to set the field mapping. This property is an enum from GSon {{com.google.gson.FieldNamingPolicy}} which has a number of pre defined mappings. If you need full control you can use the property {{FieldNamingStrategy}} and implement a custom {{com.google.gson.FieldNamingStrategy}} where you can control the mapping. {code:xml:title=Configuring GsonDataFormat in Spring XML file} !-- define the gson data format, where we configure the data format using the properties -- bean id=gson class=org.apache.camel.component.gson.GsonDataFormat !-- we want to unmarshal to person pojo -- property name=unmarshalType value=org.apache.camel.component.gson.PersonPojo/ !-- we want to map fields to use lower case and underscores -- property name=fieldNamingPolicy value=LOWER_CASE_WITH_UNDERSCORES/ /bean {code} And use it in Camel routes by referring to its bean id as shown: {code:xml:title=Using gson from Camel routes}camelContext xmlns=http://camel.apache.org/schema/spring route from uri=direct:inPojo/ marshal ref=gson/ /route route from uri=direct:backPojo/ unmarshal ref=gson/ /route /camelContext {code}
h3. Dependencies for XStream
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Direct, bi-directional JSON = XML conversionsAs of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the camel-xmljson data format, which is documented separately.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight
[CONF] Apache Camel JSON
JSON
Page edited by Raul Kripalani
Changes (3)
h2. JSON
JSON is a [Data Format] to marshal and unmarshal Java objects to and from [JSON|http://www.json.org/].
Camel supports the following libraries:
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
- The [XStream library|http://xstream.codehaus.org/] and [Jettsion |http://jettison.codehaus.org/] - The [Jackson library|http://xircles.codehaus.org/projects/jackson] - *Camel 2.10:* The [GSon library|http://code.google.com/p/google-gson/]
As of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the [camel-xmljson|XmlJson] data format, which is documented separately.
By default Camel uses the XStream library.
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
As of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the camel-xmljson data format, which is documented separately.
By default Camel uses the XStream library.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
[CONF] Apache Camel JSON
JSON
Page edited by Raul Kripalani
Changes (2)
...
- *Camel 2.10:* The [GSon library|http://code.google.com/p/google-gson/]
As of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the [camel-xmljson|XmlJson] data format, which is documented separately.
By default Camel uses the XStream library.
{tip:title=Direct, bi-directional JSON = XML conversions} As of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the [camel-xmljson|XmlJson] data format, which is documented separately. {tip}
h3. Using JSON data format with the XStream library {code}
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
For JSON to object marshalling, Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Direct, bi-directional JSON = XML conversionsAs of Camel 2.10, Camel supports direct, bi-directional JSON = XML conversions via the camel-xmljson data format, which is documented separately.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-xstream/artifactId
version2.9.2/version
/dependency
Dependencies for Jackson
To use JSON in your camel routes you need
[CONF] Apache Camel JSON
JSON
Page edited by Christian Mueller
Changes (1)
...
JSON is a [Data Format] to marshal and unmarshal Java objects to and from [JSON|http://www.json.org/].
In Camel 1.6 its only the XStream library that is supported and its default.
In Camel 2.0 we added support for more libraries: Camel provides integration with three popular JSON libraries:
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
In Camel 2.0 we added support for more libraries:
Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-xstream/artifactId
version2.0/version
/dependency
Dependencies for Jackson
To use JSON in your camel routes you need to add the a dependency on camel-jackson which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-jackson/artifactId
version2.0/version
/dependency
Dependencies for GSON
To use JSON in your camel routes you need to add the a
[CONF] Apache Camel JSON
JSON
Page edited by Christian Mueller
Changes (5)
...
JSON is a [Data Format] to marshal and unmarshal Java objects to and from [JSON|http://www.json.org/].
In Camel 2.0 we added support for more libraries:
Camel supports the following libraries:
Camel provides integration with three popular JSON libraries: - The [XStream library|http://xstream.codehaus.org/] and [Jettsion |http://jettison.codehaus.org/]
...
groupIdorg.apache.camel/groupId artifactIdcamel-xstream/artifactId
version2.0/version version2.9.2/version
/dependency {code}
...
groupIdorg.apache.camel/groupId artifactIdcamel-jackson/artifactId
version2.0/version version2.9.2/version
/dependency {code}
...
groupIdorg.apache.camel/groupId artifactIdcamel-gson/artifactId
version2.10.0/version
/dependency {code}
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
Camel supports the following libraries:
Camel provides integration with three popular JSON libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Using JSON data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using JSON data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using JSON data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
As of Camel 2.10
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
Note that the weight field is missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
/**
* Strategy to exclude {@link ExcludeAge} annotated fields
*/
protected static class AgeExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.getAnnotation(ExcludeAge.class) != null;
}
@Override
public boolean shouldSkipClass(Class? clazz) {
return false;
}
}
The GsonDataFormat accepts an ExclusionStrategy in its constructor:
GsonDataFormat ageExclusionFormat = new GsonDataFormat(TestPojoExclusion.class, new AgeExclusionStrategy());
from("direct:inPojoExcludeAge").marshal(ageExclusionFormat);
The line above will exclude fields annotated with @ExcludeAge when marshalling to JSON.
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
[CONF] Apache Camel JSON
JSON
Page edited by Richard Kettelerij
Comment:
CAMEL-5135
Changes (2)
...
By default Camel uses the XStream library.
h3. Using JSson data format with the XStream library
{code} // lets turn Object messages into json then send to MQSeries
...
{code}
h3. Excluding POJO fields from marshalling When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use [JSON views|http://wiki.fasterxml.com/JacksonJsonViews] to accomplish this. First create one or more marker classes. {snippet:id=marker|lang=java|url="" Use the marker classes with the {{@JsonView}} annotation to include/exclude certain fields. The annotation also works on getters. {snippet:id=jsonview|lang=java|url="" Finally use the Camel {{JacksonDataFormat}} to marshall the above POJO to JSON. {snippet:id=format|lang=java|url="" Note that the weight field in missing in the resulting JSON: {code} {age:30, height:190} {code} The GSON library supports a similar feature through the notion of [ExclusionStrategies|http://google-gson.googlecode.com/svn/trunk/gson/docs/javadocs/com/google/gson/ExclusionStrategy.html]: {snippet:id=strategy|lang=java|url="" The {{GsonDataFormat}} accepts an {{ExclusionStrategy}} in its constructor: {snippet:id=format|lang=java|url="" The line above will exclude fields annotated with {{@ExcludeAge}} during JSON marshalling.
h3. Dependencies for XStream
...
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
In Camel 1.6 its only the XStream library that is supported and its default.
In Camel 2.0 we added support for more libraries:
Camel provides integration with two popular JSon libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Using Json data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using Json data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using Json data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using Json in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Excluding POJO fields from marshalling
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
public class Views {
static class Weight { }
static class Age { }
}
Use the marker classes with the @JsonView annotation to include/exclude certain fields. The annotation also works on getters.
@JsonView(Views.Age.class)
private int age = 30;
private int height = 190;
@JsonView(Views.Weight.class)
private int weight = 70;
Finally use the Camel JacksonDataFormat to marshall the above POJO to JSON.
JacksonDataFormat ageViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Age.class);
from("direct:inPojoAgeView").marshal(ageViewFormat);
from("direct:backPojoAgeView").unmarshal(ageViewFormat).to("mock:reversePojoAgeView");
JacksonDataFormat weightViewFormat = new JacksonDataFormat(TestPojoView.class, Views.Weight.class);
from("direct:inPojoWeightView").marshal(weightViewFormat);
from("direct:backPojoWeightView").unmarshal(weightViewFormat).to("mock:reversePojoWeightView");
}
};
}
}
Note that the weight field in missing in the resulting JSON:
{"age":30, "height":190}
The GSON library supports a similar feature through the notion of ExclusionStrategies:
[CONF] Apache Camel JSON
JSON
Page edited by Claus Ibsen
Changes (5)
...
- The [XStream library|http://xstream.codehaus.org/] and [Jettsion |http://jettison.codehaus.org/] - The [Jackson library|http://xircles.codehaus.org/projects/jackson]
- *Camel 2.10:* The [GSon library|http://code.google.com/p/google-gson/]
By default Camel uses the XStream library.
...
{code}
h3. Using Json data format with the GSON library {code} // lets turn Object messages into json then send to MQSeries from(activemq:My.Queue). marshal().json(JsonLibrary.Gson). to(mqseries:Another.Queue); {code}
h4. Using Json in Spring DSL When using [Data Format] in Spring DSL you need to declare the data formats first. This is done in the *DataFormats* XML tag.
...
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see [the download page for the latest versions|Download]).
{code:xml}
dependency groupIdorg.apache.camel/groupId
...
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see [the download page for the latest versions|Download]).
{code:xml}
dependency groupIdorg.apache.camel/groupId
...
/dependency {code}
h3. Dependencies for GSON To use JSON in your camel routes you need to add the a dependency on *camel-gson* which implements this data format. If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see [the download page for the latest versions|Download]). {code:xml} dependency groupIdorg.apache.camel/groupId artifactIdcamel-gson/artifactId version2.10/version /dependency {code}
Full Content
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
In Camel 1.6 its only the XStream library that is supported and its default.
In Camel 2.0 we added support for more libraries:
Camel provides integration with two popular JSon libraries:
The XStream library and Jettsion
The Jackson library
Camel 2.10: The GSon library
By default Camel uses the XStream library.
Using JSon data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using Json data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using Json data format with the GSON library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Gson).
to("mqseries:Another.Queue");
Using Json in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-xstream/artifactId
version2.0/version
/dependency
Dependencies for Jackson
To use JSON in your camel routes you need to add the a dependency on camel-jackson which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-jackson/artifactId
version2.0/version
/dependency
Dependencies for GSON
To use JSON in your camel routes you need to add the a dependency on camel-gson which implements this data format.
If you use maven you
[CONF] Apache Camel: JSON (page edited)
Page Edited :
CAMEL :
JSON
JSON
has been edited by Claus Ibsen
(Jun 03, 2009).
(View changes)
Content:
JSON
JSON is a Data Format to marshal and unmarshal Java objects to and from JSON.
In Camel 1.6 its only the XStream library that is supported and its default.
In Camel 2.0 we added support for more libraries:
Camel provides integration with two popular JSon libraries:
The XStream library and Jettsion
The Jackson library
By default Camel uses the XStream library.
Using JSon data format with the XStream library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json().
to("mqseries:Another.Queue");
Using Json data format with the Jackson library
// lets turn Object messages into json then send to MQSeries
from("activemq:My.Queue").
marshal().json(JsonLibrary.Jackson).
to("mqseries:Another.Queue");
Using Json in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
dataFormats
!-- here we define a Json data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalTypeName is optional, if not provided Camel will use a Map as the type --
json id="jack" library="Jackson" unmarshalTypeName="org.apache.camel.component.jackson.TestPojo"/
/dataFormats
And then you can refer to this id in the route:
route
from uri="direct:back"/
unmarshal ref="jack"/
to uri="mock:reverse"/
/route
Dependencies for XStream
To use JSON in your camel routes you need to add the a dependency on camel-xstream which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-xstream/artifactId
version2.0/version
/dependency
Dependencies for Jackson
To use JSON in your camel routes you need to add the a dependency on camel-jackson which implements this data format.
If you use maven you could just add the following to your pom.xml, substituting the version number for the latest greatest release (see the download page for the latest versions).
dependency
groupIdorg.apache.camel/groupId
artifactIdcamel-jackson/artifactId
version2.0/version
/dependency
Powered by
Atlassian Confluence
(Version: 2.2.9 Build:#527 Sep 07, 2006)
-
Bug/feature request
Unsubscribe or edit your notifications preferences
