EmbeddedJsonHeadersMessageMapper (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.support.json.EmbeddedJsonHeadersMessageMapper

実装されているすべてのインターフェース:
BytesMessageMapper, InboundMessageMapper<byte[]>, OutboundMessageMapper<byte[]>
```
public class EmbeddedJsonHeadersMessageMapper
extends ObjectSE
implements BytesMessageMapper
```
送信メッセージの場合、メッセージ対応の Jackson オブジェクトマッパーを使用して、メッセージを JSON としてレンダリングします。byte[] ペイロードを持つメッセージの場合、JSON としてレンダリングされると、Jackson はバイトに対して Base64 変換を実行します。rawBytes プロパティが true（デフォルト）の場合、結果は <headersLen> <headers> <payloadLen> <payload> の形式になります。ヘッダーは JSON でレンダリングされ、ペイロードは変更されません。
デフォルトでは、すべてのヘッダーが含まれています。ヘッダーのサブセットを指定する単純なパターンを提供できます。
予期される形式がどちらも検出されない場合、または変換中にエラーが発生した場合、メッセージのペイロードは元の byte[] です。
IMPORTANT
デフォルトのオブジェクトマッパーは、特定のパッケージのクラスのみをデシリアライズします。
```
        "java.util",
        "java.lang",
        "org.springframework.messaging.support",
        "org.springframework.integration.support",
        "org.springframework.integration.message",
        "org.springframework.integration.store"
 
```
さらにパッケージを追加するには、JacksonJsonUtils.messagingAwareMapper(String...) を使用してオブジェクトマッパーを作成します。
このような構成されたオブジェクトマッパーの提供を可能にするコンストラクターが提供されます。
導入:
5.0
作成者:
Gary Russell, Artem Bilan

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

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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`EmbeddedJsonHeadersMessageMapper()` デフォルトの JSON オブジェクトマッパーを使用して、すべてのヘッダーを埋め込むインスタンスを作成します。
`EmbeddedJsonHeadersMessageMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` 提供された JSON オブジェクトマッパーを使用して、すべてのヘッダーを埋め込むインスタンスを作成します。
`EmbeddedJsonHeadersMessageMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... headerPatterns)` 提供された JSON オブジェクトマッパーを使用して、提供されたパターンに一致するヘッダーを埋め込むインスタンスを作成します。
`EmbeddedJsonHeadersMessageMapper(StringSE... headerPatterns)` デフォルトの JSON オブジェクトマッパーを使用して、指定されたパターンに一致するヘッダーを埋め込むインスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`byte[]`	`fromMessage(Message<?> message)`
`CollectionSE<StringSE>`	`getHeaderPatterns()`
`void`	`setCaseSensitive(boolean caseSensitive)` ヘッダー名パターンの一致で大文字と小文字を区別するには、true に設定します。
`void`	`setRawBytes(boolean rawBytes)` `byte[]` ペイロードを持つメッセージの場合、JSON としてレンダリングされると、Jackson はバイトに対して Base64 変換を実行します。
`Message<?>`	`toMessage(byte[] bytes, MapSE<StringSE, ObjectSE> headers)` 提供されたオブジェクトを `Message` に変換し、必要に応じて提供されたヘッダーを提供します。

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

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - EmbeddedJsonHeadersMessageMapper
```
public EmbeddedJsonHeadersMessageMapper()
```
    デフォルトの JSON オブジェクトマッパーを使用して、すべてのヘッダーを埋め込むインスタンスを作成します。
  - EmbeddedJsonHeadersMessageMapper
```
public EmbeddedJsonHeadersMessageMapper(StringSE... headerPatterns)
```
    デフォルトの JSON オブジェクトマッパーを使用して、指定されたパターンに一致するヘッダーを埋め込むインスタンスを作成します。
    パラメーター:
    headerPatterns - パターン。
    関連事項:
    PatternMatchUtils.smartMatch(String, String...)
  - EmbeddedJsonHeadersMessageMapper
```
public EmbeddedJsonHeadersMessageMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    提供された JSON オブジェクトマッパーを使用して、すべてのヘッダーを埋め込むインスタンスを作成します。
    パラメーター:
    objectMapper - オブジェクトマッパー。
  - EmbeddedJsonHeadersMessageMapper
```
public EmbeddedJsonHeadersMessageMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                        StringSE... headerPatterns)
```
    提供された JSON オブジェクトマッパーを使用して、提供されたパターンに一致するヘッダーを埋め込むインスタンスを作成します。
    パラメーター:
    objectMapper - オブジェクトマッパー。
    headerPatterns - パターン。
- メソッドの詳細
  - setRawBytes
```
public void setRawBytes(boolean rawBytes)
```
    byte[] ペイロードを持つメッセージの場合、JSON としてレンダリングされると、Jackson はバイトに対して Base64 変換を実行します。このプロパティが true（デフォルト）の場合、結果は <headersLen> <headers> <payloadLen> <payload> の形式になります。ヘッダーは JSON でレンダリングされ、ペイロードは変更されません。バイトを base64 としてレンダリングするには、false に設定します。
    パラメーター:
    rawBytes - base64 としてエンコードする場合は false。
  - setCaseSensitive
```
public void setCaseSensitive(boolean caseSensitive)
```
    ヘッダー名パターンの一致で大文字と小文字を区別するには、true に設定します。デフォルトは false。
    パラメーター:
    caseSensitive - 大文字と小文字を区別する場合は true。
  - getHeaderPatterns
```
public CollectionSE<StringSE> getHeaderPatterns()
```
  - fromMessage
```
public byte[] fromMessage(Message<?> message)
```
    次で指定:
    インターフェース OutboundMessageMapper<byte[]> の fromMessage
  - toMessage
```
public Message<?> toMessage(byte[] bytes,
                            @Nullable
                            MapSE<StringSE,ObjectSE> headers)
```
    インターフェースからコピーされた説明: InboundMessageMapper
    提供されたオブジェクトを Message に変換し、必要に応じて提供されたヘッダーを提供します。
    次で指定:
    インターフェース BytesMessageMapper の toMessage
    次で指定:
    インターフェース InboundMessageMapper<byte[]> の toMessage
    パラメーター:
    bytes - メッセージペイロードまたはその他の変換ロジックのオブジェクト
    headers - メッセージを作成するための追加ヘッダー。null にすることができます
    戻り値:
    マッピングの結果としてのメッセージ

クラス EmbeddedJsonHeadersMessageMapper

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

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

フィールドの詳細

logger

コンストラクターの詳細

EmbeddedJsonHeadersMessageMapper

EmbeddedJsonHeadersMessageMapper

EmbeddedJsonHeadersMessageMapper

EmbeddedJsonHeadersMessageMapper

メソッドの詳細

setRawBytes

setCaseSensitive

getHeaderPatterns

fromMessage

toMessage