RestMockHttpRequest (Nablarch-API)

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

All Implemented Interfaces:

Validatable<java.lang.String[]>, Request<java.lang.String[]>
```
@Published
public class RestMockHttpRequest
extends MockHttpRequest
```
RESTfulウェブサービステスト用のHttpRequestモッククラス。

Constructor Summary

Constructors
Constructor and Description
`RestMockHttpRequest(java.util.Collection<? extends RestTestBodyConverter> bodyConverters, java.lang.String defaultContentType)` 引数で渡された`RestTestBodyConverter`の`Collection`とデフォルトContent-Typeを持つオブジェクトを生成する。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getBody()` ボディを取得する。
`RestMockHttpRequest`	`setBody(java.lang.Object body)` リクエストボディを設定する。
`RestMockHttpRequest`	`setContentType(java.lang.String contentType)` Content-Typeを設定する。
`RestMockHttpRequest`	`setCookie(HttpCookie cookie)` このリクエストで送信されるクッキー情報を設定する。
`RestMockHttpRequest`	`setHeader(java.lang.String headerName, java.lang.String value)` HTTPリクエストヘッダの値を設定する。
`RestMockHttpRequest`	`setHeaderMap(java.util.Map<java.lang.String,java.lang.String> headers)` HTTPリクエストヘッダを格納したMapを設定する。
`RestMockHttpRequest`	`setHost(java.lang.String host)` ホストヘッダの値を設定する。
`RestMockHttpRequest`	`setHttpVersion(java.lang.String httpVersion)` HTTPバージョン名を指定する。
`RestMockHttpRequest`	`setMethod(java.lang.String method)` HTTPリクエストメソッド名を設定する。
`RestMockHttpRequest`	`setParam(java.lang.String name, java.lang.String... params)` リクエストパラメータを設定する。
`RestMockHttpRequest`	`setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)` リクエストパラメータを設定する。
`RestMockHttpRequest`	`setRequestPath(java.lang.String requestPath)` リクエストパスを設定する。この実装では、リクエストURI中のリクエストパスを書き換える。
`RestMockHttpRequest`	`setRequestUri(java.lang.String requestPath)` HTTPリクエストURIを設定する。
`java.lang.String`	`toString()` このクラスの実装では、オブジェクトの内容と等価なHTTPリクエストメッセージを返す。

Methods inherited from class nablarch.fw.web.MockHttpRequest
getBodyReader, getCookie, getHeader, getHeaderMap, getHost, getHttpVersion, getMethod, getParam, getParamMap, setBodyReader

Methods inherited from class nablarch.fw.web.HttpRequest
getMultipart, getPart, getRequestPath, getRequestUri, getUserAgent, setMultipart

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RestMockHttpRequest
```
public RestMockHttpRequest(java.util.Collection<? extends RestTestBodyConverter> bodyConverters,
                           java.lang.String defaultContentType)
```
    引数で渡されたRestTestBodyConverterのCollectionとデフォルトContent-Typeを持つオブジェクトを生成する。
    
    Parameters:
    
    bodyConverters - 利用可能なRestTestBodyConverter
    
    defaultContentType - デフォルトContent-Type
- Method Detail
  - getBody
```
public java.lang.Object getBody()
```
    ボディを取得する。
    
    Returns:
    
    リクエストボディ
  - setBody
```
public RestMockHttpRequest setBody(java.lang.Object body)
```
    リクエストボディを設定する。
    
    Parameters:
    
    body - リクエストボディに設定するオブジェクト
    
    Returns:
    
    RestMockHttpRequest自身
  - setContentType
```
public RestMockHttpRequest setContentType(java.lang.String contentType)
```
    Content-Typeを設定する。
    
    Parameters:
    
    contentType - Content-Typeに設定する値
    
    Returns:
    
    RestMockHttpRequest自身
  - setMethod
```
public RestMockHttpRequest setMethod(java.lang.String method)
```
    Description copied from class: MockHttpRequest
    HTTPリクエストメソッド名を設定する。
```
 明示的に設定しない場合のデフォルト値は"GET"である。
 
```
    Overrides:
    
    setMethod in class MockHttpRequest
    
    Parameters:
    
    method - HTTPメソッド名
    
    Returns:
    
    このオブジェクト自体
  - setHeaderMap
```
public RestMockHttpRequest setHeaderMap(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Description copied from class: MockHttpRequest
    
    HTTPリクエストヘッダを格納したMapを設定する。
    
    Overrides:
    
    setHeaderMap in class MockHttpRequest
    
    Parameters:
    
    headers - HTTPリクエストヘッダを格納したMap
    
    Returns:
    
    このオブジェクト自体
  - setHeader
```
public RestMockHttpRequest setHeader(java.lang.String headerName,
                                     java.lang.String value)
```
    HTTPリクエストヘッダの値を設定する。
    
    Parameters:
    
    headerName - リクエストヘッダ名
    
    value - リクエストヘッダに設定する値
    
    Returns:
    
    このオブジェクト自体
  - setRequestUri
```
public RestMockHttpRequest setRequestUri(java.lang.String requestPath)
```
    Description copied from class: HttpRequest
    
    HTTPリクエストURIを設定する。
    
    Overrides:
    
    setRequestUri in class HttpRequest
    
    Parameters:
    
    requestPath - リクエストURI
    
    Returns:
    
    本オブジェクト
  - setParam
```
public RestMockHttpRequest setParam(java.lang.String name,
                                    java.lang.String... params)
```
    Description copied from class: MockHttpRequest
    リクエストパラメータを設定する。
```
 このメソッドの処理は、以下のソースコードと等価である。
     this.params().put(name, params);
 
```
    Overrides:
    
    setParam in class MockHttpRequest
    
    Parameters:
    
    name - パラメータ名
    
    params - パラメータの値
    
    Returns:
    
    このオブジェクト自体
  - setParamMap
```
public RestMockHttpRequest setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)
```
    Description copied from class: MockHttpRequest
    リクエストパラメータを設定する。
```
 このメソッドは自動テストからの使用を想定している。
 
```
    Overrides:
    
    setParamMap in class MockHttpRequest
    
    Parameters:
    
    params - リクエストパラメータのMap
    
    Returns:
    
    このオブジェクト自体
  - setCookie
```
public RestMockHttpRequest setCookie(HttpCookie cookie)
```
    Description copied from class: MockHttpRequest
    
    このリクエストで送信されるクッキー情報を設定する。
    
    Overrides:
    
    setCookie in class MockHttpRequest
    
    Parameters:
    
    cookie - クッキー情報オブジェクト
    
    Returns:
    
    このオブジェクト自体
  - setHttpVersion
```
public RestMockHttpRequest setHttpVersion(java.lang.String httpVersion)
```
    Description copied from class: MockHttpRequest
    HTTPバージョン名を指定する。
```
 明示的に指定しない場合のデフォルト値は"HTTP/1.1"である。
 
```
    Overrides:
    
    setHttpVersion in class MockHttpRequest
    
    Parameters:
    
    httpVersion - HTTPバージョン名
    
    Returns:
    
    このオブジェクト自体
  - setHost
```
public RestMockHttpRequest setHost(java.lang.String host)
```
    Description copied from class: MockHttpRequest
    
    ホストヘッダの値を設定する。
    
    Overrides:
    
    setHost in class MockHttpRequest
    
    Parameters:
    
    host - ホストヘッダの値
    
    Returns:
    
    このオブジェクト自体
  - setRequestPath
```
public RestMockHttpRequest setRequestPath(java.lang.String requestPath)
```
    Description copied from class: HttpRequest
    
    リクエストパスを設定する。
    この実装では、リクエストURI中のリクエストパスを書き換える。
    
    Specified by:
    
    setRequestPath in interface Request<java.lang.String[]>
    
    Overrides:
    
    setRequestPath in class HttpRequest
    
    Parameters:
    
    requestPath - リクエストパス
    
    Returns:
    
    本オブジェクト
  - toString
```
public java.lang.String toString()
```
    Description copied from class: MockHttpRequest
    
    このクラスの実装では、オブジェクトの内容と等価なHTTPリクエストメッセージを返す。
    
    Overrides:
    
    toString in class MockHttpRequest

Class RestMockHttpRequest

Constructor Summary

Method Summary

Methods inherited from class nablarch.fw.web.MockHttpRequest

Methods inherited from class nablarch.fw.web.HttpRequest

Methods inherited from class java.lang.Object

Constructor Detail

RestMockHttpRequest

Method Detail

getBody

setBody

setContentType

setMethod

setHeaderMap

setHeader

setRequestUri

setParam

setParamMap

setCookie

setHttpVersion

setHost

setRequestPath

toString