MockHttpRequest (Nablarch-API)

java.lang.Object
- nablarch.fw.web.HttpRequest
- - nablarch.fw.web.MockHttpRequest

すべての実装されたインタフェース:

Validatable<java.lang.String[]>, Request<java.lang.String[]>
```
public class MockHttpRequest
extends HttpRequest
```
testing framework用のHttpRequest実装クラス。

コンストラクタのサマリー

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

メソッドのサマリー

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

クラスから継承されたメソッド nablarch.fw.web.HttpRequest
getMultipart, getPart, getRequestPath, getRequestUri, getUserAgent, setMultipart, setRequestPath, setRequestUri

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - MockHttpRequest
```
@Published(tag="architect")
public MockHttpRequest()
```
    デフォルトコンストラクタ。
```
 下記のHTTPリクエストメッセージと等価な内容のオブジェクトを生成する。:
     GET / HTTP/1.1/
 基本的に業務アプリケーションがHttpRequestインスタンスを直接生成することはない。
 このメソッドはFWの内部やテストケースで使用することを想定したものである。
 
```
  - MockHttpRequest
```
@Published(tag="architect")
public MockHttpRequest(java.lang.String message)
```
    引数で渡されたHTTPリクエストメッセージと等価な内容のオブジェクトを生成する。
```
   このメソッドはテストケース内で使用することを想定したものである。
 
```
    パラメータ:
    
    message - HTTPリクエストメッセージ
- メソッドの詳細
  - getMethod
```
@Published
public java.lang.String getMethod()
```
    HTTPリクエストメソッド名を返す。
    
    定義:
    
    getMethod クラス内 HttpRequest
    
    戻り値:
    
    リクエストメソッド名
  - setMethod
```
public HttpRequest setMethod(java.lang.String method)
```
    HTTPリクエストメソッド名を設定する。
```
 明示的に設定しない場合のデフォルト値は"GET"である。
 
```
    パラメータ:
    
    method - HTTPメソッド名
    
    戻り値:
    
    このオブジェクト自体
  - getHttpVersion
```
@Published
public java.lang.String getHttpVersion()
```
    HTTPバージョン名を返す。
    
    定義:
    
    getHttpVersion クラス内 HttpRequest
    
    戻り値:
    
    HTTPバージョン名
  - setHttpVersion
```
public HttpRequest setHttpVersion(java.lang.String httpVersion)
```
    HTTPバージョン名を指定する。
```
 明示的に指定しない場合のデフォルト値は"HTTP/1.1"である。
 
```
    パラメータ:
    
    httpVersion - HTTPバージョン名
    
    戻り値:
    
    このオブジェクト自体
  - getBodyReader
```
public java.io.Reader getBodyReader()
```
    リクエストボディの読み出し用I/Oを返す。
    
    戻り値:
    
    読み出し用I/O
  - setBodyReader
```
public HttpRequest setBodyReader(java.io.Reader reader)
```
    リクエストボディの読み出し用I/Oを設定する。
    
    パラメータ:
    
    reader - 読み出し用I/O
    
    戻り値:
    
    このオブジェクト自体
  - getParamMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParamMap()
```
    リクエストパラメータのMapを返す。
```
 HTTPリクエストメッセージ中の以下のパラメータを格納したMapを返す。
   1. リクエストURI中のクエリパラメータ
   2. メッセージボディ内のPOSTパラメータ
 パラメータ名は重複する可能性があるので、値の型はString[]で定義されている。
 このMapに対する変更は直接反映される。
 
```
    定義:
    
    getParamMap インタフェース内 Validatable<java.lang.String[]>
    
    定義:
    
    getParamMap インタフェース内 Request<java.lang.String[]>
    
    定義:
    
    getParamMap クラス内 HttpRequest
    
    戻り値:
    
    リクエストパラメータのMap
  - getParam
```
public java.lang.String[] getParam(java.lang.String name)
```
    リクエストパラメータを取得する。
```
 このメソッドの処理は、以下のソースコードと等価である。
     this.params().get(name);
 
```
    定義:
    
    getParam インタフェース内 Request<java.lang.String[]>
    
    定義:
    
    getParam クラス内 HttpRequest
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    パラメータの値
    
    関連項目:
    
    getParamMap()
  - setParam
```
@Published
public HttpRequest setParam(java.lang.String name,
                                       java.lang.String... params)
```
    リクエストパラメータを設定する。
```
 このメソッドの処理は、以下のソースコードと等価である。
     this.params().put(name, params);
 
```
    定義:
    
    setParam クラス内 HttpRequest
    
    パラメータ:
    
    name - パラメータ名
    
    params - パラメータの値
    
    戻り値:
    
    このオブジェクト自体
  - setParamMap
```
@Published(tag="architect")
public HttpRequest setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)
```
    リクエストパラメータを設定する。
```
 このメソッドは自動テストからの使用を想定している。
 
```
    定義:
    
    setParamMap クラス内 HttpRequest
    
    パラメータ:
    
    params - リクエストパラメータのMap
    
    戻り値:
    
    このオブジェクト自体
  - getHeaderMap
```
@Published
public java.util.Map<java.lang.String,java.lang.String> getHeaderMap()
```
    HTTPリクエストヘッダを格納したMapを取得する。
```
 このMapに対する変更は直接反映される。
 
```
    定義:
    
    getHeaderMap クラス内 HttpRequest
    
    戻り値:
    
    HTTPリクエストヘッダのMap
  - setHeaderMap
```
public HttpRequest setHeaderMap(java.util.Map<java.lang.String,java.lang.String> headers)
```
    HTTPリクエストヘッダを格納したMapを設定する。
    
    パラメータ:
    
    headers - HTTPリクエストヘッダを格納したMap
    
    戻り値:
    
    このオブジェクト自体
  - getHeader
```
@Published
public java.lang.String getHeader(java.lang.String headerName)
```
    HTTPリクエストヘッダの値を返す。
    
    定義:
    
    getHeader クラス内 HttpRequest
    
    パラメータ:
    
    headerName - リクエストヘッダ名
    
    戻り値:
    
    HTTPリクエストヘッダの値
  - getHost
```
@Published
public java.lang.String getHost()
```
    HTTPリクエストのホストヘッダを取得する。
```
 このメソッドの処理は以下のソースコードと等価である。
     getHeaderMap().get("HOST")
 
```
    オーバーライド:
    
    getHost クラス内 HttpRequest
    
    戻り値:
    
    ホストヘッダ
  - setHost
```
public HttpRequest setHost(java.lang.String host)
```
    ホストヘッダの値を設定する。
    
    パラメータ:
    
    host - ホストヘッダの値
    
    戻り値:
    
    このオブジェクト自体
  - getCookie
```
@Published(tag="architect")
public HttpCookie getCookie()
```
    このリクエストで送信されるクッキー情報を取得する。
    
    定義:
    
    getCookie クラス内 HttpRequest
    
    戻り値:
    
    クッキー情報オブジェクト
  - setCookie
```
@Published(tag="architect")
public HttpRequest setCookie(HttpCookie cookie)
```
    このリクエストで送信されるクッキー情報を設定する。
    
    パラメータ:
    
    cookie - クッキー情報オブジェクト
    
    戻り値:
    
    このオブジェクト自体
  - toString
```
public java.lang.String toString()
```
    このクラスの実装では、オブジェクトの内容と等価なHTTPリクエストメッセージを返す。
    
    オーバーライド:
    
    toString クラス内 java.lang.Object

クラス MockHttpRequest

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド nablarch.fw.web.HttpRequest

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

コンストラクタの詳細

MockHttpRequest

MockHttpRequest

メソッドの詳細

getMethod

setMethod

getHttpVersion

setHttpVersion

getBodyReader

setBodyReader

getParamMap

getParam

setParam

setParamMap

getHeaderMap

setHeaderMap

getHeader

getHost

setHost

getCookie

setCookie

toString