ConfigurableMongoDbMessageStore (Spring Integration API)

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, BasicMessageGroupStore, MessageGroupStore, MessageStore
```
public class ConfigurableMongoDbMessageStore
extends AbstractConfigurableMongoDbMessageStore
implements MessageStore
```
ユーザーが MongoTemplate のインスタンスを構成できるようにする代替の MongoDB MessageStore および MessageGroupStore。メッセージ / メッセージのグループをストアに保存するメカニズムは、MongoDbMessageStore とは異なります。ストアはデフォルトでメッセージの直列化を使用するため、メッセージのすべてのヘッダーとペイロードは SerializableSE インターフェースを実装する必要があります
導入:
3.0
作成者:
Amol Nayak, Artem Bilan, Gary Russell

ネストされたクラスの要約
- インターフェース org.springframework.integration.store.MessageGroupStore から継承されたネストクラス / インターフェース
  MessageGroupStore.MessageGroupCallback

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE DEFAULT_COLLECTION_NAME
- クラス org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore から継承されたフィールド
  collectionName, logger, mongoDbFactory, SEQUENCE_NAME

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_COLLECTION_NAME`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, StringSE collectionName)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, StringSE collectionName)`
`ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)`
`ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, StringSE collectionName)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`<T> Message<T>`	`addMessage(Message<T> message)` 提供されたメッセージを MessageStore に入れます。
`void`	`addMessagesToGroup(ObjectSE groupId, Message<?>... messages)` グループ ID に関連付けてメッセージを保存します。
`MessageGroup`	`addMessageToGroup(ObjectSE groupId, Message<?> message)` グループ ID に関連付けてメッセージを保存します。
`void`	`completeGroup(ObjectSE groupId)` この MessageGroup を完成させます。
`long`	`getMessageCount()` ストア内のメッセージ数を示すオプションの属性。
`int`	`getMessageCountForAllMessageGroups()` すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。
`MessageGroup`	`getMessageGroup(ObjectSE groupId)` このグループ ID で `BasicMessageGroupStore.addMessageToGroup(Object, Message)` を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
`int`	`getMessageGroupCount()` メッセージグループの数を示すオプションの属性。
`CollectionSE<Message<?>>`	`getMessagesForGroup(ObjectSE groupId)` 指定されたグループ ID のメッセージを取得します。
`Message<?>`	`getOneMessageFromGroup(ObjectSE groupId)` `MessageGroup` から 1 つの `Message` を返します。
`IteratorSE<MessageGroup>`	`iterator()`
`Message<?>`	`pollMessageFromGroup(ObjectSE groupId)` この `MessageGroup` からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた `Message` も削除します
`Message<?>`	`removeMessage(UUIDSE id)` 指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。
`void`	`removeMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)` グループからのメッセージの削除を永続化します。
`void`	`setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)` 最後にリリースされたメッセージのシーケンス番号を設定できます。

クラス org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore から継承されたメソッド
addMessageDocument, afterPropertiesSet, getApplicationContext, getMappingMongoConverter, getMessage, getMessageBuilderFactory, getMessageMetadata, getMongoTemplate, getNextId, groupIdQuery, messageGroupSize, removeMessageGroup, setApplicationContext

クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたメソッド
copy, expireMessageGroups, getGroupMetadata, getMessageGroupFactory, isTimeoutOnIdle, registerMessageGroupExpiryCallback, removeMessagesFromGroup, setExpiryCallbacks, setLazyLoadMessageGroups, setTimeoutOnIdle

クラス org.springframework.integration.store.AbstractBatchingMessageGroupStore から継承されたメソッド
getRemoveBatchSize, setMessageGroupFactory, setRemoveBatchSize

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.integration.store.MessageStore から継承されたメソッド
getMessage, getMessageMetadata

インターフェース java.lang.IterableSE から継承されたメソッド
forEachSE, spliteratorSE

- フィールドの詳細
  - DEFAULT_COLLECTION_NAME
```
public static final StringSE DEFAULT_COLLECTION_NAME
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)
```
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate,
                                       StringSE collectionName)
```
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)
```
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                                       MappingMongoConverter mappingMongoConverter)
```
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                                       StringSE collectionName)
```
  - ConfigurableMongoDbMessageStore
```
public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                                       MappingMongoConverter mappingMongoConverter,
                                       StringSE collectionName)
```
- メソッドの詳細
  - addMessage
```
public <T> Message<T> addMessage(Message<T> message)
```
    インターフェースからコピーされた説明: MessageStore
    提供されたメッセージを MessageStore に入れます。ストアはメッセージを内部で変更する必要がある場合があり、その場合、戻り値は入力と異なる場合があります。戻り値の ID は、MessageStore.getMessage(UUID) および MessageStore.removeMessage(UUID) が正しく動作するようにインデックスとして使用されます。メッセージは不変であるため、同じメッセージを複数回入力しても何も起こりません。
    次で指定:
    インターフェース MessageStore の addMessage
    型パラメーター:
    T - ペイロード型。
    パラメーター:
    message - メッセージ。
    戻り値:
    保存されたメッセージ。
  - removeMessage
```
public Message<?> removeMessage(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。その ID のメッセージがストアに存在しない場合、これは null を返します。
    次で指定:
    インターフェース MessageStore の removeMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    メッセージ。
  - getMessageCount
```
public long getMessageCount()
```
    インターフェースからコピーされた説明: MessageStore
    ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。
    次で指定:
    インターフェース MessageStore の getMessageCount
    戻り値:
    メッセージの数。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    このグループ ID で BasicMessageGroupStore.addMessageToGroup(Object, Message) を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
    次で指定:
    インターフェース BasicMessageGroupStore の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - addMessageToGroup
```
public MessageGroup addMessageToGroup(ObjectSE groupId,
                                      Message<?> message)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース BasicMessageGroupStore の addMessageToGroup
    オーバーライド:
    クラス AbstractMessageGroupStore の addMessageToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    message - メッセージ。
    戻り値:
    メッセージグループ。
  - addMessagesToGroup
```
public void addMessagesToGroup(ObjectSE groupId,
                               Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース MessageGroupStore の addMessagesToGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の addMessagesToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    messages - 追加するメッセージ。
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE groupId,
                                    CollectionSE<Message<?>> messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore の removeMessagesFromGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の removeMessagesFromGroup
    パラメーター:
    groupId - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - pollMessageFromGroup
```
public Message<?> pollMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた Message も削除します
    次で指定:
    インターフェース BasicMessageGroupStore の pollMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージ。
  - setLastReleasedSequenceNumberForGroup
```
public void setLastReleasedSequenceNumberForGroup(ObjectSE groupId,
                                                  int sequenceNumber)
```
    インターフェースからコピーされた説明: MessageGroupStore
    最後にリリースされたメッセージのシーケンス番号を設定できます。ユースケースの並べ替えに使用
    次で指定:
    インターフェース MessageGroupStore の setLastReleasedSequenceNumberForGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の setLastReleasedSequenceNumberForGroup
    パラメーター:
    groupId - グループ識別子。
    sequenceNumber - シーケンス番号。
  - completeGroup
```
public void completeGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    この MessageGroup を完成させます。MessageGroup の補完は、一般に、このグループがこれ以上の変更操作を実行できないようにする必要があることを意味します。たとえば、グループから新しいメッセージを追加 / 削除しようとする試みは許可されるべきではありません。
    次で指定:
    インターフェース MessageGroupStore の completeGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の completeGroup
    パラメーター:
    groupId - グループ識別子。
  - iterator
```
public IteratorSE<MessageGroup> iterator()
```
    次で指定:
    インターフェース IterableSE<MessageGroup> の iteratorSE
    次で指定:
    インターフェース MessageGroupStore の iterator
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の iterator
    戻り値:
    現在累積されている MessageGroup の反復子。
  - getMessageCountForAllMessageGroups
```
@ManagedAttribute
public int getMessageCountForAllMessageGroups()
```
    インターフェースからコピーされた説明: MessageGroupStore
    すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageCountForAllMessageGroups
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageCountForAllMessageGroups
    戻り値:
    メッセージの数
  - getMessageGroupCount
```
@ManagedAttribute
public int getMessageGroupCount()
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージグループの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageGroupCount
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageGroupCount
    戻り値:
    メッセージグループの数
  - getOneMessageFromGroup
```
public Message<?> getOneMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    MessageGroup から 1 つの Message を返します。
    次で指定:
    インターフェース MessageGroupStore の getOneMessageFromGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の getOneMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    Message
  - getMessagesForGroup
```
public CollectionSE<Message<?>> getMessagesForGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    指定されたグループ ID のメッセージを取得します。
    次で指定:
    インターフェース MessageGroupStore の getMessagesForGroup
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の getMessagesForGroup
    パラメーター:
    groupId - メッセージを取得するグループ ID。
    戻り値:
    グループのメッセージ。

クラス ConfigurableMongoDbMessageStore

ネストされたクラスの要約

インターフェース org.springframework.integration.store.MessageGroupStore から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore から継承されたメソッド

クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたメソッド

クラス org.springframework.integration.store.AbstractBatchingMessageGroupStore から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.integration.store.MessageStore から継承されたメソッド

インターフェース java.lang.IterableSE から継承されたメソッド

フィールドの詳細

DEFAULT_COLLECTION_NAME

コンストラクターの詳細

ConfigurableMongoDbMessageStore

ConfigurableMongoDbMessageStore

ConfigurableMongoDbMessageStore

ConfigurableMongoDbMessageStore

ConfigurableMongoDbMessageStore

ConfigurableMongoDbMessageStore

メソッドの詳細

addMessage

removeMessage

getMessageCount

getMessageGroup

addMessageToGroup

addMessagesToGroup

removeMessagesFromGroup

pollMessageFromGroup

setLastReleasedSequenceNumberForGroup

completeGroup

iterator

getMessageCountForAllMessageGroups

getMessageGroupCount

getOneMessageFromGroup

getMessagesForGroup