クラス MutableMessageBuilder<T>
java.lang.ObjectSE
org.springframework.integration.support.AbstractIntegrationMessageBuilder<T>
org.springframework.integration.support.MutableMessageBuilder<T>
- 型パラメーター:
T
- ペイロード型。
コンポーネント内で使用できる特殊なメッセージビルダーで、そのコンポーネント内の変更に対して複数のメッセージを作成する必要があるというオーバーヘッドを回避します。
IMPORTANT: 可変メッセージは状態(メッセージヘッダーなど)を共有する場合があります。このようなメッセージを他のコンポーネントに公開しないでください。公開すると、望ましくない副作用が発生する可能性があります。
コンポーネント間で転送されるメッセージは、使用に細心の注意を払わない限り、常に不変であることが一般的に推奨されます。
- 導入:
- 4.0
- 作成者:
- Gary Russell, Artem Bilan
メソッドのサマリー
修飾子と型メソッド説明build()
copyHeaders
(MapSE<StringSE, ?> headersToCopy) 提供されたマップから名前と値のペアをコピーします。copyHeadersIfAbsent
(MapSE<StringSE, ?> headersToCopy) 提供されたマップから名前と値のペアをコピーします。static <T> MutableMessageBuilder<T>
fromMessage
(Message<T> message) 提供されたメッセージからコピーされたすべてのヘッダーが事前入力された新しいMessage
インスタンス用のビルダーを作成します。protected ObjectSE
<V> V
protected ObjectSE
protected ObjectSE
removeHeader
(StringSE headerName) 指定されたヘッダー名の値を削除します。removeHeaders
(StringSE... headerPatterns) 'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。指定されたヘッダー名の値を設定します。setHeaderIfAbsent
(StringSE headerName, ObjectSE headerValue) ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。static <T> MutableMessageBuilder<T>
withPayload
(T payload) 提供されたペイロードを使用して、新しいMessage
インスタンスのビルダーを作成します。static <T> MutableMessageBuilder<T>
withPayload
(T payload, boolean generateHeaders) 提供されたペイロードを使用して、新しいMessage
インスタンスのビルダーを作成します。クラス org.springframework.integration.support.AbstractIntegrationMessageBuilder から継承されたメソッド
cloneMessageHistoryIfAny, filterAndCopyHeadersIfAbsent, popSequenceDetails, pushSequenceDetails, setCorrelationId, setErrorChannel, setErrorChannelName, setExpirationDate, setExpirationDate, setPriority, setReplyChannel, setReplyChannelName, setSequenceNumber, setSequenceSize
メソッドの詳細
getPayload
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetPayload
getHeaders
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetHeaders
getHeader
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetHeader
withPayload
提供されたペイロードを使用して、新しいMessage
インスタンスのビルダーを作成します。- 型パラメーター:
T
- ペイロードの型。- パラメーター:
payload
- 新しいメッセージのペイロード- 戻り値:
- MutableMessageBuilder。
withPayload
提供されたペイロードを使用して、新しいMessage
インスタンスのビルダーを作成します。generateHeaders
フラグを使用すると、MessageHeaders.ID
およびMessageHeaders.TIMESTAMP
ヘッダーの生成を無効にできます。- 型パラメーター:
T
- ペイロードの型。- パラメーター:
payload
- 新しいメッセージのペイロードgenerateHeaders
-MessageHeaders.ID
およびMessageHeaders.TIMESTAMP
ヘッダーを生成するかどうか- 戻り値:
- MutableMessageBuilder。
- 導入:
- 5.0
fromMessage
指定されたメッセージからコピーされたすべてのヘッダーが事前に入力された新しいMessage
インスタンスのビルダーを作成します。提供されたメッセージのペイロードは、新しいメッセージのペイロードとしても使用されます。- 型パラメーター:
T
- ペイロードの型。- パラメーター:
message
- ペイロードとすべてのヘッダーのコピー元のメッセージ- 戻り値:
- MutableMessageBuilder。
setHeader
public AbstractIntegrationMessageBuilder<T> setHeader(StringSE headerName, @Nullable ObjectSE headerValue) クラスからコピーされた説明:AbstractIntegrationMessageBuilder
指定されたヘッダー名の値を設定します。指定された値がnull
の場合、ヘッダーは削除されます。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のsetHeader
- パラメーター:
headerName
- ヘッダー名。headerValue
- ヘッダー値。- 戻り値:
- this。
setHeaderIfAbsent
public AbstractIntegrationMessageBuilder<T> setHeaderIfAbsent(StringSE headerName, ObjectSE headerValue) クラスからコピーされた説明:AbstractIntegrationMessageBuilder
ヘッダー名がまだ値に関連付けられていない場合にのみ、指定されたヘッダー名の値を設定します。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のsetHeaderIfAbsent
- パラメーター:
headerName
- ヘッダー名。headerValue
- ヘッダー値。- 戻り値:
- this。
removeHeaders
クラスからコピーされた説明:AbstractIntegrationMessageBuilder
'headerPatterns' の配列を介して提供されるすべてのヘッダーを削除します。名前が示すように、配列にはヘッダー名の単純な一致パターンが含まれる場合があります。サポートされているパターンスタイルは、"xxx*"、"*xxx"、"*xxx*"、"xxx* yyy" です。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のremoveHeaders
- パラメーター:
headerPatterns
- ヘッダーパターン。- 戻り値:
- this。
removeHeader
クラスからコピーされた説明:AbstractIntegrationMessageBuilder
指定されたヘッダー名の値を削除します。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のremoveHeader
- パラメーター:
headerName
- ヘッダー名。- 戻り値:
- this。
copyHeaders
クラスからコピーされた説明:AbstractIntegrationMessageBuilder
提供されたマップから名前と値のペアをコピーします。この操作は既存の値を上書きします。値の上書きを回避するには、{AbstractIntegrationMessageBuilder.copyHeadersIfAbsent(Map)
を使用します。"id" および "timestamp" ヘッダー値は決して上書きされないことに注意してください。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のcopyHeaders
- パラメーター:
headersToCopy
- コピーするヘッダー。- 戻り値:
- this。
- 関連事項:
copyHeadersIfAbsent
public AbstractIntegrationMessageBuilder<T> copyHeadersIfAbsent(@Nullable MapSE<StringSE, ?> headersToCopy) クラスからコピーされた説明:AbstractIntegrationMessageBuilder
提供されたマップから名前と値のペアをコピーします。この操作では、既存の値は上書きされません。- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のcopyHeadersIfAbsent
- パラメーター:
headersToCopy
- コピーするヘッダー。- 戻り値:
- this。
getSequenceDetails
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetSequenceDetails
getCorrelationId
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetCorrelationId
getSequenceNumber
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetSequenceNumber
getSequenceSize
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のgetSequenceSize
build
- 次で指定:
- クラス
AbstractIntegrationMessageBuilder<T>
のbuild