SimpleMessageStore (Spring Integration API)

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

実装済みのインターフェース一覧:
IterableSE<MessageGroup>, BasicMessageGroupStore, ChannelMessageStore, MessageGroupStore, MessageStore
```
public class SimpleMessageStore
extends AbstractMessageGroupStore
implements MessageStore, ChannelMessageStore
```
MessageStore および MessageGroupStore のマップベースのメモリ内実装。ストアの最大容量を強制します。
導入:
2.0
作成者:
Iwein Fuld, Mark Fisher, Dave Syer, Oleg Zhurakousky, Gary Russell, Ryan Barker, Artem Bilan

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

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

コンストラクター概要

コンストラクター
コンストラクターと説明
`SimpleMessageStore()` 容量無制限の SimpleMessageStore を作成します
`SimpleMessageStore(int capacity)` 個別のメッセージとグループ化されたメッセージに対して同じ容量の SimpleMessageStore を作成します。
`SimpleMessageStore(int individualCapacity, int groupCapacity)` 指定された容量によって制限される最大サイズ、または指定された容量が 1 未満の場合は無制限のサイズで SimpleMessageStore を作成します。
`SimpleMessageStore(int individualCapacity, int groupCapacity, LockRegistry lockRegistry)` 指定された容量によって制限される最大サイズの SimpleMessageStore と、メッセージグループ操作の同時実行性のための LockRegistry を作成します。
`SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout)` 指定された容量とミリ秒単位のタイムアウトによって制限された最大サイズで SimpleMessageStore を作成し、ストアの空のスロットを待機します。
`SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout, LockRegistry lockRegistry)` 指定された容量によって制限される最大サイズ、ストア内の空のスロットを待機するためのミリ秒単位のタイムアウト、メッセージグループ操作の同時実行のための LockRegistry を使用して SimpleMessageStore を作成します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`<T> Message<T>`	`addMessage(Message<T> message)` 提供されたメッセージを MessageStore に入れます。
`void`	`addMessagesToGroup(ObjectSE groupId, Message<?>... messages)` グループ ID に関連付けてメッセージを保存します。
`void`	`clearMessageGroup(ObjectSE groupId)`
`void`	`completeGroup(ObjectSE groupId)` この MessageGroup を完成させます。
`protected MessageGroup`	`copy(MessageGroup group)` expireMessageGroups で使用されます。
`MessageGroupMetadata`	`getGroupMetadata(ObjectSE groupId)` メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
`Message<?>`	`getMessage(UUIDSE key)`
`long`	`getMessageCount()` ストア内のメッセージ数を示すオプションの属性。
`MessageGroup`	`getMessageGroup(ObjectSE groupId)` このグループ ID で `BasicMessageGroupStore.addMessageToGroup(Object, Message)` を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
`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 key)` 指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。
`void`	`removeMessageGroup(ObjectSE groupId)` この ID のメッセージグループを削除します。
`void`	`removeMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)` グループからのメッセージの削除を永続化します。
`void`	`setCopyOnGet(boolean copyOnGet)` false に設定すると、`getMessageGroup(Object)` でのグループのコピーが無効になります。
`void`	`setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)` 最後にリリースされたメッセージのシーケンス番号を設定できます。
`void`	`setLazyLoadMessageGroups(boolean lazyLoadMessageGroups)` `BasicMessageGroupStore.getMessageGroup(Object)` の結果を `PersistentMessageGroup` にラップするかどうかを指定します。グループのメッセージの遅延ロードプロキシデフォルトは `true` です。
`void`	`setLockRegistry(LockRegistry lockRegistry)`

クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたメソッド
addMessageToGroup, expireMessageGroups, getMessageCountForAllMessageGroups, getMessageGroupCount, getMessageGroupFactory, isTimeoutOnIdle, registerMessageGroupExpiryCallback, removeMessagesFromGroup, setExpiryCallbacks, 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 から継承されたメソッド
addMessageToGroup

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

- コンストラクターの詳細
  - SimpleMessageStore
```
public SimpleMessageStore(int individualCapacity,
                          int groupCapacity)
```
    最大サイズが指定された容量によって制限されるか、指定された容量が 1 未満の場合は無制限のサイズで SimpleMessageStore を作成します。容量は、addMessage(Message) を介して保存されたメッセージと AbstractMessageGroupStore.addMessageToGroup(Object, Message) を介して保存されたメッセージに個別に適用されます。どちらの場合も、容量は保存できるメッセージの数に適用され、その制限に達すると、別のメッセージを保存しようとすると例外が発生します。
    パラメーター:
    individualCapacity - メッセージ容量。
    groupCapacity - 各グループの容量。
  - SimpleMessageStore
```
public SimpleMessageStore(int individualCapacity,
                          int groupCapacity,
                          long upperBoundTimeout)
```
    指定された容量とミリ秒単位のタイムアウトによって制限された最大サイズで SimpleMessageStore を作成し、ストアの空のスロットを待機します。
    パラメーター:
    individualCapacity - メッセージ容量。
    groupCapacity - 各グループの容量。
    upperBoundTimeout - ストアが最大容量に達した場合に待機する時間。
    導入:
    4.3
    関連事項:
    SimpleMessageStore(int, int)
  - SimpleMessageStore
```
public SimpleMessageStore(int individualCapacity,
                          int groupCapacity,
                          LockRegistry lockRegistry)
```
    指定された容量によって制限される最大サイズの SimpleMessageStore と、メッセージグループ操作の同時実行性のための LockRegistry を作成します。
    パラメーター:
    individualCapacity - メッセージ容量。
    groupCapacity - 各グループの容量。
    lockRegistry - ロックレジストリ。
    関連事項:
    SimpleMessageStore(int, int, long, LockRegistry)
  - SimpleMessageStore
```
public SimpleMessageStore(int individualCapacity,
                          int groupCapacity,
                          long upperBoundTimeout,
                          LockRegistry lockRegistry)
```
    指定された容量によって制限される最大サイズ、ストア内の空のスロットを待機するためのミリ秒単位のタイムアウト、メッセージグループ操作の同時実行のための LockRegistry を使用して SimpleMessageStore を作成します。
    パラメーター:
    individualCapacity - メッセージ容量。
    groupCapacity - 各グループの容量。
    upperBoundTimeout - ストアが最大容量にある場合に待機する時間
    lockRegistry - ロックレジストリ。
    導入:
    4.3
  - SimpleMessageStore
```
public SimpleMessageStore(int capacity)
```
    個別のメッセージとグループ化されたメッセージに対して同じ容量の SimpleMessageStore を作成します。
    パラメーター:
    capacity - 容量。
  - SimpleMessageStore
```
public SimpleMessageStore()
```
    容量無制限の SimpleMessageStore を作成します
- メソッドの詳細
  - setCopyOnGet
```
public void setCopyOnGet(boolean copyOnGet)
```
    false に設定すると、getMessageGroup(Object) でのグループのコピーが無効になります。4.1 以降、これはデフォルトで false です。
    パラメーター:
    copyOnGet - コピーする場合は true、コピーしない場合は false。
    導入:
    4.0.1
  - setLockRegistry
```
public void setLockRegistry(LockRegistry lockRegistry)
```
  - setLazyLoadMessageGroups
```
public void setLazyLoadMessageGroups(boolean lazyLoadMessageGroups)
```
    クラスからコピーされた説明: AbstractMessageGroupStore
    BasicMessageGroupStore.getMessageGroup(Object) の結果を PersistentMessageGroup にラップするかどうかを指定します。グループのメッセージの遅延ロードプロキシデフォルトは true です。
    ターゲットロジックは SimpleMessageGroupFactory.GroupType.PERSISTENT に基づいています。
    オーバーライド:
    クラス AbstractMessageGroupStore の setLazyLoadMessageGroups
    パラメーター:
    lazyLoadMessageGroups - 使用する boolean フラグ。
  - getMessageCount
```
@ManagedAttribute
public long getMessageCount()
```
    インターフェースからコピーされた説明: MessageStore
    ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。
    次で指定:
    インターフェース MessageStore 内の getMessageCount
    戻り値:
    メッセージの数。
  - 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 key)
```
    次で指定:
    インターフェース MessageStore 内の getMessage
    パラメーター:
    key - メッセージ識別子。
    戻り値:
    指定された ID のメッセージ。MessageStore にその ID のメッセージが存在しない場合は null。
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    提供された id によって Message の MessageMetadata を返します。
    次で指定:
    インターフェース MessageStore 内の getMessageMetadata
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    指定された ID の MessageMetadata、またはその ID のメッセージが MessageStore に存在しないか、メッセージにメタデータがない場合（以前のバージョンのレガシーメッセージ）は null。
  - removeMessage
```
public Message<?> removeMessage(UUIDSE key)
```
    インターフェースからコピーされた説明: MessageStore
    指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。その ID のメッセージがストアに存在しない場合、これは null を返します。
    次で指定:
    インターフェース MessageStore 内の removeMessage
    パラメーター:
    key - メッセージ識別子。
    戻り値:
    メッセージ。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    このグループ ID で BasicMessageGroupStore.addMessageToGroup(Object, Message) を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - copy
```
protected MessageGroup copy(MessageGroup group)
```
    クラスからコピーされた説明: AbstractMessageGroupStore
    expireMessageGroups によって使用されます。グループが現在から期限切れになるまでの間に変更されたかどうかを適切に検出できるように、リーパーの実行時にグループのスナップショットを返す必要があります。永続ストアには必要ないため、デフォルトの動作ではグループのみを返します。
    オーバーライド:
    クラス AbstractMessageGroupStore の copy
    パラメーター:
    group - グループ。
    戻り値:
    グループ、またはコピー。
  - addMessagesToGroup
```
public void addMessagesToGroup(ObjectSE groupId,
                               Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース MessageGroupStore 内の addMessagesToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    messages - 追加するメッセージ。
  - removeMessageGroup
```
public void removeMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この ID のメッセージグループを削除します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の removeMessageGroup
    パラメーター:
    groupId - 削除するグループの ID。
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE groupId,
                                    CollectionSE<Message<?>> messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore 内の removeMessagesFromGroup
    パラメーター:
    groupId - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - iterator
```
public IteratorSE<MessageGroup> iterator()
```
    次で指定:
    インターフェース IterableSE<MessageGroup> 内の iteratorSE
    次で指定:
    インターフェース MessageGroupStore 内の iterator
    戻り値:
    現在累積されている MessageGroup の反復子。
  - 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 - グループ識別子。
  - pollMessageFromGroup
```
public Message<?> pollMessageFromGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup からのメッセージをポーリングし（実装でサポートされている場合は FIFO スタイルで）、ポーリングされた Message も削除します
    次で指定:
    インターフェース BasicMessageGroupStore 内の pollMessageFromGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージ。
  - messageGroupSize
```
public int messageGroupSize(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup のサイズを返します。
    次で指定:
    インターフェース BasicMessageGroupStore 内の messageGroupSize
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    サイズ。
  - getGroupMetadata
```
public MessageGroupMetadata getGroupMetadata(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
    次で指定:
    インターフェース MessageGroupStore 内の getGroupMetadata
    オーバーライド:
    クラス AbstractMessageGroupStore の getGroupMetadata
    パラメーター:
    groupId - グループ ID。
    戻り値:
    メタデータ。
  - 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。
    戻り値:
    グループのメッセージ。
  - clearMessageGroup
```
public void clearMessageGroup(ObjectSE groupId)
```

クラス SimpleMessageStore

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

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

フィールド概要

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

コンストラクター概要

方法の概要

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

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

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

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

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

コンストラクターの詳細

SimpleMessageStore

SimpleMessageStore

SimpleMessageStore

SimpleMessageStore

SimpleMessageStore

SimpleMessageStore

メソッドの詳細

setCopyOnGet

setLockRegistry

setLazyLoadMessageGroups

getMessageCount

addMessage

getMessage

getMessageMetadata

removeMessage

getMessageGroup

copy

addMessagesToGroup

removeMessageGroup

removeMessagesFromGroup

iterator

setLastReleasedSequenceNumberForGroup

completeGroup

pollMessageFromGroup

messageGroupSize

getGroupMetadata

getOneMessageFromGroup

getMessagesForGroup

clearMessageGroup