第44章 Message インターフェイス
概要
この章では、Apache Camel コンポーネントの実装で任意のステップである Message インターフェイスを実装する方法を説明します。
44.1. Message インターフェイス リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
概要 リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
org.apache.camel.Message タイプのインスタンスは、あらゆる種類のメッセージ (In または Out) を表すことができます。メッセージタイプの継承階層を 図44.1「メッセージの継承階層」 に示します。コンポーネントにカスタムメッセージタイプを常に実装する必要はありません。多くの場合、デフォルトの実装 DefaultMessage で十分です。
図44.1 メッセージの継承階層
Message インターフェイス リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
例44.1「Message インターフェイス」は、org.apache.camel.Message インターフェイスの定義を示しています。
例44.1 Message インターフェイス
メッセージメソッド リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
Message インターフェイスは以下のメソッドを定義します。
-
setMessageId()、getMessageId(): メッセージ ID の getter メソッドおよび setter メソッド。カスタムコンポーネントでメッセージ ID を使用する必要があるかどうかが実装の詳細となります。 -
getExchange(): 親エクスチェンジオブジェクトへの参照を返します。 -
isFault()、setFault(): fault フラグの getter および setter メソッド。このメッセージが障害メッセージであるかどうかを示します。 -
getHeader()、getHeaders()、setHeader()、setHeaders()、removeHeader()、hasHeaders(): メッセージヘッダーのゲッターメソッドとセッターメソッド。通常、これらのメッセージヘッダーを使用して実際のヘッダーデータを保存するか、その他のメタデータを保存することもできます。 -
getBody()、getMandatoryBody()、setBody(): メッセージボディーのゲッターメソッドとセッターメソッド。getMandatoryBody() アクセッサーは返されるボディーが null 以外であることを保証します。それ以外の場合はInvalidPayloadException例外が発生します。 -
getAttachment()、getAttachments()、getAttachmentNames()、removeAttachment()、addAttachment()、setAttachments()、hasAttachments(): 添付ファイルを取得、設定、追加、および削除するメソッド。 -
copy(): 現在のカスタムメッセージオブジェクトと同一の (メッセージ ID を含む) 新しいコピーを作成します。 -
copyFrom(): 指定した汎用メッセージオブジェクトmessageの完全なコンテンツ (メッセージ ID を含む) を現在のメッセージインスタンスにコピーします。このメソッドは どのような メッセージタイプからでもコピーできる必要があるため、汎用メッセージプロパティーがコピーされますが、カスタムプロパティーはコピーされません。 -
createExchangeId(): メッセージ実装が ID を提供できる場合は、このエクスチェンジの一意の ID を返します。それ以外の場合は、nullの戻り値を返します。