AbstractConfigurableMongoDbMessageStore (Spring Integration API)

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

実装済みのインターフェース一覧:
IterableSE<MessageGroup>, Aware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore, MessageGroupStore
既知の直属サブクラス
ConfigurableMongoDbMessageStore, MongoDbChannelMessageStore
```
public abstract class AbstractConfigurableMongoDbMessageStore
extends AbstractMessageGroupStore
implements InitializingBean, ApplicationContextAware
```
このクラスの実装の一般的なオプションの構成を提供するための、抽象的な MongoDB AbstractMessageGroupStore 実装。
導入:
4.0
作成者:
Artem Bilan

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

フィールド概要
フィールド
修飾子と型フィールドと説明
protected StringSE collectionName
protected Log logger
protected MongoDatabaseFactory mongoDbFactory
static StringSE SEQUENCE_NAME

フィールド
修飾子と型	フィールドと説明
`protected StringSE`	`collectionName`
`protected Log`	`logger`
`protected MongoDatabaseFactory`	`mongoDbFactory`
`static StringSE`	`SEQUENCE_NAME`

コンストラクター概要

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

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`addMessageDocument(MessageDocument document)`
`void`	`addMessagesToGroup(ObjectSE groupId, Message<?>... messages)` グループ ID に関連付けてメッセージを保存します。
`void`	`afterPropertiesSet()`
`void`	`completeGroup(ObjectSE groupId)` この MessageGroup を完成させます。
`protected ApplicationContext`	`getApplicationContext()`
`protected MappingMongoConverter`	`getMappingMongoConverter()`
`Message<?>`	`getMessage(UUIDSE id)`
`protected MessageBuilderFactory`	`getMessageBuilderFactory()`
`MessageMetadata`	`getMessageMetadata(UUIDSE id)`
`CollectionSE<Message<?>>`	`getMessagesForGroup(ObjectSE groupId)` 指定されたグループ ID のメッセージを取得します。
`protected MongoTemplate`	`getMongoTemplate()`
`protected long`	`getNextId()` `MessageDocument` `sequence` を含むドキュメントに対して MongoDB `INC` 操作を実行し、新しい `MessageDocument` の新しい増分値を返します。
`Message<?>`	`getOneMessageFromGroup(ObjectSE groupId)` `MessageGroup` から 1 つの `Message` を返します。
`protected static Query`	`groupIdQuery(ObjectSE groupId)`
`IteratorSE<MessageGroup>`	`iterator()`
`int`	`messageGroupSize(ObjectSE groupId)` この MessageGroup のサイズを返します。
`void`	`removeMessageGroup(ObjectSE groupId)` この ID のメッセージグループを削除します。
`void`	`removeMessagesFromGroup(ObjectSE key, CollectionSE<Message<?>> messages)` グループからのメッセージの削除を永続化します。
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)` 最後にリリースされたメッセージのシーケンス番号を設定できます。

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

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

- フィールドの詳細
  - SEQUENCE_NAME
```
public static final StringSE SEQUENCE_NAME
```
    関連事項:
    定数フィールド値
  - logger
```
protected final Log logger
```
  - collectionName
```
protected final StringSE collectionName
```
  - mongoDbFactory
```
protected final MongoDatabaseFactory mongoDbFactory
```
- コンストラクターの詳細
  - AbstractConfigurableMongoDbMessageStore
```
public AbstractConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate,
                                               StringSE collectionName)
```
  - AbstractConfigurableMongoDbMessageStore
```
public AbstractConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                                               StringSE collectionName)
```
  - AbstractConfigurableMongoDbMessageStore
```
public AbstractConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory,
                                               MappingMongoConverter mappingMongoConverter,
                                               StringSE collectionName)
```
- メソッドの詳細
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException
```
    次で指定:
    インターフェース ApplicationContextAware 内の setApplicationContext
    例外:
    BeansException
  - getMongoTemplate
```
protected MongoTemplate getMongoTemplate()
```
  - getMappingMongoConverter
```
protected MappingMongoConverter getMappingMongoConverter()
```
  - getApplicationContext
```
protected ApplicationContext getApplicationContext()
```
  - getMessageBuilderFactory
```
protected MessageBuilderFactory getMessageBuilderFactory()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    次で指定:
    インターフェース InitializingBean 内の afterPropertiesSet
  - getMessage
```
public Message<?> getMessage(UUIDSE id)
```
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(UUIDSE id)
```
  - removeMessageGroup
```
public void removeMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この ID のメッセージグループを削除します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の removeMessageGroup
    パラメーター:
    groupId - 削除するグループの ID。
  - messageGroupSize
```
public int messageGroupSize(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup のサイズを返します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の messageGroupSize
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    サイズ。
  - getNextId
```
protected long getNextId()
```
    MessageDocument sequence を含むドキュメントに対して MongoDB INC 操作を実行し、新しい MessageDocument の新しい増分値を返します。SEQUENCE_NAME ドキュメントはオンデマンドで作成されます。
    戻り値:
    次のシーケンス値。
  - addMessageDocument
```
protected void addMessageDocument(MessageDocument document)
```
  - groupIdQuery
```
protected static Query groupIdQuery(ObjectSE groupId)
```
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE key,
                                    CollectionSE<Message<?>> messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore 内の removeMessagesFromGroup
    パラメーター:
    key - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - setLastReleasedSequenceNumberForGroup
```
public void setLastReleasedSequenceNumberForGroup(ObjectSE groupId,
                                                  int sequenceNumber)
```
    インターフェースからコピーされた説明: MessageGroupStore
    最後にリリースされたメッセージのシーケンス番号を設定できます。ユースケースの並べ替えに使用
    次で指定:
    インターフェース MessageGroupStore 内の setLastReleasedSequenceNumberForGroup
    パラメーター:
    groupId - グループ識別子。
    sequenceNumber - シーケンス番号。
  - iterator
```
public IteratorSE<MessageGroup> iterator()
```
    次で指定:
    インターフェース IterableSE<MessageGroup> 内の iteratorSE
    次で指定:
    インターフェース MessageGroupStore 内の iterator
    戻り値:
    現在累積されている MessageGroup の反復子。
  - 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
  - addMessagesToGroup
```
public void addMessagesToGroup(ObjectSE groupId,
                               Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース MessageGroupStore 内の addMessagesToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    messages - 追加するメッセージ。
  - getMessagesForGroup
```
public CollectionSE<Message<?>> getMessagesForGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    指定されたグループ ID のメッセージを取得します。
    次で指定:
    インターフェース MessageGroupStore 内の getMessagesForGroup
    パラメーター:
    groupId - メッセージを取得するグループ ID。
    戻り値:
    グループのメッセージ。

クラス AbstractConfigurableMongoDbMessageStore

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

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

フィールド概要

コンストラクター概要

方法の概要

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

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

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

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

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

フィールドの詳細

SEQUENCE_NAME

logger

collectionName

mongoDbFactory

コンストラクターの詳細

AbstractConfigurableMongoDbMessageStore

AbstractConfigurableMongoDbMessageStore

AbstractConfigurableMongoDbMessageStore

メソッドの詳細

setApplicationContext

getMongoTemplate

getMappingMongoConverter

getApplicationContext

getMessageBuilderFactory

afterPropertiesSet

getMessage

getMessageMetadata

removeMessageGroup

messageGroupSize

getNextId

addMessageDocument

groupIdQuery

removeMessagesFromGroup

setLastReleasedSequenceNumberForGroup

iterator

completeGroup

getOneMessageFromGroup

addMessagesToGroup

getMessagesForGroup