MongoDbChannelMessageStore (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.MongoDbChannelMessageStore

実装済みのインターフェース一覧:
IterableSE<MessageGroup>, Aware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore, ChannelMessageStore, MessageGroupStore, PriorityCapableChannelMessageStore
```
public class MongoDbChannelMessageStore
extends AbstractConfigurableMongoDbMessageStore
implements PriorityCapableChannelMessageStore
```
MongoDB PriorityCapableChannelMessageStore の実装。このメッセージストアは、メッセージチャネルにのみ使用されます。
priorityEnabled オプションを提供して、priority 方式でメッセージをポーリングできるようにします。
優先ドキュメントフィールドとして、IntegrationMessageHeaderAccessor.PRIORITY メッセージヘッダーが使用されます。
同じコレクションを org.springframework.integration.channel.QueueChannel と org.springframework.integration.channel.PriorityChannel に使用できますが、これらの場合には MongoDbChannelMessageStore の異なるインスタンスを使用し、最後のインスタンスは priorityEnabled = true オプションを使用する必要があります。
導入:
4.0
作成者:
Artem Bilan

ネストされたクラスの概要
- インターフェース 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` デフォルトの従来のコレクション名。

コンストラクター概要

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

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`MessageGroup`	`addMessageToGroup(ObjectSE groupId, Message<?> message)` グループ ID に関連付けてメッセージを保存します。
`void`	`afterPropertiesSet()`
`MessageGroup`	`getMessageGroup(ObjectSE groupId)` 完全には使用されていません。
`boolean`	`isPriorityEnabled()`
`Message<?>`	`pollMessageFromGroup(ObjectSE groupId)` この `MessageGroup` からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた `Message` も削除します
`void`	`setPriorityEnabled(boolean priorityEnabled)`

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

クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたメソッド
copy, expireMessageGroups, getGroupMetadata, getMessageCountForAllMessageGroups, getMessageGroupCount, 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.BasicMessageGroupStore から継承されたメソッド
messageGroupSize, removeMessageGroup

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

- フィールドの詳細
  - DEFAULT_COLLECTION_NAME
```
public static final StringSE DEFAULT_COLLECTION_NAME
```
    デフォルトの従来のコレクション名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoTemplate mongoTemplate)
```
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoTemplate mongoTemplate,
                                  StringSE collectionName)
```
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoDatabaseFactory mongoDbFactory)
```
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoDatabaseFactory mongoDbFactory,
                                  MappingMongoConverter mappingMongoConverter)
```
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoDatabaseFactory mongoDbFactory,
                                  StringSE collectionName)
```
  - MongoDbChannelMessageStore
```
public MongoDbChannelMessageStore(MongoDatabaseFactory mongoDbFactory,
                                  MappingMongoConverter mappingMongoConverter,
                                  StringSE collectionName)
```
- メソッドの詳細
  - setPriorityEnabled
```
public void setPriorityEnabled(boolean priorityEnabled)
```
  - isPriorityEnabled
```
public boolean isPriorityEnabled()
```
    次で指定:
    インターフェース PriorityCapableChannelMessageStore 内の isPriorityEnabled
    戻り値:
    このチャネルメッセージストアでメッセージ優先度が有効になっている場合は true。
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    次で指定:
    インターフェース InitializingBean 内の afterPropertiesSet
    オーバーライド:
    クラス AbstractConfigurableMongoDbMessageStore の afterPropertiesSet
  - addMessageToGroup
```
public MessageGroup addMessageToGroup(ObjectSE groupId,
                                      Message<?> message)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース BasicMessageGroupStore 内の addMessageToGroup
    オーバーライド:
    クラス AbstractMessageGroupStore の addMessageToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    message - メッセージ。
    戻り値:
    メッセージグループ。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    完全には使用されていません。指定されたグループ ID のみをラップします。
    次で指定:
    インターフェース BasicMessageGroupStore 内の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - pollMessageFromGroup
```
public Message<?> pollMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた Message も削除します
    次で指定:
    インターフェース BasicMessageGroupStore 内の pollMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージ。

クラス MongoDbChannelMessageStore

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

インターフェース 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.BasicMessageGroupStore から継承されたメソッド

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

フィールドの詳細

DEFAULT_COLLECTION_NAME

コンストラクターの詳細

MongoDbChannelMessageStore

MongoDbChannelMessageStore

MongoDbChannelMessageStore

MongoDbChannelMessageStore

MongoDbChannelMessageStore

MongoDbChannelMessageStore

メソッドの詳細

setPriorityEnabled

isPriorityEnabled

afterPropertiesSet

addMessageToGroup

getMessageGroup

pollMessageFromGroup