org.springframework.integration.mongodb.store

Class AbstractConfigurableMongoDbMessageStore

java.lang.Object

org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore

Direct Known Subclasses:

ConfigurableMongoDbMessageStore, MongoDbChannelMessageStore

public abstract class AbstractConfigurableMongoDbMessageStore
extends Object
implements BasicMessageGroupStore, InitializingBean, ApplicationContextAware

The abstract MongoDB BasicMessageGroupStore implementation to provide configuration for common options for implementations of this class.

Since:

4.0

Author:

Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationContext	applicationContext
protected String	collectionName
static String	CREATED_DATE_KEY The name of the message header that stores a timestamp for the time the message was inserted.
protected org.apache.commons.logging.Log	logger
protected MappingMongoConverter	mappingMongoConverter
protected MessageBuilderFactory	messageBuilderFactory
protected MongoDbFactory	mongoDbFactory
protected MongoTemplate	mongoTemplate
static String	SAVED_KEY The name of the message header that stores a flag to indicate that the message has been saved.
static String	SEQUENCE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, String collectionName)
AbstractConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory, String collectionName)
AbstractConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, String collectionName)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMessageDocument(MessageDocument document)
void	afterPropertiesSet()
Message<?>	getMessage(UUID id)
protected int	getNextId() Perform MongoDB INC operation for the document, which contains the MessageDocument sequence, and return the new incremented value for the new MessageDocument.
protected static Query	groupIdQuery(Object groupId)
int	messageGroupSize(Object groupId) Returns the size of this MessageGroup.
void	removeMessageGroup(Object groupId) Remove the message group with this id.
void	setApplicationContext(ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.integration.store.BasicMessageGroupStore

addMessageToGroup, getMessageGroup, pollMessageFromGroup

Field Detail

SEQUENCE_NAME

public static final String SEQUENCE_NAME

See Also:

Constant Field Values

SAVED_KEY

public static final String SAVED_KEY

The name of the message header that stores a flag to indicate that the message has been saved. This is an optimization for the put method.

See Also:

Constant Field Values

CREATED_DATE_KEY

public static final String CREATED_DATE_KEY

The name of the message header that stores a timestamp for the time the message was inserted.

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

collectionName

protected final String collectionName

mongoDbFactory

protected final MongoDbFactory mongoDbFactory

mongoTemplate

protected MongoTemplate mongoTemplate

mappingMongoConverter

protected MappingMongoConverter mappingMongoConverter

applicationContext

protected ApplicationContext applicationContext

messageBuilderFactory

protected MessageBuilderFactory messageBuilderFactory

Constructor Detail

AbstractConfigurableMongoDbMessageStore

public AbstractConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate,
                                       String collectionName)

AbstractConfigurableMongoDbMessageStore

public AbstractConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory,
                                       String collectionName)

AbstractConfigurableMongoDbMessageStore

public AbstractConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory,
                                       MappingMongoConverter mappingMongoConverter,
                                       String collectionName)

Method Detail

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

getMessage

public Message<?> getMessage(UUID id)

removeMessageGroup

public void removeMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Remove the message group with this id.

Specified by:

removeMessageGroup in interface BasicMessageGroupStore

Parameters:

groupId - The id of the group to remove.

messageGroupSize

public int messageGroupSize(Object groupId)

Description copied from interface: BasicMessageGroupStore

Returns the size of this MessageGroup.

Specified by:

messageGroupSize in interface BasicMessageGroupStore

Parameters:

groupId - The group identifier.

Returns:

The size.

getNextId

protected int getNextId()

Perform MongoDB INC operation for the document, which contains the MessageDocument sequence, and return the new incremented value for the new MessageDocument. The SEQUENCE_NAME document is created on demand.

Returns:

the next sequence value.

addMessageDocument

protected void addMessageDocument(MessageDocument document)

groupIdQuery

protected static Query groupIdQuery(Object groupId)