インターフェース MessageContext

すべての既知の実装クラス:
AbstractMessageContextDefaultMessageContext

public interface MessageContext
メッセージリクエストのコンテキストホルダー。

メッセージリクエストとレスポンスの両方が含まれます。通常、レスポンスメッセージは遅延して作成されます(ただし、作成する必要はありません)。

interceptors がエンドポイントに情報を渡すために使用できるプロパティも含まれています。

導入:
1.0.0
作成者:
Arjen Poutsma
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    レスポンスメッセージがある場合は削除します。
    boolean
    このメッセージコンテキストに、指定された名前のプロパティが含まれているかどうかを確認します。
    MessageContext から特定のプロパティの値を取得します。
    この MessageContext のすべてのプロパティの名前を返します。
    リクエストメッセージを返します。
    レスポンスメッセージを返します。
    boolean
    このコンテキストにレスポンスがあるかどうかを示します。
    void
    指定された入力ストリームからレスポンスメッセージを読み取ります。
    void
    MessageContext からプロパティを削除します。
    void
    MessageContext に関連付けられているプロパティの名前と値を設定します。
    void
    レスポンスメッセージを設定します。
  • メソッドの詳細

    • getRequest

      WebServiceMessage getRequest()
      リクエストメッセージを返します。
      戻り値:
      リクエストメッセージ
    • hasResponse

      boolean hasResponse()
      このコンテキストにレスポンスがあるかどうかを示します。
      戻り値:
      このコンテキストにレスポンスがある場合は true。それ以外の場合は false 
    • getResponse

      WebServiceMessage getResponse()
      レスポンスメッセージを返します。レスポンスがない場合は、新しいレスポンスを作成します。
      戻り値:
      レスポンスメッセージ
      関連事項:
    • setResponse

      void setResponse(WebServiceMessage response)
      レスポンスメッセージを設定します。
      パラメーター:
      response - レスポンスメッセージ
      例外:
      IllegalStateExceptionSE - レスポンスがすでに作成されている場合
      導入:
      1.5.0
    • clearResponse

      void clearResponse()
      レスポンスメッセージがある場合は削除します。
      導入:
      1.5.0
    • readResponse

      void readResponse(InputStreamSE inputStream) throws IOExceptionSE
      指定された入力ストリームからレスポンスメッセージを読み取ります。
      パラメーター:
      inputStream - レスポンスを読み取るストリーム
      例外:
      IOExceptionSE - I/O エラーの場合
      IllegalStateExceptionSE - レスポンスがすでに作成されている場合
    • setProperty

      void setProperty(StringSE name, ObjectSE value)
      MessageContext に関連付けられているプロパティの名前と値を設定します。MessageContext に同じプロパティの値が含まれている場合、古い値が置き換えられます。
      パラメーター:
      name - 値に関連付けられているプロパティの名前
      value - プロパティの値
    • getProperty

      ObjectSE getProperty(StringSE name)
      MessageContext から特定のプロパティの値を取得します。
      パラメーター:
      name - 値を取得するプロパティの名前
      戻り値:
      プロパティの値
    • removeProperty

      void removeProperty(StringSE name)
      MessageContext からプロパティを削除します。
      パラメーター:
      name - 削除するプロパティの名前
    • containsProperty

      boolean containsProperty(StringSE name)
      このメッセージコンテキストに、指定された名前のプロパティが含まれているかどうかを確認します。
      パラメーター:
      name - 検索するプロパティの名前
      戻り値:
       MessageContext にプロパティが含まれている場合は true。それ以外の場合は false 
    • getPropertyNames

      StringSE[] getPropertyNames()
      この MessageContext のすべてのプロパティの名前を返します。
      戻り値:
      このコンテキスト内のすべてのプロパティの名前、または定義されていない場合は空の配列