IntegrationMessageHeaderAccessor (Spring Integration API)

java.lang.ObjectSE
- org.springframework.messaging.support.MessageHeaderAccessor
- - org.springframework.integration.IntegrationMessageHeaderAccessor

```
public class IntegrationMessageHeaderAccessor
extends MessageHeaderAccessor
```
標準の SI ヘッダーを追加します。
導入:
4.0
作成者:
Andy Wilkinson, Artem Bilan, Gary Russell

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`ACKNOWLEDGMENT_CALLBACK` メッセージ配信を確認するためのコールバック。
`static StringSE`	`CLOSEABLE_RESOURCE`
`static StringSE`	`CORRELATION_ID`
`static StringSE`	`DELIVERY_ATTEMPT`
`static StringSE`	`DUPLICATE_MESSAGE`
`static StringSE`	`EXPIRATION_DATE`
`static StringSE`	`PRIORITY`
`static StringSE`	`ROUTING_SLIP`
`static StringSE`	`SEQUENCE_DETAILS`
`static StringSE`	`SEQUENCE_NUMBER`
`static StringSE`	`SEQUENCE_SIZE`
`static StringSE`	`SOURCE_DATA` 生のソースメッセージ。

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド
DEFAULT_CHARSET

コンストラクターの概要
コンストラクター
コンストラクターと説明
IntegrationMessageHeaderAccessor(Message<?> message)

コンストラクター
コンストラクターと説明
`IntegrationMessageHeaderAccessor(Message<?> message)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`AcknowledgmentCallback`	`getAcknowledgmentCallback()` 存在する場合は、確認応答コールバックを返します。
`CloseableSE`	`getCloseableResource()` ペイロードが消費されるまで開いたままにする必要がある `Closeable`SE によってペイロードが作成された場合、リソースはこのヘッダーに追加されます。
`ObjectSE`	`getCorrelationId()`
`AtomicIntegerSE`	`getDeliveryAttempt()` メッセージ駆動型エンドポイントが暗黙的に再試行をサポートしている場合、このヘッダーは配信が試行されるたびにインクリメントされます。
`LongSE`	`getExpirationDate()`
`<T> T`	`getHeader(StringSE key, ClassSE<T> type)`
`IntegerSE`	`getPriority()`
`int`	`getSequenceNumber()`
`int`	`getSequenceSize()`
`<T> T`	`getSourceData()` 存在する場合は、ソースデータヘッダーを取得します。
`boolean`	`isReadOnly(StringSE headerName)`
`void`	`setReadOnlyHeaders(StringSE... readOnlyHeaders)` 読み取り専用と見なし、メッセージへの入力を禁止するヘッダーのリストを指定します。
`MapSE<StringSE, ObjectSE>`	`toMap()`
`protected void`	`verifyType(StringSE headerName, ObjectSE headerValue)`

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド
copyHeaders, copyHeadersIfAbsent, createAccessor, getAccessor, getAccessor, getAccessor, getContentType, getDetailedLogMessage, getDetailedPayloadLogMessage, getErrorChannel, getHeader, getId, getMessageHeaders, getMutableAccessor, getReplyChannel, getShortLogMessage, getShortPayloadLogMessage, getTimestamp, isModified, isMutable, isReadableContentType, removeHeader, removeHeaders, setContentType, setErrorChannel, setErrorChannelName, setHeader, setHeaderIfAbsent, setImmutable, setLeaveMutable, setModified, setReplyChannel, setReplyChannelName, toMessageHeaders, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - CORRELATION_ID
```
public static final StringSE CORRELATION_ID
```
    関連事項:
    定数フィールド値
  - EXPIRATION_DATE
```
public static final StringSE EXPIRATION_DATE
```
    関連事項:
    定数フィールド値
  - PRIORITY
```
public static final StringSE PRIORITY
```
    関連事項:
    定数フィールド値
  - SEQUENCE_NUMBER
```
public static final StringSE SEQUENCE_NUMBER
```
    関連事項:
    定数フィールド値
  - SEQUENCE_SIZE
```
public static final StringSE SEQUENCE_SIZE
```
    関連事項:
    定数フィールド値
  - SEQUENCE_DETAILS
```
public static final StringSE SEQUENCE_DETAILS
```
    関連事項:
    定数フィールド値
  - ROUTING_SLIP
```
public static final StringSE ROUTING_SLIP
```
    関連事項:
    定数フィールド値
  - DUPLICATE_MESSAGE
```
public static final StringSE DUPLICATE_MESSAGE
```
    関連事項:
    定数フィールド値
  - CLOSEABLE_RESOURCE
```
public static final StringSE CLOSEABLE_RESOURCE
```
    関連事項:
    定数フィールド値
  - DELIVERY_ATTEMPT
```
public static final StringSE DELIVERY_ATTEMPT
```
    関連事項:
    定数フィールド値
  - ACKNOWLEDGMENT_CALLBACK
```
public static final StringSE ACKNOWLEDGMENT_CALLBACK
```
    メッセージ配信を確認するためのコールバック。ヘッダー値の型は、ヘッダーが使用されるコンテキストによって異なります。詳細については、リファレンスマニュアルを参照してください。
    関連事項:
    定数フィールド値
  - SOURCE_DATA
```
public static final StringSE SOURCE_DATA
```
    生のソースメッセージ。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - IntegrationMessageHeaderAccessor
```
public IntegrationMessageHeaderAccessor(@Nullable
                                        Message<?> message)
```
- メソッドの詳細
  - setReadOnlyHeaders
```
public void setReadOnlyHeaders(StringSE... readOnlyHeaders)
```
    読み取り専用と見なし、メッセージへの入力を禁止するヘッダーのリストを指定します。
    パラメーター:
    readOnlyHeaders - readOnly モードのヘッダーのリスト。デフォルトは MessageHeaders.ID および MessageHeaders.TIMESTAMP です。
    導入:
    4.3.2
    関連事項:
    isReadOnly(String)
  - getExpirationDate
```
@Nullable
public LongSE getExpirationDate()
```
  - getCorrelationId
```
@Nullable
public ObjectSE getCorrelationId()
```
  - getSequenceNumber
```
public int getSequenceNumber()
```
  - getSequenceSize
```
public int getSequenceSize()
```
  - getPriority
```
@Nullable
public IntegerSE getPriority()
```
  - getCloseableResource
```
@Nullable
public CloseableSE getCloseableResource()
```
    ペイロードが消費されるまで開いたままにする必要がある CloseableSE によってペイロードが作成された場合、リソースはこのヘッダーに追加されます。ペイロードが消費された後、CloseableSE を閉じる必要があります。通常、これはフロー内のメッセージ発信元に近いエンドポイントで、同じ JVM で発生する必要があります。
    戻り値:
    CloseableSE
    導入:
    4.3
  - getAcknowledgmentCallback
```
@Nullable
public AcknowledgmentCallback getAcknowledgmentCallback()
```
    存在する場合は、確認応答コールバックを返します。
    戻り値:
    コールバック。
    導入:
    5.0.1
  - getDeliveryAttempt
```
@Nullable
public AtomicIntegerSE getDeliveryAttempt()
```
    メッセージ駆動型エンドポイントが暗黙的に再試行をサポートしている場合、このヘッダーは配信が試行されるたびにインクリメントされます。
    戻り値:
    配信の試み。
    導入:
    5.0.1
  - getSourceData
```
@Nullable
public <T> T getSourceData()
```
    存在する場合は、ソースデータヘッダーを取得します。
    型パラメーター:
    T - データ型。
    戻り値:
    ソースヘッダー。
    導入:
    5.1.6
  - getHeader
```
@Nullable
public <T> T getHeader(StringSE key,
                                 ClassSE<T> type)
```
  - verifyType
```
protected void verifyType(StringSE headerName,
                          ObjectSE headerValue)
```
    オーバーライド:
    クラス MessageHeaderAccessor の verifyType
  - isReadOnly
```
public boolean isReadOnly(StringSE headerName)
```
    オーバーライド:
    クラス MessageHeaderAccessor の isReadOnly
  - toMap
```
public MapSE<StringSE,ObjectSE> toMap()
```
    オーバーライド:
    クラス MessageHeaderAccessor の toMap

クラス IntegrationMessageHeaderAccessor

フィールドのサマリー

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.messaging.support.MessageHeaderAccessor から継承されたメソッド

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

フィールドの詳細

CORRELATION_ID

EXPIRATION_DATE

PRIORITY

SEQUENCE_NUMBER

SEQUENCE_SIZE

SEQUENCE_DETAILS

ROUTING_SLIP

DUPLICATE_MESSAGE

CLOSEABLE_RESOURCE

DELIVERY_ATTEMPT

ACKNOWLEDGMENT_CALLBACK

SOURCE_DATA

コンストラクターの詳細

IntegrationMessageHeaderAccessor

メソッドの詳細

setReadOnlyHeaders

getExpirationDate

getCorrelationId

getSequenceNumber

getSequenceSize

getPriority

getCloseableResource

getAcknowledgmentCallback

getDeliveryAttempt

getSourceData

getHeader

verifyType

isReadOnly

toMap