MongoDbMessageStore (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.store.AbstractBatchingMessageGroupStore
- - org.springframework.integration.store.AbstractMessageGroupStore
  - - org.springframework.integration.mongodb.store.MongoDbMessageStore

実装済みのインターフェース一覧:
IterableSE<MessageGroup>, Aware, BeanClassLoaderAware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore, MessageGroupStore, MessageStore
```
public class MongoDbMessageStore
extends AbstractMessageGroupStore
implements MessageStore, BeanClassLoaderAware, ApplicationContextAware, InitializingBean
```
永続性を MongoDB に依存する MessageStore 戦略と MessageGroupStore 戦略の両方の実装。
導入:
2.1
作成者:
Mark Fisher, Oleg Zhurakousky, Sean Brandt, Jodie StJohn, Gary Russell, Artem Bilan

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

フィールド概要
フィールド
修飾子と型フィールドと説明
static StringSE SEQUENCE_NAME
- クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたフィールド
  logger

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

コンストラクター概要

コンストラクター
コンストラクターと説明
`MongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)` 提供された `MongoDatabaseFactory` とデフォルトのコレクション名を使用して MongoDbMessageStore を作成します。
`MongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, StringSE collectionName)` 提供された `MongoDatabaseFactory` とコレクション名を使用して MongoDbMessageStore を作成します。

方法の概要

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

クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたメソッド
addMessageToGroup, 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

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

- フィールドの詳細
  - SEQUENCE_NAME
```
public static final StringSE SEQUENCE_NAME
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MongoDbMessageStore
```
public MongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)
```
    提供された MongoDatabaseFactory とデフォルトのコレクション名を使用して MongoDbMessageStore を作成します。
    パラメーター:
    mongoDbFactory - mongodb ファクトリ。
  - MongoDbMessageStore
```
public MongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                           @Nullable
                           StringSE collectionName)
```
    提供された MongoDatabaseFactory とコレクション名を使用して MongoDbMessageStore を作成します。
    パラメーター:
    mongoDbFactory - mongodb ファクトリ。
    collectionName - コレクション名。
- メソッドの詳細
  - setBeanClassLoader
```
public void setBeanClassLoader(ClassLoaderSE classLoader)
```
    次で指定:
    インターフェース BeanClassLoaderAware 内の setBeanClassLoader
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException
```
    次で指定:
    インターフェース ApplicationContextAware 内の setApplicationContext
    例外:
    BeansException
  - addAllowedPatterns
```
public void addAllowedPatterns(StringSE... patterns)
```
    逆直列化できるパッケージ / クラスのパターンを追加します。クラスは完全修飾することも、クラス名の最初または最後にワイルドカード "*" を使用することもできます。例: com.foo.*、*.MyClass。
    パラメーター:
    patterns - パターン。
    導入:
    5.4
  - setCustomConverters
```
public void setCustomConverters(ObjectSE... customConverters)
```
    MappingMongoConverter で使用するコンバーターのセットを構成します。org.springframework.core.convert.converter.Converter、org.springframework.core.convert.converter.ConverterFactory、org.springframework.core.convert.converter.GenericConverter または org.springframework.data.convert.ConverterBuilder.ConverterAware のインスタンスである必要があります。
    パラメーター:
    customConverters - 使用するコンバーター。
    導入:
    5.1.6
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    次で指定:
    インターフェース InitializingBean 内の afterPropertiesSet
  - addMessage
```
public <T> Message<T> addMessage(Message<T> message)
```
    インターフェースからコピーされた説明: MessageStore
    提供されたメッセージを MessageStore に入れます。ストアはメッセージを内部で変更する必要がある場合があり、その場合、戻り値は入力と異なる場合があります。戻り値の ID は、MessageStore.getMessage(UUID) および MessageStore.removeMessage(UUID) が正しく動作するようにインデックスとして使用されます。メッセージは不変であるため、同じメッセージを複数回入力しても何も起こりません。
    次で指定:
    インターフェース MessageStore 内の addMessage
    型パラメーター:
    T - ペイロード型。
    パラメーター:
    message - メッセージ。
    戻り値:
    保存されたメッセージ。
  - getMessage
```
public Message<?> getMessage(UUIDSE id)
```
    次で指定:
    インターフェース MessageStore 内の getMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    指定された ID のメッセージ。MessageStore にその ID のメッセージが存在しない場合は null。
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    提供された id によって Message の MessageMetadata を返します。
    次で指定:
    インターフェース MessageStore 内の getMessageMetadata
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    指定された ID の MessageMetadata、またはその ID のメッセージが MessageStore に存在しないか、メッセージにメタデータがない場合（以前のバージョンのレガシーメッセージ）は null。
  - getMessageCount
```
@ManagedAttribute
public long getMessageCount()
```
    インターフェースからコピーされた説明: MessageStore
    ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。
    次で指定:
    インターフェース MessageStore 内の getMessageCount
    戻り値:
    メッセージの数。
  - removeMessage
```
public Message<?> removeMessage(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。その ID のメッセージがストアに存在しない場合、これは null を返します。
    次で指定:
    インターフェース MessageStore 内の removeMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    メッセージ。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    このグループ ID で BasicMessageGroupStore.addMessageToGroup(Object, Message) を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - addMessagesToGroup
```
public void addMessagesToGroup(ObjectSE groupId,
                               Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース MessageGroupStore 内の addMessagesToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    messages - 追加するメッセージ。
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE groupId,
                                    CollectionSE<Message<?>> messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore 内の removeMessagesFromGroup
    パラメーター:
    groupId - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - removeMessageGroup
```
public void removeMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この ID のメッセージグループを削除します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の removeMessageGroup
    パラメーター:
    groupId - 削除するグループの ID。
  - iterator
```
public IteratorSE<MessageGroup> iterator()
```
    次で指定:
    インターフェース IterableSE<MessageGroup> 内の iteratorSE
    次で指定:
    インターフェース MessageGroupStore 内の iterator
    戻り値:
    現在累積されている MessageGroup の反復子。
  - pollMessageFromGroup
```
public Message<?> pollMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた Message も削除します
    次で指定:
    インターフェース BasicMessageGroupStore 内の pollMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージ。
  - messageGroupSize
```
public int messageGroupSize(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup のサイズを返します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の messageGroupSize
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    サイズ。
  - setLastReleasedSequenceNumberForGroup
```
public void setLastReleasedSequenceNumberForGroup(ObjectSE groupId,
                                                  int sequenceNumber)
```
    インターフェースからコピーされた説明: MessageGroupStore
    最後にリリースされたメッセージのシーケンス番号を設定できます。ユースケースの並べ替えに使用
    次で指定:
    インターフェース MessageGroupStore 内の setLastReleasedSequenceNumberForGroup
    パラメーター:
    groupId - グループ識別子。
    sequenceNumber - シーケンス番号。
  - completeGroup
```
public void completeGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    この MessageGroup を完成させます。MessageGroup の補完は、一般に、このグループがこれ以上の変更操作を実行できないようにする必要があることを意味します。たとえば、グループから新しいメッセージを追加 / 削除しようとする試みは許可されるべきではありません。
    次で指定:
    インターフェース MessageGroupStore 内の completeGroup
    パラメーター:
    groupId - グループ識別子。
  - getOneMessageFromGroup
```
public Message<?> getOneMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    MessageGroup から 1 つの Message を返します。
    次で指定:
    インターフェース MessageGroupStore 内の getOneMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    Message
  - getMessagesForGroup
```
public CollectionSE<Message<?>> getMessagesForGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    指定されたグループ ID のメッセージを取得します。
    次で指定:
    インターフェース MessageGroupStore 内の getMessagesForGroup
    パラメーター:
    groupId - メッセージを取得するグループ ID。
    戻り値:
    グループのメッセージ。
  - getMessageCountForAllMessageGroups
```
@ManagedAttribute
public int getMessageCountForAllMessageGroups()
```
    インターフェースからコピーされた説明: MessageGroupStore
    すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore 内の getMessageCountForAllMessageGroups
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageCountForAllMessageGroups
    戻り値:
    メッセージの数
  - getMessageGroupCount
```
@ManagedAttribute
public int getMessageGroupCount()
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージグループの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore 内の getMessageGroupCount
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageGroupCount
    戻り値:
    メッセージグループの数

クラス MongoDbMessageStore

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

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

フィールド概要

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

コンストラクター概要

方法の概要

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

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

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

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

フィールドの詳細

SEQUENCE_NAME

コンストラクターの詳細

MongoDbMessageStore

MongoDbMessageStore

メソッドの詳細

setBeanClassLoader

setApplicationContext

addAllowedPatterns

setCustomConverters

afterPropertiesSet

addMessage

getMessage

getMessageMetadata

getMessageCount

removeMessage

getMessageGroup

addMessagesToGroup

removeMessagesFromGroup

removeMessageGroup

iterator

pollMessageFromGroup

messageGroupSize

setLastReleasedSequenceNumberForGroup

completeGroup

getOneMessageFromGroup

getMessagesForGroup

getMessageCountForAllMessageGroups

getMessageGroupCount