Package nablarch.fw.web

Class MockHttpRequest

java.lang.Object
nablarch.fw.web.HttpRequest
nablarch.fw.web.MockHttpRequest
All Implemented Interfaces:
nablarch.core.validation.Validatable<String[]>, nablarch.fw.Request<String[]>
public class MockHttpRequest extends nablarch.fw.web.HttpRequest
testing framework用のHttpRequest実装クラス。
Author:
Hisaaki Shioiri

  • Constructor Summary

    Constructors
    Constructor
    Description
    MockHttpRequest()
    デフォルトコンストラクタ。
    MockHttpRequest(String message)
    引数で渡されたHTTPリクエストメッセージと等価な内容のオブジェクトを生成する。

  • Method Summary

    Modifier and Type
    Method
    Description
    Reader
    getBodyReader()
    リクエストボディの読み出し用I/Oを返す。
    nablarch.fw.web.HttpCookie
    getCookie()
    このリクエストで送信されるクッキー情報を取得する。
    String
    getHeader(String headerName)
    HTTPリクエストヘッダの値を返す。
    Map<String,String>
    getHeaderMap()
    HTTPリクエストヘッダを格納したMapを取得する。
    String
    getHost()
    HTTPリクエストのホストヘッダを取得する。
    String
    getHttpVersion()
    HTTPバージョン名を返す。
    String
    getMethod()
    HTTPリクエストメソッド名を返す。
    String[]
    getParam(String name)
    リクエストパラメータを取得する。
    Map<String,String[]>
    getParamMap()
    リクエストパラメータのMapを返す。
    nablarch.fw.web.HttpRequest
    setBodyReader(Reader reader)
    リクエストボディの読み出し用I/Oを設定する。
    nablarch.fw.web.HttpRequest
    setCookie(nablarch.fw.web.HttpCookie cookie)
    このリクエストで送信されるクッキー情報を設定する。
    nablarch.fw.web.HttpRequest
    setHeaderMap(Map<String,String> headers)
    HTTPリクエストヘッダを格納したMapを設定する。
    nablarch.fw.web.HttpRequest
    setHost(String host)
    ホストヘッダの値を設定する。
    nablarch.fw.web.HttpRequest
    setHttpVersion(String httpVersion)
    HTTPバージョン名を指定する。
    nablarch.fw.web.HttpRequest
    setMethod(String method)
    HTTPリクエストメソッド名を設定する。
    nablarch.fw.web.HttpRequest
    setParam(String name, String... params)
    リクエストパラメータを設定する。
    nablarch.fw.web.HttpRequest
    setParamMap(Map<String,String[]> params)
    リクエストパラメータを設定する。
    String
    toString()
    このクラスの実装では、オブジェクトの内容と等価なHTTPリクエストメッセージを返す。

    Methods inherited from class nablarch.fw.web.HttpRequest

    getMultipart, getPart, getRequestPath, getRequestUri, getUserAgent, setMultipart, setRequestPath, setRequestUri

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MockHttpRequest

      @Published(tag="architect") public MockHttpRequest()
      デフォルトコンストラクタ。 
       下記のHTTPリクエストメッセージと等価な内容のオブジェクトを生成する。:
     GET / HTTP/1.1/
 基本的に業務アプリケーションがHttpRequestインスタンスを直接生成することはない。
 このメソッドはFWの内部やテストケースで使用することを想定したものである。

    • MockHttpRequest

      @Published(tag="architect") public MockHttpRequest(String message)
      引数で渡されたHTTPリクエストメッセージと等価な内容のオブジェクトを生成する。 
         このメソッドはテストケース内で使用することを想定したものである。
      Parameters:
      message - HTTPリクエストメッセージ

  • Method Details

    • getMethod

      @Published public String getMethod()
      HTTPリクエストメソッド名を返す。
      Specified by:
      getMethod in class nablarch.fw.web.HttpRequest
      Returns:
      リクエストメソッド名

    • setMethod

      public nablarch.fw.web.HttpRequest setMethod(String method)
      HTTPリクエストメソッド名を設定する。 
       明示的に設定しない場合のデフォルト値は"GET"である。
      Parameters:
      method - HTTPメソッド名
      Returns:
      このオブジェクト自体

    • getHttpVersion

      @Published public String getHttpVersion()
      HTTPバージョン名を返す。
      Specified by:
      getHttpVersion in class nablarch.fw.web.HttpRequest
      Returns:
      HTTPバージョン名

    • setHttpVersion

      public nablarch.fw.web.HttpRequest setHttpVersion(String httpVersion)
      HTTPバージョン名を指定する。 
       明示的に指定しない場合のデフォルト値は"HTTP/1.1"である。
      Parameters:
      httpVersion - HTTPバージョン名
      Returns:
      このオブジェクト自体

    • getBodyReader

      public Reader getBodyReader()
      リクエストボディの読み出し用I/Oを返す。
      Returns:
      読み出し用I/O

    • setBodyReader

      public nablarch.fw.web.HttpRequest setBodyReader(Reader reader)
      リクエストボディの読み出し用I/Oを設定する。
      Parameters:
      reader - 読み出し用I/O
      Returns:
      このオブジェクト自体

    • getParamMap

      public Map<String,String[]> getParamMap()
      リクエストパラメータのMapを返す。 
       HTTPリクエストメッセージ中の以下のパラメータを格納したMapを返す。
   1. リクエストURI中のクエリパラメータ
   2. メッセージボディ内のPOSTパラメータ
 パラメータ名は重複する可能性があるので、値の型はString[]で定義されている。
 このMapに対する変更は直接反映される。
      Specified by:
      getParamMap in interface nablarch.fw.Request<String[]>
      Specified by:
      getParamMap in interface nablarch.core.validation.Validatable<String[]>
      Specified by:
      getParamMap in class nablarch.fw.web.HttpRequest
      Returns:
      リクエストパラメータのMap

    • getParam

      public String[] getParam(String name)
      リクエストパラメータを取得する。 
       このメソッドの処理は、以下のソースコードと等価である。
     this.params().get(name);
      Specified by:
      getParam in interface nablarch.fw.Request<String[]>
      Specified by:
      getParam in class nablarch.fw.web.HttpRequest
      Parameters:
      name - パラメータ名
      Returns:
      パラメータの値
      See Also:

    • setParam

      @Published public nablarch.fw.web.HttpRequest setParam(String name, String... params)
      リクエストパラメータを設定する。 
       このメソッドの処理は、以下のソースコードと等価である。
     this.params().put(name, params);
      Specified by:
      setParam in class nablarch.fw.web.HttpRequest
      Parameters:
      name - パラメータ名
      params - パラメータの値
      Returns:
      このオブジェクト自体

    • setParamMap

      @Published(tag="architect") public nablarch.fw.web.HttpRequest setParamMap(Map<String,String[]> params)
      リクエストパラメータを設定する。 
       このメソッドは自動テストからの使用を想定している。
      Specified by:
      setParamMap in class nablarch.fw.web.HttpRequest
      Parameters:
      params - リクエストパラメータのMap
      Returns:
      このオブジェクト自体

    • getHeaderMap

      @Published public Map<String,String> getHeaderMap()
      HTTPリクエストヘッダを格納したMapを取得する。 
       このMapに対する変更は直接反映される。
      Specified by:
      getHeaderMap in class nablarch.fw.web.HttpRequest
      Returns:
      HTTPリクエストヘッダのMap

    • setHeaderMap

      public nablarch.fw.web.HttpRequest setHeaderMap(Map<String,String> headers)
      HTTPリクエストヘッダを格納したMapを設定する。
      Parameters:
      headers - HTTPリクエストヘッダを格納したMap
      Returns:
      このオブジェクト自体

    • getHeader

      @Published public String getHeader(String headerName)
      HTTPリクエストヘッダの値を返す。
      Specified by:
      getHeader in class nablarch.fw.web.HttpRequest
      Parameters:
      headerName - リクエストヘッダ名
      Returns:
      HTTPリクエストヘッダの値

    • getHost

      @Published public String getHost()
      HTTPリクエストのホストヘッダを取得する。 
       このメソッドの処理は以下のソースコードと等価である。
     getHeaderMap().get("HOST")
      Overrides:
      getHost in class nablarch.fw.web.HttpRequest
      Returns:
      ホストヘッダ

    • setHost

      public nablarch.fw.web.HttpRequest setHost(String host)
      ホストヘッダの値を設定する。
      Parameters:
      host - ホストヘッダの値
      Returns:
      このオブジェクト自体

    • getCookie

      @Published(tag="architect") public nablarch.fw.web.HttpCookie getCookie()
      このリクエストで送信されるクッキー情報を取得する。
      Specified by:
      getCookie in class nablarch.fw.web.HttpRequest
      Returns:
      クッキー情報オブジェクト

    • setCookie

      @Published(tag="architect") public nablarch.fw.web.HttpRequest setCookie(nablarch.fw.web.HttpCookie cookie)
      このリクエストで送信されるクッキー情報を設定する。
      Parameters:
      cookie - クッキー情報オブジェクト
      Returns:
      このオブジェクト自体

    • toString

      public String toString()
      このクラスの実装では、オブジェクトの内容と等価なHTTPリクエストメッセージを返す。
      Overrides:
      toString in class Object