TcpMessageMapper (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.ip.tcp.connection.TcpMessageMapper

実装されたすべてのインターフェース:
Aware, BeanFactoryAware, InboundMessageMapper<TcpConnection>, OutboundMessageMapper<ObjectSE>
既知の直属サブクラス
MessageConvertingTcpMessageMapper
```
public class TcpMessageMapper
extends ObjectSE
implements InboundMessageMapper<TcpConnection>, OutboundMessageMapper<ObjectSE>, BeanFactoryAware
```
受信データを TcpConnection から Message にマップします。StringToBytes が true (デフォルト) の場合、String 型のペイロードは、指定された文字セット (デフォルトでは UTF-8) を使用して byte[] に変換されます。受信メッセージには、接続のリモート側を表すヘッダーと、応答を送信する接続を関連付けるために TcpSender が使用できる接続 ID が含まれます。applySequence が設定されている場合は、標準の correlationId/sequenceNumber ヘッダーが追加され、下流 (無制限) の再シーケンスが可能になります。*
導入:
2.0
作成者:
Gary Russell, Artem Bilan

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

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

コンストラクターの概要
コンストラクター
コンストラクターと説明
TcpMessageMapper()

コンストラクター
コンストラクターと説明
`TcpMessageMapper()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`addCustomHeaders(TcpConnection connection, MessageHeaders messageHeaders)`
`protected void`	`addStandardHeaders(TcpConnection connection, MessageHeaders messageHeaders)`
`ObjectSE`	`fromMessage(Message<?> message)`
`protected MessageBuilderFactory`	`getMessageBuilderFactory()`
`void`	`setAddContentTypeHeader(boolean addContentTypeHeader)` コンテンツ型ヘッダーを追加するには、true に設定します。デフォルトは false です。
`void`	`setApplySequence(boolean applySequence)`
`void`	`setBeanFactory(BeanFactory beanFactory)`
`void`	`setBytesMessageMapper(BytesMessageMapper bytesMessageMapper)` byte[] をマッピングするときに使用する `BytesMessageMapper` を設定します。
`void`	`setCharset(StringSE charset)` 送信文字列メッセージを `byte[]` に変換するときに使用する文字セットを設定します。
`void`	`setContentType(StringSE contentType)` `addContentTypeHeader` が true の場合に受信メッセージに追加するコンテンツ型ヘッダー値を設定します。
`void`	`setStringToBytes(boolean stringToBytes)` 送信文字列ペイロードを byte[] に変換するかどうかを設定します。
`protected MapSE<StringSE,?>`	`supplyCustomHeaders(TcpConnection connection)` 追加のヘッダーを提供するためにオーバーライドします。
`Message<?>`	`toMessage(TcpConnection connection, MapSE<StringSE, ObjectSE> headers)` 提供されたオブジェクトを `Message` に変換し、必要に応じて提供されたヘッダーを提供します。

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

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - TcpMessageMapper
```
public TcpMessageMapper()
```
- メソッドの詳細
  - setCharset
```
public void setCharset(StringSE charset)
```
    送信文字列メッセージを byte[] に変換するときに使用する文字セットを設定します。
    パラメーター:
    charset - 設定する文字セット
  - setStringToBytes
```
public void setStringToBytes(boolean stringToBytes)
```
    送信文字列ペイロードを byte[] に変換するかどうかを設定します。デフォルトは true です。BytesMessageMapper が提供されている場合は無視されます。
    パラメーター:
    stringToBytes - 設定する stringToBytes。
    関連事項:
    setBytesMessageMapper(BytesMessageMapper)
  - setApplySequence
```
public void setApplySequence(boolean applySequence)
```
    パラメーター:
    applySequence - 設定する applySequence。
  - setContentType
```
public void setContentType(StringSE contentType)
```
    addContentTypeHeader が true の場合に受信メッセージに追加するコンテンツ型ヘッダー値を設定します。デフォルトの application/octet-stream;charset=UTF-8. このデフォルトは setCharset(String) によって変更されません。
    パラメーター:
    contentType - 設定するコンテンツ型ヘッダー値。
    導入:
    4.3
    関連事項:
    setAddContentTypeHeader(boolean), setCharset(String)
  - setAddContentTypeHeader
```
public void setAddContentTypeHeader(boolean addContentTypeHeader)
```
    コンテンツ型ヘッダーを追加するには、true に設定します。デフォルトは false です。
    パラメーター:
    addContentTypeHeader - true を指定すると、コンテンツ型ヘッダーが追加されます。
    導入:
    4.3
    関連事項:
    setContentType(String)
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException
```
    次で指定:
    インターフェース BeanFactoryAware の setBeanFactory
    例外:
    BeansException
  - setBytesMessageMapper
```
public void setBytesMessageMapper(BytesMessageMapper bytesMessageMapper)
```
    byte[] をマッピングするときに使用する BytesMessageMapper を設定します。BytesMessageMapper が提供されている場合、setStringToBytes(boolean) は無視されます。
    パラメーター:
    bytesMessageMapper - マッパー。
    導入:
    5.0
    関連事項:
    setStringToBytes(boolean)
  - getMessageBuilderFactory
```
protected MessageBuilderFactory getMessageBuilderFactory()
```
  - toMessage
```
public Message<?> toMessage(TcpConnection connection,
                            @Nullable
                            MapSE<StringSE,ObjectSE> headers)
```
    インターフェースからコピーされた説明: InboundMessageMapper
    提供されたオブジェクトを Message に変換し、必要に応じて提供されたヘッダーを提供します。
    次で指定:
    インターフェース InboundMessageMapper<TcpConnection> の toMessage
    パラメーター:
    connection - メッセージペイロードまたはその他の変換ロジックのオブジェクト
    headers - メッセージを作成するための追加ヘッダー。null にすることができます
    戻り値:
    マッピングの結果としてのメッセージ
  - addStandardHeaders
```
protected final void addStandardHeaders(TcpConnection connection,
                                        MessageHeaders messageHeaders)
```
  - addCustomHeaders
```
protected final void addCustomHeaders(TcpConnection connection,
                                      MessageHeaders messageHeaders)
```
  - supplyCustomHeaders
```
@Nullable
protected MapSE<StringSE,?> supplyCustomHeaders(TcpConnection connection)
```
    追加のヘッダーを提供するためにオーバーライドします。標準ヘッダーはオーバーライドできず、結果に指定されている場合、そのようなヘッダーは無視されます。
    パラメーター:
    connection - 接続。
    戻り値:
    メッセージに追加される <String, ?> ヘッダーのマップ。
  - fromMessage
```
public ObjectSE fromMessage(Message<?> message)
```
    次で指定:
    インターフェース OutboundMessageMapper<ObjectSE> の fromMessage

クラス TcpMessageMapper

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

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

フィールドの詳細

logger

コンストラクターの詳細

TcpMessageMapper

メソッドの詳細

setCharset

setStringToBytes

setApplySequence

setContentType

setAddContentTypeHeader

setBeanFactory

setBytesMessageMapper

getMessageBuilderFactory

toMessage

addStandardHeaders

addCustomHeaders

supplyCustomHeaders

fromMessage