diff --git a/docs/src/reference/docbook/index.xml b/docs/src/reference/docbook/index.xml index 9306eb97b0..cdbe7e9041 100644 --- a/docs/src/reference/docbook/index.xml +++ b/docs/src/reference/docbook/index.xml @@ -126,16 +126,18 @@ + - - + + - - - - - - + + + + + + + diff --git a/docs/src/reference/docbook/mongodb.xml b/docs/src/reference/docbook/mongodb.xml new file mode 100644 index 0000000000..140fe85351 --- /dev/null +++ b/docs/src/reference/docbook/mongodb.xml @@ -0,0 +1,109 @@ + + + MongoDb Support + + Since version 2.1 Spring Integration introduces support for MongoDb database - "high-performance, open source, document-oriented database" + This support comes in the form of MongoDb-based MessageStore. + +
+ Introduction + + To download, install and run MongoDb please refer to MongoDb documentation + +
+ +
+ Connecting to MongoDb + + To begin interacting with MongoDb you first need to connect to it. Spring Integration uses support provided by another Spring project - + Spring Data MongoDB which uses an all familiar Spring's ConnectionFactory. + abstraction to simplify integration with MongoDB Client API. + + MongoDbFactory + + + To connect to MongoDb you would use one of the implementations of MongoDbFactory interface + + + + + Example below shows how to create SimpleMongoDbFactory + + In Java: + + + + Or as Spring configuration:: + + + + +]]> + + + + As you can see SimpleMongoDbFactory takes two arguments; A connection object Mongo and String specifying the name of the database. +If you need to specify properties such as host, port etc, you can pass those using one of the constructors provided by Mongo. +For more information on how to configure please refer to Spring-Data-Document reference documentation. + + + +
+ +
+ MongoDb Message Store + + + As described in the EIP MessageStore allows you to persist Messages which can be very useful when dealing + with components that have capability to buffer messages (QueueChannel, Aggregator, Resequencer) if reliability is a concern as well as patterns such as + ClaimCheck + + + + Spring Integration MongoDb module provides MongoDbMessageStore which is the implementation of both MessageStore strategy + (mainly used by QueueChannel and ClaimCheck patterns) as well as MessageGroupStore strategy + (mainly used by Aggregator and Resequencer patterns) + + + + + + + + + + + +]]> + + + Above is a sample RedisMessageStore configuration as well as its usage (QueueChannel and Aggregator). As you can see it is a simple + bean configuration injected with RedisConnectionFactory via constructor. + + + By default RedisMessageStore will use Java serialization to serialize the Message, however if you want to use different serialization technique (e.g., JSON) + you can provide your own serializer via valueSerializer property of RedisMessageStore. +
+ +
\ No newline at end of file