AbstractMessageGroupStore (Spring Integration API)

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

実装されているすべてのインターフェース:
IterableSE<MessageGroup>, BasicMessageGroupStore, MessageGroupStore
既知の直属サブクラス
AbstractConfigurableMongoDbMessageStore, AbstractKeyValueMessageStore, JdbcMessageStore, MongoDbMessageStore, SimpleMessageStore
```
@ManagedResource
public abstract class AbstractMessageGroupStore
extends AbstractBatchingMessageGroupStore
implements MessageGroupStore, IterableSE<MessageGroup>
```
導入:
2.0
作成者:
Dave Syer, Oleg Zhurakousky, Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected AbstractMessageGroupStore()
protected AbstractMessageGroupStore(boolean lazyLoadMessageGroups)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractMessageGroupStore()`
`protected`	`AbstractMessageGroupStore(boolean lazyLoadMessageGroups)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`MessageGroup`	`addMessageToGroup(ObjectSE groupId, Message<?> message)` グループ ID に関連付けてメッセージを保存します。
`protected MessageGroup`	`copy(MessageGroup group)` expireMessageGroups で使用されます。
`int`	`expireMessageGroups(long timeout)` 期限切れのグループ（タイムスタンプが現在の時刻から指定されたしきい値を差し引いたものより古い）をすべて抽出し、登録されている各コールバックを順番に呼び出します。
`MessageGroupMetadata`	`getGroupMetadata(ObjectSE groupId)` メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
`int`	`getMessageCountForAllMessageGroups()` すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。
`int`	`getMessageGroupCount()` メッセージグループの数を示すオプションの属性。
`protected MessageGroupFactory`	`getMessageGroupFactory()`
`boolean`	`isTimeoutOnIdle()`
`void`	`registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)` メッセージグループが `MessageGroupStore.expireMessageGroups(long)` を介して期限切れになったときのコールバックを登録します。
`void`	`removeMessagesFromGroup(ObjectSE key, Message<?>... messages)` グループからのメッセージの削除を永続化します。
`void`	`setExpiryCallbacks(CollectionSE<MessageGroupStore.MessageGroupCallback> expiryCallbacks)` メッセージストアでの有効期限コールバックの便利なインジェクションポイント。
`void`	`setLazyLoadMessageGroups(boolean lazyLoadMessageGroups)` `BasicMessageGroupStore.getMessageGroup(Object)` の結果を `PersistentMessageGroup` にラップするかどうかを指定します。グループのメッセージの遅延ロードプロキシデフォルトは `true` です。
`void`	`setTimeoutOnIdle(boolean timeoutOnIdle)` タイムアウト計算のルールを上書きできます。

クラス 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.MessageGroupStore から継承されたメソッド
addMessagesToGroup, completeGroup, getMessagesForGroup, getOneMessageFromGroup, iterator, removeMessagesFromGroup, setLastReleasedSequenceNumberForGroup

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

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractMessageGroupStore
```
protected AbstractMessageGroupStore()
```
  - AbstractMessageGroupStore
```
protected AbstractMessageGroupStore(boolean lazyLoadMessageGroups)
```
- メソッドの詳細
  - getMessageGroupFactory
```
protected MessageGroupFactory getMessageGroupFactory()
```
    オーバーライド:
    クラス AbstractBatchingMessageGroupStore の getMessageGroupFactory
  - setExpiryCallbacks
```
public void setExpiryCallbacks(CollectionSE<MessageGroupStore.MessageGroupCallback> expiryCallbacks)
```
    メッセージストアでの有効期限コールバックの便利なインジェクションポイント。提供される各コールバックは、MessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback) を使用してストアに登録されるだけです。
    パラメーター:
    expiryCallbacks - 追加する有効期限コールバック
  - isTimeoutOnIdle
```
public boolean isTimeoutOnIdle()
```
  - setTimeoutOnIdle
```
public void setTimeoutOnIdle(boolean timeoutOnIdle)
```
    タイムアウト計算のルールを上書きできます。通常のタイムアウトは、MessageGroup が作成された時間に基づいています。MessageGroup がアイドリングしていた時間に基づいてタイムアウトを設定する場合（たとえば、最後の更新から非アクティブ）、"true" を指定してこのメソッドを呼び出します。デフォルトは "false" です。
    パラメーター:
    timeoutOnIdle - ブール値。
  - setLazyLoadMessageGroups
```
public void setLazyLoadMessageGroups(boolean lazyLoadMessageGroups)
```
    BasicMessageGroupStore.getMessageGroup(Object) の結果を PersistentMessageGroup にラップするかどうかを指定します。グループのメッセージの遅延ロードプロキシデフォルトは true です。
    ターゲットロジックは SimpleMessageGroupFactory.GroupType.PERSISTENT に基づいています。
    パラメーター:
    lazyLoadMessageGroups - 使用する boolean フラグ。
    導入:
    4.3
  - registerMessageGroupExpiryCallback
```
public void registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージグループが MessageGroupStore.expireMessageGroups(long) を介して期限切れになったときのコールバックを登録します。
    次で指定:
    インターフェース MessageGroupStore の registerMessageGroupExpiryCallback
    パラメーター:
    callback - メッセージグループがクリーンアップされたときに実行するコールバック。
  - expireMessageGroups
```
@ManagedOperation
public int expireMessageGroups(long timeout)
```
    インターフェースからコピーされた説明: MessageGroupStore
    期限切れのグループ（タイムスタンプが現在の時刻から指定されたしきい値を差し引いたものより古い）をすべて抽出し、登録されている各コールバックを順番に呼び出します。例: タイムアウト 100 で呼び出して、100 ミリ秒以上前に作成され、まだ完了していないすべてのグループを期限切れにします。すべてのメッセージグループを期限切れにするには、タイムアウト 0（または安全のために負の値）を使用します。
    次で指定:
    インターフェース MessageGroupStore の expireMessageGroups
    パラメーター:
    timeout - 使用するタイムアウトしきい値
    戻り値:
    期限切れのメッセージグループの数
    関連事項:
    MessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback)
  - copy
```
protected MessageGroup copy(MessageGroup group)
```
    expireMessageGroups によって使用されます。グループが現在から期限切れになるまでの間に変更されたかどうかを適切に検出できるように、リーパーの実行時にグループのスナップショットを返す必要があります。永続ストアには必要ないため、デフォルトの動作ではグループのみを返します。
    パラメーター:
    group - グループ。
    戻り値:
    グループ、またはコピー。
    導入:
    4.0.1
  - getMessageCountForAllMessageGroups
```
@ManagedAttribute
public int getMessageCountForAllMessageGroups()
```
    インターフェースからコピーされた説明: MessageGroupStore
    すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageCountForAllMessageGroups
    戻り値:
    メッセージの数
  - getMessageGroupCount
```
@ManagedAttribute
public int getMessageGroupCount()
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージグループの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageGroupCount
    戻り値:
    メッセージグループの数
  - getGroupMetadata
```
public MessageGroupMetadata getGroupMetadata(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。
    次で指定:
    インターフェース MessageGroupStore の getGroupMetadata
    パラメーター:
    groupId - グループ ID。
    戻り値:
    メタデータ。
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE key,
                                    Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore の removeMessagesFromGroup
    パラメーター:
    key - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - addMessageToGroup
```
public MessageGroup addMessageToGroup(ObjectSE groupId,
                                      Message<?> message)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース BasicMessageGroupStore の addMessageToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    message - メッセージ。
    戻り値:
    メッセージグループ。

クラス AbstractMessageGroupStore

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

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

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

フィールドの詳細

logger

コンストラクターの詳細

AbstractMessageGroupStore

AbstractMessageGroupStore

メソッドの詳細

getMessageGroupFactory

setExpiryCallbacks

isTimeoutOnIdle

setTimeoutOnIdle

setLazyLoadMessageGroups

registerMessageGroupExpiryCallback

expireMessageGroups

copy

getMessageCountForAllMessageGroups

getMessageGroupCount

getGroupMetadata

removeMessagesFromGroup

addMessageToGroup