JdbcMessageStore (Spring Integration API)

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

実装されているすべてのインターフェース:
IterableSE<MessageGroup>, BasicMessageGroupStore, MessageGroupStore, MessageStore
```
public class JdbcMessageStore
extends AbstractMessageGroupStore
implements MessageStore
```
JDBC を介したリレーショナルデータベースを使用した MessageStore の実装。必要なテーブルを作成するための SQL スクリプトは、org/springframework/integration/jdbc/schema-*.sql としてパッケージ化されています。ここで、* はターゲットデータベース型です。
JDBC ベースのメッセージストアを使用して MessageChannel をバックアップする場合は、代わりにチャネル固有の JdbcChannelMessageStore の使用を検討してください。この実装は、相関コンポーネント（<aggregator> など）、<delayer> などを対象としています。
導入:
2.0
作成者:
Dave Syer, Oleg Zhurakousky, Matt Stine, Gunnar Hillert, Will Schipp, Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE DEFAULT_TABLE_PREFIX
テーブルプレフィックスプロパティのデフォルト値。
- クラス org.springframework.integration.store.AbstractMessageGroupStore から継承されたフィールド
  logger

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`DEFAULT_TABLE_PREFIX` テーブルプレフィックスプロパティのデフォルト値。

コンストラクターの概要

コンストラクター
コンストラクターと説明
`JdbcMessageStore(DataSourceSE dataSource)` すべての必須プロパティで `MessageStore` を作成します。
`JdbcMessageStore(JdbcOperations jdbcOperations)` すべての必須プロパティで `MessageStore` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addAllowedPatterns(StringSE... patterns)` 逆直列化が許可されているパッケージ / クラスのパターンを追加します。
`<T> Message<T>`	`addMessage(Message<T> message)` 提供されたメッセージを MessageStore に入れます。
`void`	`addMessagesToGroup(ObjectSE groupId, Message<?>... messages)` グループ ID に関連付けてメッセージを保存します。
`void`	`completeGroup(ObjectSE groupId)` この MessageGroup を完成させます。
`protected Message<?>`	`doPollForMessage(StringSE groupIdKey)` このメソッドは、DB への呼び出しを実行して、MessageGroup 内の最も古いメッセージを取得します。必要に応じて、このメソッドをオーバーライドします。
`protected JdbcOperations`	`getJdbcOperations()` このクラスがサブクラス化されている場合に JdbcOperations への参照を取得するために使用されます
`Message<?>`	`getMessage(UUIDSE id)`
`long`	`getMessageCount()` ストア内のメッセージ数を示すオプションの属性。
`int`	`getMessageCountForAllMessageGroups()` すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。
`MessageGroup`	`getMessageGroup(ObjectSE groupId)` このグループ ID で `BasicMessageGroupStore.addMessageToGroup(Object, Message)` を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
`int`	`getMessageGroupCount()` メッセージグループの数を示すオプションの属性。
`MessageMetadata`	`getMessageMetadata(UUIDSE id)` 提供された `id` によって `Message` の `MessageMetadata` を返します。
`CollectionSE<Message<?>>`	`getMessagesForGroup(ObjectSE groupId)` 指定されたグループ ID のメッセージを取得します。
`Message<?>`	`getOneMessageFromGroup(ObjectSE groupId)` `MessageGroup` から 1 つの `Message` を返します。
`protected StringSE`	`getQuery(org.springframework.integration.jdbc.store.JdbcMessageStore.Query base)` 入力のパターンを置き換えて、有効な SQL クエリを生成します。
`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 のメッセージグループを削除します。
`void`	`removeMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)` グループからのメッセージの削除を永続化します。
`void`	`setDeserializer(Deserializer<? extends Message<?>> deserializer)` バイト配列をメッセージにデシリアライズするためのコンバーター。
`void`	`setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)` 最後にリリースされたメッセージのシーケンス番号を設定できます。
`void`	`setLobHandler(LobHandler lobHandler)` SQL クエリでラージオブジェクトを作成およびアンパックするために使用される `LobHandler` をオーバーライドします。
`void`	`setRegion(StringSE region)` このストアで保持されるすべてのメッセージの一意のグループ化識別子。
`void`	`setSerializer(Serializer<? super Message<?>> serializer)` メッセージをストレージ用のバイト配列に直列化するためのコンバーター。
`void`	`setTablePrefix(StringSE tablePrefix)` テーブルプレフィックスプロパティのパブリック setter。

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

- フィールドの詳細
  - DEFAULT_TABLE_PREFIX
```
public static final StringSE DEFAULT_TABLE_PREFIX
```
    テーブルプレフィックスプロパティのデフォルト値。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - JdbcMessageStore
```
public JdbcMessageStore(DataSourceSE dataSource)
```
    すべての必須プロパティで MessageStore を作成します。
    パラメーター:
    dataSource - DataSourceSE
  - JdbcMessageStore
```
public JdbcMessageStore(JdbcOperations jdbcOperations)
```
    すべての必須プロパティで MessageStore を作成します。
    パラメーター:
    jdbcOperations - JdbcOperations
    導入:
    4.3.9
- メソッドの詳細
  - setTablePrefix
```
public void setTablePrefix(StringSE tablePrefix)
```
    テーブルプレフィックスプロパティのパブリック setter。これは、クエリが実行される前にすべてのテーブル名の前に付けられます。デフォルトは DEFAULT_TABLE_PREFIX です。
    パラメーター:
    tablePrefix - 設定する tablePrefix
  - setRegion
```
public void setRegion(StringSE region)
```
    このストアで永続化されるすべてのメッセージの一意のグループ化識別子。複数のリージョンを使用すると、さまざまな目的でストアを（必要に応じて）パーティション化できます。デフォルトは DEFAULT です。
    パラメーター:
    region - 設定する領域名
  - setLobHandler
```
public void setLobHandler(LobHandler lobHandler)
```
    SQL クエリで大きなオブジェクトを作成および解凍するために使用される LobHandler をオーバーライドします。ほとんどすべてのプラットフォームでデフォルトで問題ありませんが、一部の Oracle ドライバーにはネイティブ実装が必要です。
    パラメーター:
    lobHandler - LobHandler
  - setSerializer
```
public void setSerializer(Serializer<? super Message<?>> serializer)
```
    メッセージをストレージ用のバイト配列に直列化するためのコンバーター。
    パラメーター:
    serializer - 設定するシリアライザー
  - setDeserializer
```
public void setDeserializer(Deserializer<? extends Message<?>> deserializer)
```
    バイト配列をメッセージにデシリアライズするためのコンバーター。
    パラメーター:
    deserializer - 設定するデシリアライザー
  - addAllowedPatterns
```
public void addAllowedPatterns(StringSE... patterns)
```
    逆直列化できるパッケージ / クラスのパターンを追加します。クラスは完全修飾することも、クラス名の最初または最後にワイルドカード "*" を使用することもできます。例: com.foo.*、*.MyClass。
    パラメーター:
    patterns - パターン。
    導入:
    5.4
  - removeMessage
```
public Message<?> removeMessage(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    指定された ID のメッセージを MessageStore から削除し（存在する場合）、それを返します。その ID のメッセージがストアに存在しない場合、これは null を返します。
    次で指定:
    インターフェース MessageStore の removeMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    メッセージ。
  - getMessageCount
```
@ManagedAttribute
public long getMessageCount()
```
    インターフェースからコピーされた説明: MessageStore
    ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。
    次で指定:
    インターフェース MessageStore の getMessageCount
    戻り値:
    メッセージの数。
  - getMessage
```
public Message<?> getMessage(UUIDSE id)
```
    次で指定:
    インターフェース MessageStore の getMessage
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    指定された ID のメッセージ。MessageStore にその ID のメッセージが存在しない場合は null。
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(UUIDSE id)
```
    インターフェースからコピーされた説明: MessageStore
    提供された id によって Message の MessageMetadata を返します。
    次で指定:
    インターフェース MessageStore の getMessageMetadata
    パラメーター:
    id - メッセージ識別子。
    戻り値:
    指定された 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 - メッセージ。
    戻り値:
    保存されたメッセージ。
  - addMessagesToGroup
```
public void addMessagesToGroup(ObjectSE groupId,
                               Message<?>... messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。
    次で指定:
    インターフェース MessageGroupStore の addMessagesToGroup
    パラメーター:
    groupId - メッセージを保存するグループ ID。
    messages - 追加するメッセージ。
  - getMessageGroupCount
```
@ManagedAttribute
public int getMessageGroupCount()
```
    インターフェースからコピーされた説明: MessageGroupStore
    メッセージグループの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageGroupCount
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageGroupCount
    戻り値:
    メッセージグループの数
  - getMessageCountForAllMessageGroups
```
@ManagedAttribute
public int getMessageCountForAllMessageGroups()
```
    インターフェースからコピーされた説明: MessageGroupStore
    すべてのグループにわたるストア内のメッセージの数を示すオプションの属性。実装は、例外をスローすることによって応答を拒否する場合があります。
    次で指定:
    インターフェース MessageGroupStore の getMessageCountForAllMessageGroups
    オーバーライド:
    クラス AbstractMessageGroupStore の getMessageCountForAllMessageGroups
    戻り値:
    メッセージの数
  - messageGroupSize
```
@ManagedAttribute
public int messageGroupSize(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この MessageGroup のサイズを返します。
    次で指定:
    インターフェース BasicMessageGroupStore の messageGroupSize
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    サイズ。
  - getMessageGroup
```
public MessageGroup getMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    このグループ ID で BasicMessageGroupStore.addMessageToGroup(Object, Message) を使用して保存された、現在 MessageStore にあるすべてのメッセージを返します。
    次で指定:
    インターフェース BasicMessageGroupStore の getMessageGroup
    パラメーター:
    groupId - グループ識別子。
    戻り値:
    メッセージのグループ。このキーにメッセージが存在しない場合は空です。
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(ObjectSE groupId,
                                    CollectionSE<Message<?>> messages)
```
    インターフェースからコピーされた説明: MessageGroupStore
    グループからのメッセージの削除を永続化します。
    次で指定:
    インターフェース MessageGroupStore の removeMessagesFromGroup
    パラメーター:
    groupId - メッセージを含むグループの groupId。
    messages - 削除するメッセージ。
  - removeMessageGroup
```
public void removeMessageGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: BasicMessageGroupStore
    この ID のメッセージグループを削除します。
    次で指定:
    インターフェース BasicMessageGroupStore の removeMessageGroup
    パラメーター:
    groupId - 削除するグループの ID。
  - completeGroup
```
public void completeGroup(ObjectSE groupId)
```
    インターフェースからコピーされた説明: MessageGroupStore
    この MessageGroup を完成させます。MessageGroup の補完は、一般に、このグループがこれ以上の変更操作を実行できないようにする必要があることを意味します。たとえば、グループから新しいメッセージを追加 / 削除しようとする試みは許可されるべきではありません。
    次で指定:
    インターフェース MessageGroupStore の completeGroup
    パラメーター:
    groupId - グループ識別子。
  - 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 の反復子。
  - getQuery
```
protected StringSE getQuery(org.springframework.integration.jdbc.store.JdbcMessageStore.Query base)
```
    入力のパターンを置き換えて、有効な SQL クエリを生成します。この実装は、単純なマップベースのキャッシュを遅延的に初期化し、名前付きクエリへの最初のアクセスでテーブルプレフィックスを置き換えるだけです。それ以降のアクセスはキャッシュから解決されます。
    パラメーター:
    base - 変換する SQL クエリ
    戻り値:
    置換を伴う変換されたクエリ
  - getJdbcOperations
```
protected JdbcOperations getJdbcOperations()
```
    このクラスがサブクラス化されている場合に JdbcOperations への参照を取得するために使用されます
    戻り値:
    JdbcOperations の実装
  - doPollForMessage
```
protected Message<?> doPollForMessage(StringSE groupIdKey)
```
    このメソッドは、DB への呼び出しを実行して、MessageGroup 内の最も古いメッセージを取得します。必要に応じて、このメソッドをオーバーライドします。たとえば、DB が FIRST などの高度な機能をサポートしている場合です。
    パラメーター:
    groupIdKey - メッセージグループ ID の文字列表現
    戻り値:
    メッセージ ; クエリがメッセージを生成しなかった場合は null になる可能性があります

クラス JdbcMessageStore

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

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

フィールドの詳細

DEFAULT_TABLE_PREFIX

コンストラクターの詳細

JdbcMessageStore

JdbcMessageStore

メソッドの詳細

setTablePrefix

setRegion

setLobHandler

setSerializer

setDeserializer

addAllowedPatterns

removeMessage

getMessageCount

getMessage

getMessageMetadata

addMessage

addMessagesToGroup

getMessageGroupCount

getMessageCountForAllMessageGroups

messageGroupSize

getMessageGroup

removeMessagesFromGroup

removeMessageGroup

completeGroup

setLastReleasedSequenceNumberForGroup

pollMessageFromGroup

getOneMessageFromGroup

getMessagesForGroup

iterator

getQuery

getJdbcOperations

doPollForMessage