MockHttpRequest (Nablarch-API)

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

All Implemented Interfaces:

Validatable<java.lang.String[]>, Request<java.lang.String[]>

Direct Known Subclasses:

RestMockHttpRequest
```
public class MockHttpRequest
extends HttpRequest
```
testing framework用のHttpRequest実装クラス。

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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リクエストメッセージを返す。

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

Class MockHttpRequest

Constructor Summary

Method Summary

Methods inherited from class nablarch.fw.web.HttpRequest

Methods inherited from class java.lang.Object

Constructor Detail

MockHttpRequest

MockHttpRequest

Method Detail

getMethod

setMethod

getHttpVersion

setHttpVersion

getBodyReader

setBodyReader

getParamMap

getParam

setParam

setParamMap

getHeaderMap

setHeaderMap

getHeader

getHost

setHost

getCookie

setCookie

toString