MongoDbMessageStore (Spring Integration 2.1.6.RELEASE API)

Overview

Package

Class

Tree

Deprecated

Index

Help

Spring Integration

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.integration.mongodb.store
Class MongoDbMessageStore

java.lang.Object
  org.springframework.integration.store.AbstractMessageGroupStore
      org.springframework.integration.mongodb.store.MongoDbMessageStore

All Implemented Interfaces:: java.lang.Iterable<MessageGroup>, org.springframework.beans.factory.BeanClassLoaderAware, MessageGroupStore, MessageStore

public class MongoDbMessageStore
extends AbstractMessageGroupStore
implements MessageStore, org.springframework.beans.factory.BeanClassLoaderAware
extends AbstractMessageGroupStore
implements MessageStore, org.springframework.beans.factory.BeanClassLoaderAware

An implementation of both the MessageStore and MessageGroupStore strategies that relies upon MongoDB for persistence.

Since:: 2.1
Author:: Mark Fisher, Oleg Zhurakousky, Sean Brandt

Field Summary

Fields inherited from class org.springframework.integration.store.AbstractMessageGroupStore
`logger`

Constructor Summary
`MongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory)` Create a MongoDbMessageStore using the provided `MongoDbFactory`.and the default collection name.
`MongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory, java.lang.String collectionName)` Create a MongoDbMessageStore using the provided `MongoDbFactory` and collection name.

Method Summary





<T> Message<T>

addMessage(Message<T> message)
Put the provided Message into the MessageStore.

MessageGroup addMessageToGroup(java.lang.Object groupId, Message<?> message)
Store a message with an association to a group id.

void completeGroup(java.lang.Object groupId)
Completes this MessageGroup.

Message<?> getMessage(java.util.UUID id)
Return the Message with the given id, or null if no Message with that id exists in the MessageStore.

long getMessageCount()
Optional attribute giving the number of messages in the store.

MessageGroup getMessageGroup(java.lang.Object groupId)
Return all Messages currently in the MessageStore that were stored using MessageGroupStore.addMessageToGroup(Object, Message) with this group id.

java.util.Iterator<MessageGroup> iterator()
Returns the iterator of currently accumulated MessageGroups

int messageGroupSize(java.lang.Object groupId)
Returns the size of this MessageGroup

Message<?> pollMessageFromGroup(java.lang.Object groupId)
Polls Message from this MessageGroup (in FIFO style if supported by the implementation) while also removing the polled Message

Message<?> removeMessage(java.util.UUID id)
Remove the Message with the given id from the MessageStore, if present, and return it.

MessageGroup removeMessageFromGroup(java.lang.Object groupId, Message<?> messageToRemove)
Persist a deletion on a single message from the group.

void removeMessageGroup(java.lang.Object groupId)
Remove the message group with this id.

void setBeanClassLoader(java.lang.ClassLoader classLoader)

void setLastReleasedSequenceNumberForGroup(java.lang.Object groupId, int sequenceNumber)
Allows you to set the sequence number of the last released Message.

Methods inherited from class org.springframework.integration.store.AbstractMessageGroupStore
`expireMessageGroups, getMessageCountForAllMessageGroups, getMessageGroupCount, isTimeoutOnIdle, registerMessageGroupExpiryCallback, setExpiryCallbacks, setTimeoutOnIdle`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

MongoDbMessageStore

public MongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory)

Create a MongoDbMessageStore using the provided MongoDbFactory.and the default collection name.

MongoDbMessageStore

public MongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory,
                           java.lang.String collectionName)

Create a MongoDbMessageStore using the provided MongoDbFactory and collection name.

Method Detail

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:: setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

addMessage

public <T> Message<T> addMessage(Message<T> message)

Description copied from interface: MessageStore

Put the provided Message into the MessageStore. The store may need to mutate the message internally, and if it does then the return value can be different than the input. The id of the return value will be used as an index so that the MessageStore.getMessage(UUID) and MessageStore.removeMessage(UUID) behave properly. Since messages are immutable, putting the same message more than once is a no-op.

Specified by:: addMessage in interface MessageStore

Returns:: the message that was stored

getMessage

public Message<?> getMessage(java.util.UUID id)

Description copied from interface: MessageStore

Return the Message with the given id, or null if no Message with that id exists in the MessageStore.

Specified by:: getMessage in interface MessageStore

getMessageCount

@ManagedAttribute
public long getMessageCount()

Description copied from interface: MessageStore

Optional attribute giving the number of messages in the store. Implementations may decline to respond by throwing an exception.

Specified by:: getMessageCount in interface MessageStore

Returns:: the number of messages

removeMessage

public Message<?> removeMessage(java.util.UUID id)

Description copied from interface: MessageStore

Remove the Message with the given id from the MessageStore, if present, and return it. If no Message with that id is present in the store, this will return null.

Specified by:: removeMessage in interface MessageStore