AbstractKeyValueMessageStore (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.store.AbstractBatchingMessageGroupStore
- - org.springframework.integration.store.AbstractMessageGroupStore
  - - org.springframework.integration.store.AbstractKeyValueMessageStore

実装されているすべてのインターフェース:
IterableSE<MessageGroup>, BasicMessageGroupStore, MessageGroupStore, MessageStore
既知の直属サブクラス
GemfireMessageStore, RedisMessageStore
```
public abstract class AbstractKeyValueMessageStore
extends AbstractMessageGroupStore
implements MessageStore
```
キー / 値スタイル MessageGroupStore および MessageStore の実装の基本クラス
導入:
2.1
作成者:
Oleg Zhurakousky, Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected static StringSE MESSAGE_GROUP_KEY_PREFIX
protected static StringSE MESSAGE_KEY_PREFIX
- クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたフィールド
  logger

フィールド
修飾子と型	フィールドと説明
`protected static StringSE`	`MESSAGE_GROUP_KEY_PREFIX`
`protected static StringSE`	`MESSAGE_KEY_PREFIX`

コンストラクターの概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractKeyValueMessageStore()`
`protected`	`AbstractKeyValueMessageStore(StringSE prefix)` キーの提供されたプレフィックスに基づいてインスタンスを作成し、同じターゲット Key-Value データベース内の異なるストアインスタンスを区別します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`<T> Message<T>`	`addMessage(Message<T> message)` 提供されたメッセージを MessageStore に入れます。
`void`	`addMessagesToGroup(ObjectSE groupId, Message<?>... messages)` グループ ID に関連付けてメッセージを保存します。
`void`	`completeGroup(ObjectSE groupId)` この MessageGroup を完成させます。
`protected void`	`doAddMessage(Message<?> message)`
`protected abstract CollectionSE<?>`	`doListKeys(StringSE keyPattern)`
`protected abstract ObjectSE`	`doRemove(ObjectSE id)`
`protected abstract void`	`doRemoveAll(CollectionSE<ObjectSE> ids)`
`protected abstract ObjectSE`	`doRetrieve(ObjectSE id)`
`protected abstract void`	`doStore(ObjectSE id, ObjectSE objectToStore)`
`protected abstract void`	`doStoreIfAbsent(ObjectSE id, ObjectSE objectToStore)`
`MessageGroupMetadata`	`getGroupMetadata(ObjectSE groupId)` メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
`StringSE`	`getGroupPrefix()` 同じターゲット Key-Value データベース内の異なるストアインスタンスを区別するために、メッセージグループキーに構成されたプレフィックスを返します。
`Message<?>`	`getMessage(UUIDSE messageId)`
`long`	`getMessageCount()` ストア内のメッセージ数を示すオプションの属性。
`MessageGroup`	`getMessageGroup(ObjectSE groupId)` 必要に応じて、SimpleMessageGroup の新しいインスタンスを作成します。
`MessageMetadata`	`getMessageMetadata(UUIDSE messageId)` 提供された `id` によって `Message` の `MessageMetadata` を返します。
`protected StringSE`	`getMessagePrefix()` 同じターゲット Key-Value データベース内の異なるストアインスタンスを区別するために、メッセージキーに設定されたプレフィックスを返します。
`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 を持つ MessageGroup を削除します。
`void`	`removeMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)` グループからのメッセージの削除を永続化します。
`void`	`setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)` 最後にリリースされたメッセージのシーケンス番号を設定できます。

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

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

- フィールドの詳細
  - MESSAGE_KEY_PREFIX
```
protected static final StringSE MESSAGE_KEY_PREFIX
```
    関連事項:
    定数フィールド値
  - MESSAGE_GROUP_KEY_PREFIX
```
protected static final StringSE MESSAGE_GROUP_KEY_PREFIX
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - AbstractKeyValueMessageStore
```
protected AbstractKeyValueMessageStore()
```
  - AbstractKeyValueMessageStore
```
protected AbstractKeyValueMessageStore(StringSE prefix)
```
    キーの提供されたプレフィックスに基づいてインスタンスを作成し、同じターゲット Key-Value データベース内の異なるストアインスタンスを区別します。デフォルトは空の文字列です - プレフィックスはありません。メッセージの実際のプレフィックスは prefix + MESSAGE_ です。メッセージグループ - prefix + MESSAGE_GROUP_
    パラメーター:
    prefix - 使用する接頭辞
    導入:
    4.3.12
- メソッドの詳細
  - getMessagePrefix
```
protected StringSE getMessagePrefix()
```
    同じターゲット Key-Value データベース内の異なるストアインスタンスを区別するために、メッセージキーに設定されたプレフィックスを返します。デフォルトは "MESSAGE_"- カスタムプレフィックスなし。
    戻り値:
    キーのプレフィックス
    導入:
    4.3.12
  - getGroupPrefix
```
public StringSE getGroupPrefix()
```
    同じターゲット Key-Value データベース内の異なるストアインスタンスを区別するために、メッセージグループキーに構成されたプレフィックスを返します。デフォルトは "MESSAGE_GROUP_"- カスタムプレフィックスなし。
    戻り値:
    キーのプレフィックス
    導入:
    4.3.12
  - getMessage
```
public Message<?> getMessage(UUIDSE messageId)
```
    次で指定:
    インターフェース MessageStore の getMessage
    パラメーター:
    messageId - メッセージ識別子。
    戻り値:
    指定された ID のメッセージ。MessageStore にその ID のメッセージが存在しない場合は null。
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(UUIDSE messageId)
```
    インターフェースからコピーされた説明: MessageStore
    提供された id によって Message の MessageMetadata を返します。
    次で指定:
    インターフェース MessageStore の getMessageMetadata
    パラメーター:
    messageId - メッセージ識別子。
    戻り値:
    指定された ID の MessageMetadata、またはその ID のメッセージが MessageStore に存在しないか、メッセージにメタデータがない場合（以前のバージョンのレガシーメッセージ）は null。
  - addMessage
```
public <T> Message<T> addMessage(Message<T> message)
```
    インターフェースからコピーされた説明: MessageStore
    提供されたメッセージを MessageStore に入れます。ストアはメッセージを内部で変更する必要がある場合があり、その場合、戻り値は入力と異なる場合があります。戻り値の ID は、MessageStore.getMessage(UUID) および MessageStore.removeMessage(UUID) が正しく動作するようにインデックスとして使用されます。メッセージは不変であるため、同じメッセージを複数回入力しても何も起こりません。
    次で指定:
    インターフェース MessageStore の addMessage
    型パラメーター:
    T - ペイロード型。
    パラメーター:
    message - メッセージ。
    戻り値:
    保存されたメッセージ。
  - doAddMessage
```
protected void doAddMessage(Message<?> message)
```
  - removeMessage
```
public Message<?> removeMessage(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。その ID のメッセージがストアに存在しない場合、これは null を返します。
    次で指定:
    インターフェース MessageStore の removeMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    メッセージ。
  - getMessageCount
```
@ManagedAttribute
public long getMessageCount()
```
    インターフェースからコピーされた説明: MessageStore
    ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。
    次で指定:
    インターフェース MessageStore の getMessageCount
    戻り値:
    メッセージの数。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    必要に応じて、SimpleMessageGroup の新しいインスタンスを作成します。
    次で指定:
    インターフェース BasicMessageGroupStore の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - getGroupMetadata
```
public MessageGroupMetadata getGroupMetadata(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
    次で指定:
    インターフェース MessageGroupStore の getGroupMetadata
    オーバーライド:
    クラス AbstractMessageGroupStore の getGroupMetadata
    パラメーター:
    groupId - グループ ID。
    戻り値:
    メタデータ。
  - 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 - 削除するメッセージ。
  - completeGroup
```
public void completeGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    この MessageGroup を完成させます。MessageGroup の補完は、一般に、このグループがこれ以上の変更操作を実行できないようにする必要があることを意味します。たとえば、グループから新しいメッセージを追加 / 削除しようとする試みは許可されるべきではありません。
    次で指定:
    インターフェース MessageGroupStore の completeGroup
    パラメーター:
    groupId - グループ識別子。
  - removeMessageGroup
```
public void removeMessageGroup(ObjectSE groupId)
```
    提供されたグループ ID を持つ MessageGroup を削除します。
    次で指定:
    インターフェース BasicMessageGroupStore の removeMessageGroup
    パラメーター:
    groupId - 削除するグループの ID。
  - setLastReleasedSequenceNumberForGroup
```
public void setLastReleasedSequenceNumberForGroup(ObjectSE groupId,
                                                  int sequenceNumber)
```
    インターフェースからコピーされた説明: MessageGroupStore
    最後にリリースされたメッセージのシーケンス番号を設定できます。ユースケースの並べ替えに使用
    次で指定:
    インターフェース MessageGroupStore の setLastReleasedSequenceNumberForGroup
    パラメーター:
    groupId - グループ識別子。
    sequenceNumber - シーケンス番号。
  - pollMessageFromGroup
```
public Message<?> pollMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた Message も削除します
    次で指定:
    インターフェース BasicMessageGroupStore の pollMessageFromGroup
    パラメーター:
    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。
    戻り値:
    グループのメッセージ。
  - iterator
```
public IteratorSE<MessageGroup> iterator()
```
    次で指定:
    インターフェース IterableSE<MessageGroup> の iteratorSE
    次で指定:
    インターフェース MessageGroupStore の iterator
    戻り値:
    現在累積されている MessageGroup の反復子。
  - messageGroupSize
```
public int messageGroupSize(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup のサイズを返します。
    次で指定:
    インターフェース BasicMessageGroupStore の messageGroupSize
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    サイズ。
  - doRetrieve
```
protected abstract ObjectSE doRetrieve(ObjectSE id)
```
  - doStore
```
protected abstract void doStore(ObjectSE id,
                                ObjectSE objectToStore)
```
  - doStoreIfAbsent
```
protected abstract void doStoreIfAbsent(ObjectSE id,
                                        ObjectSE objectToStore)
```
  - doRemove
```
protected abstract ObjectSE doRemove(ObjectSE id)
```
  - doRemoveAll
```
protected abstract void doRemoveAll(CollectionSE<ObjectSE> ids)
```
  - doListKeys
```
protected abstract CollectionSE<?> doListKeys(StringSE keyPattern)
```

クラス AbstractKeyValueMessageStore

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

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

フィールドの詳細

MESSAGE_KEY_PREFIX

MESSAGE_GROUP_KEY_PREFIX

コンストラクターの詳細

AbstractKeyValueMessageStore

AbstractKeyValueMessageStore

メソッドの詳細

getMessagePrefix

getGroupPrefix

getMessage

getMessageMetadata

addMessage

doAddMessage

removeMessage

getMessageCount

getMessageGroup

getGroupMetadata

addMessagesToGroup

removeMessagesFromGroup

completeGroup

removeMessageGroup

setLastReleasedSequenceNumberForGroup

pollMessageFromGroup

getOneMessageFromGroup

getMessagesForGroup

iterator

messageGroupSize

doRetrieve

doStore

doStoreIfAbsent

doRemove

doRemoveAll

doListKeys