クラス ConfigurableMongoDbMessageStore
java.lang.ObjectSE
org.springframework.integration.store.AbstractBatchingMessageGroupStore
org.springframework.integration.store.AbstractMessageGroupStore
org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore
org.springframework.integration.mongodb.store.ConfigurableMongoDbMessageStore
- 実装済みのインターフェース一覧:
IterableSE<MessageGroup>, Aware, InitializingBean, ApplicationContextAware, IntegrationPattern, BasicMessageGroupStore, MessageGroupStore, MessageStore
public class ConfigurableMongoDbMessageStore
extends AbstractConfigurableMongoDbMessageStore
implements MessageStore
ユーザーが
MongoTemplate のインスタンスを構成できるようにする代替の MongoDB MessageStore および MessageGroupStore。メッセージ / メッセージのグループをストアに保存するメカニズムは、MongoDbMessageStore とは異なります。ストアはデフォルトでメッセージの直列化を使用するため、メッセージのすべてのヘッダーとペイロードは SerializableSE インターフェースを実装する必要があります - 導入:
- 3.0
- 作成者:
- Amol Nayak, Artem Bilan, Gary Russell, Ngoc Nhan, Youbin Wu
ネストされたクラスの概要
インターフェース MessageGroupStore から継承されたネストクラス / インターフェース
MessageGroupStore.MessageGroupCallbackフィールド概要
フィールドクラス AbstractConfigurableMongoDbMessageStore から継承されたフィールド
collectionName, logger, mongoDbFactory, SEQUENCE_NAMEクラス AbstractMessageGroupStore から継承されたフィールド
INTERRUPTED_WHILE_OBTAINING_LOCKコンストラクター概要
コンストラクターコンストラクター説明ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate) ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, StringSE collectionName) ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory) ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, StringSE collectionName) ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, @Nullable MappingMongoConverter mappingMongoConverter, StringSE collectionName) ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter) 方法の概要
修飾子と型メソッド説明<T> Message<T> addMessage(Message<T> message) 提供されたメッセージを MessageStore に入れます。addMessageToGroup(ObjectSE groupId, Message<?> message) グループ ID に関連付けてメッセージを保存します。protected voiddoAddMessagesToGroup(ObjectSE groupId, Message<?>... messages) protected voiddoCompleteGroup(ObjectSE groupId) protected @Nullable Message<?> doPollMessageFromGroup(ObjectSE groupId) protected booleandoRemoveMessageFromGroupById(ObjectSE groupId, UUIDSE messageId) protected voiddoRemoveMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages) protected voiddoSetGroupCondition(ObjectSE groupId, StringSE condition) protected voiddoSetLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber) longストア内のメッセージ数を示すオプションの属性。intすべてのグループにわたるストア内のメッセージの数を示すオプションの属性。@Nullable Message<?> getMessageFromGroup(ObjectSE groupId, UUIDSE messageId) ID を使用してグループからMessageを取得します。getMessageGroup(ObjectSE groupId) このグループ ID でBasicMessageGroupStore.addMessageToGroup(Object, Message)を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。intメッセージグループの数を示すオプションの属性。CollectionSE<Message<?>> getMessagesForGroup(ObjectSE groupId) 指定されたグループ ID のメッセージを取得します。@Nullable Message<?> getOneMessageFromGroup(ObjectSE groupId) MessageGroupから 1 つのMessageを返します。iterator()@Nullable Message<?> removeMessage(UUIDSE id) 指定された ID のメッセージを MessageStore から削除し(存在する場合)、それを返します。streamMessagesForGroup(ObjectSE groupId) 指定されたグループに保存されているメッセージのストリームを返します。クラス AbstractConfigurableMongoDbMessageStore から継承されたメソッド
addMessageDocument, afterPropertiesSet, createIndexes, doRemoveMessageGroup, getApplicationContext, getMappingMongoConverter, getMessage, getMessageBuilderFactory, getMessageMetadata, getMongoTemplate, getNextId, groupIdQuery, messageGroupSize, setApplicationContext, setCreateIndexesクラス AbstractMessageGroupStore から継承されたメソッド
addMessagesToGroup, completeGroup, copy, executeLocked, executeLocked, expireMessageGroups, getLockRegistry, getMessageGroupFactory, isTimeoutOnIdle, pollMessageFromGroup, registerMessageGroupExpiryCallback, removeMessageFromGroupById, removeMessageGroup, removeMessagesFromGroup, removeMessagesFromGroup, setExpiryCallbacks, setGroupCondition, setLastReleasedSequenceNumberForGroup, setLazyLoadMessageGroups, setLockRegistry, setTimeoutOnIdleクラス AbstractBatchingMessageGroupStore から継承されたメソッド
getRemoveBatchSize, setMessageGroupFactory, setRemoveBatchSizeクラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース IterableSE から継承されたメソッド
forEachSE, spliteratorインターフェース MessageGroupStore から継承されたメソッド
getGroupMetadataインターフェース MessageStore から継承されたメソッド
getIntegrationPatternType, getMessage, getMessageMetadata
フィールドの詳細
DEFAULT_COLLECTION_NAME
- 関連事項:
コンストラクターの詳細
ConfigurableMongoDbMessageStore
ConfigurableMongoDbMessageStore
ConfigurableMongoDbMessageStore
ConfigurableMongoDbMessageStore
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter) ConfigurableMongoDbMessageStore
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, StringSE collectionName) ConfigurableMongoDbMessageStore
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, @Nullable MappingMongoConverter mappingMongoConverter, StringSE collectionName)
方法の詳細
addMessage
インターフェースからコピーされた説明:MessageStore提供されたメッセージを MessageStore に格納します。ストアは内部的にメッセージを変更する必要がある可能性があり、その場合、戻り値は入力値と異なる場合があります。戻り値の ID は、MessageStore.getMessage(UUID)とMessageStore.removeMessage(UUID)が正しく動作するためのインデックスとして使用されます。メッセージは不変であるため、同じメッセージを複数回格納しても何も起こりません。- 次で指定:
- インターフェース
MessageStore内のaddMessage - 型パラメーター:
T- ペイロード型。- パラメーター:
message- メッセージ。- 戻り値:
- 保存されたメッセージ。
removeMessage
インターフェースからコピーされた説明:MessageStore指定された ID を持つメッセージが MessageStore から削除されます (存在する場合)。その ID を持つメッセージがストアに存在しない場合は、nullが返されます。このメソッドがMessageGroupStoreに実装されている場合、このメッセージを保持するグループがない場合にのみ、メッセージはストアから削除されます。- 次で指定:
- インターフェース
MessageStore内のremoveMessage - パラメーター:
id- メッセージ識別子。- 戻り値:
- メッセージ (ある場合)。
getMessageCount
public long getMessageCount()インターフェースからコピーされた説明:MessageStoreストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。- 次で指定:
- インターフェース
MessageStore内のgetMessageCount - 戻り値:
- メッセージの数。
getMessageGroup
インターフェースからコピーされた説明:BasicMessageGroupStoreこのグループ ID でBasicMessageGroupStore.addMessageToGroup(Object, Message)を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。- 次で指定:
- インターフェース
BasicMessageGroupStore内のgetMessageGroup - パラメーター:
groupId- グループ識別子。- 戻り値:
- メッセージのグループ。このキーにメッセージが存在しない場合は空です。
addMessageToGroup
インターフェースからコピーされた説明:BasicMessageGroupStoreグループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。- 次で指定:
- インターフェース
BasicMessageGroupStore内のaddMessageToGroup - オーバーライド:
- クラス
AbstractMessageGroupStoreのaddMessageToGroup - パラメーター:
groupId- メッセージを保存するグループ ID。message- メッセージ。- 戻り値:
- メッセージグループ。
doAddMessagesToGroup
- オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのdoAddMessagesToGroup
doRemoveMessagesFromGroup
- オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのdoRemoveMessagesFromGroup
getMessageFromGroup
インターフェースからコピーされた説明:MessageGroupStoreID を使用してグループからMessageを取得します。メッセージがリクエストされたグループに属していない場合は、nullを返します。- 次で指定:
- インターフェース
MessageGroupStore内のgetMessageFromGroup - パラメーター:
groupId- メッセージを含むグループの groupId。messageId- メッセージ ID。- 戻り値:
- リクエストされたグループに属している場合は、ID によるメッセージ。
doRemoveMessageFromGroupById
- オーバーライド:
- クラス
AbstractMessageGroupStoreのdoRemoveMessageFromGroupById
doPollMessageFromGroup
- 次で指定:
- クラス
AbstractMessageGroupStoreのdoPollMessageFromGroup
doSetLastReleasedSequenceNumberForGroup
doSetGroupCondition
- オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのdoSetGroupCondition
doCompleteGroup
- オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのdoCompleteGroup
iterator
- 次で指定:
- インターフェース
IterableSE<MessageGroup>内のiterator - 次で指定:
- インターフェース
MessageGroupStore内のiterator - オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのiterator - 戻り値:
- 現在累積されている
MessageGroupの反復子。
getMessageCountForAllMessageGroups
インターフェースからコピーされた説明:MessageGroupStoreすべてのグループにわたるストア内のメッセージの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。- 次で指定:
- インターフェース
MessageGroupStore内のgetMessageCountForAllMessageGroups - オーバーライド:
- クラス
AbstractMessageGroupStoreのgetMessageCountForAllMessageGroups - 戻り値:
- メッセージの数
getMessageGroupCount
インターフェースからコピーされた説明:MessageGroupStoreメッセージグループの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。- 次で指定:
- インターフェース
MessageGroupStore内のgetMessageGroupCount - オーバーライド:
- クラス
AbstractMessageGroupStoreのgetMessageGroupCount - 戻り値:
- メッセージグループの数
getOneMessageFromGroup
インターフェースからコピーされた説明:MessageGroupStoreMessageGroupから 1 つのMessageを返します。- 次で指定:
- インターフェース
MessageGroupStore内のgetOneMessageFromGroup - パラメーター:
groupId- グループ識別子。- 戻り値:
Message
getMessagesForGroup
インターフェースからコピーされた説明:MessageGroupStore指定されたグループ ID のメッセージを取得します。- 次で指定:
- インターフェース
MessageGroupStore内のgetMessagesForGroup - オーバーライド:
- クラス
AbstractConfigurableMongoDbMessageStoreのgetMessagesForGroup - パラメーター:
groupId- メッセージを取得するグループ ID。- 戻り値:
- グループのメッセージ。
streamMessagesForGroup
インターフェースからコピーされた説明:MessageGroupStore指定されたグループに保存されているメッセージのストリームを返します。永続的な実装は、完全に処理されたら閉じる必要があるストリームを返します(たとえば、try-with-resources 句を使用)。デフォルトでは、MessageGroupStore.getMessagesForGroup(Object)の結果をストリーミングします。- 次で指定:
- インターフェース
MessageGroupStore内のstreamMessagesForGroup - パラメーター:
groupId- メッセージを取得するためのグループ ID。- 戻り値:
- このグループのメッセージの
StreamSE。