HttpRequest (Nablarch-API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HttpRequestWrapper, JaxRsHttpRequest, MockHttpRequest
```
public abstract class HttpRequest
extends java.lang.Object
implements Request<java.lang.String[]>, Validatable<java.lang.String[]>
```
HTTP/1.1(RFC2616)におけるリクエストメッセージのパーサ及びその結果を格納するデータオブジェクト。

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract HttpCookie`	`getCookie()` 本リクエストで送信されるクッキー情報を取得する。
`abstract java.lang.String`	`getHeader(java.lang.String headerName)` HTTPリクエストヘッダの値を返す。
`abstract java.util.Map<java.lang.String,java.lang.String>`	`getHeaderMap()` HTTPリクエストヘッダを格納したMapを取得する。
`java.lang.String`	`getHost()` HTTPリクエストのホストヘッダを取得する。
`abstract java.lang.String`	`getHttpVersion()` HTTPバージョン名を返す。
`abstract java.lang.String`	`getMethod()` HTTPリクエストメソッド名を返す。
`java.util.Map<java.lang.String,java.util.List<PartInfo>>`	`getMultipart()` 本HTTPリクエストの全マルチパートを取得する。戻り値のMapの構造を以下に示す。キー名称(inputタグのname属性) 値キーのname属性でアップロードされたマルチパート
`abstract java.lang.String[]`	`getParam(java.lang.String name)` リクエストパラメータを取得する。
`abstract java.util.Map<java.lang.String,java.lang.String[]>`	`getParamMap()` リクエストパラメータのMapを返す。
`java.util.List<PartInfo>`	`getPart(java.lang.String name)` マルチパートの一部を取得する。引数で指定した名称に合致するパートが存在しない場合、空のリストが返却される。
`java.lang.String`	`getRequestPath()` HTTPリクエストURIのパス部分(クエリストリングを除いた部分)を返す。
`java.lang.String`	`getRequestUri()` HTTPリクエストURIを返す。
`<UA extends UserAgent> UA`	`getUserAgent()` UserAgent情報を取得する。 HTTPヘッダ("User-Agent")よりUser-Agent文字列を取得し、 `SystemRepository`に設定された`UserAgentParser`(コンポーネント名"userAgentParser")で解析を行う。パーサーが取得できない場合は、全ての項目にデフォルト値が設定された`UserAgent`オブジェクトが返却される。
`void`	`setMultipart(java.util.Map<java.lang.String,java.util.List<PartInfo>> multipart)` マルチパートを設定する。
`abstract HttpRequest`	`setParam(java.lang.String name, java.lang.String... params)` リクエストパラメータを設定する。
`abstract HttpRequest`	`setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)` リクエストパラメータを設定する。
`HttpRequest`	`setRequestPath(java.lang.String requestPath)` リクエストパスを設定する。この実装では、リクエストURI中のリクエストパスを書き換える。
`HttpRequest`	`setRequestUri(java.lang.String requestUri)` HTTPリクエストURIを設定する。

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

- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
- Method Detail
  - getMethod
```
@Published
public abstract java.lang.String getMethod()
```
    HTTPリクエストメソッド名を返す。
    
    Returns:
    
    リクエストメソッド名
  - getRequestUri
```
@Published
public java.lang.String getRequestUri()
```
    HTTPリクエストURIを返す。
    
    Returns:
    
    リクエストURI
  - setRequestUri
```
public HttpRequest setRequestUri(java.lang.String requestUri)
```
    HTTPリクエストURIを設定する。
    
    Parameters:
    
    requestUri - リクエストURI
    
    Returns:
    
    本オブジェクト
  - getRequestPath
```
@Published
public java.lang.String getRequestPath()
```
    HTTPリクエストURIのパス部分(クエリストリングを除いた部分)を返す。
    
    Specified by:
    
    getRequestPath in interface Request<java.lang.String[]>
    
    Returns:
    
    HTTPリクエストURIのパス部分
  - setRequestPath
```
@Published(tag="architect")
public HttpRequest setRequestPath(java.lang.String requestPath)
```
    リクエストパスを設定する。
    この実装では、リクエストURI中のリクエストパスを書き換える。
    
    Specified by:
    
    setRequestPath in interface Request<java.lang.String[]>
    
    Parameters:
    
    requestPath - リクエストパス
    
    Returns:
    
    本オブジェクト
  - getHttpVersion
```
@Published
public abstract java.lang.String getHttpVersion()
```
    HTTPバージョン名を返す。
    
    Returns:
    
    HTTPバージョン名
  - getParamMap
```
@Published(tag="architect")
public abstract java.util.Map<java.lang.String,java.lang.String[]> getParamMap()
```
    リクエストパラメータのMapを返す。
```
 HTTPリクエストメッセージ中の以下のパラメータを格納したMapを返す。
   1. リクエストURI中のクエリパラメータ
   2. メッセージボディ内のPOSTパラメータ
 パラメータ名は重複する可能性があるので、値の型はString[]で定義されている。
 
```
    Specified by:
    
    getParamMap in interface Validatable<java.lang.String[]>
    
    Specified by:
    
    getParamMap in interface Request<java.lang.String[]>
    
    Returns:
    
    リクエストパラメータのMap
  - getParam
```
@Published(tag="architect")
public abstract java.lang.String[] getParam(java.lang.String name)
```
    リクエストパラメータを取得する。
    
    Specified by:
    
    getParam in interface Request<java.lang.String[]>
    
    Parameters:
    
    name - パラメータ名
    
    Returns:
    
    パラメータの値
    
    See Also:
    
    getParamMap()
  - setParam
```
@Published
public abstract HttpRequest setParam(java.lang.String name,
                                                java.lang.String... params)
```
    リクエストパラメータを設定する。
    
    Parameters:
    
    name - パラメータ名
    
    params - パラメータの値
    
    Returns:
    
    本オブジェクト
  - setParamMap
```
@Published(tag="architect")
public abstract HttpRequest setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)
```
    リクエストパラメータを設定する。
    
    Parameters:
    
    params - リクエストパラメータのMap
    
    Returns:
    
    本オブジェクト
  - getHeaderMap
```
@Published
public abstract java.util.Map<java.lang.String,java.lang.String> getHeaderMap()
```
    HTTPリクエストヘッダを格納したMapを取得する。
    
    Returns:
    
    HTTPリクエストヘッダのMap
  - getHeader
```
@Published
public abstract java.lang.String getHeader(java.lang.String headerName)
```
    HTTPリクエストヘッダの値を返す。
    
    Parameters:
    
    headerName - リクエストヘッダ名
    
    Returns:
    
    HTTPリクエストヘッダの値
  - getHost
```
@Published
public java.lang.String getHost()
```
    HTTPリクエストのホストヘッダを取得する。
    
    Returns:
    
    ホストヘッダ
  - getCookie
```
@Published(tag="architect")
public abstract HttpCookie getCookie()
```
    本リクエストで送信されるクッキー情報を取得する。
    
    Returns:
    
    クッキー情報オブジェクト
  - getPart
```
@Published
public java.util.List<PartInfo> getPart(java.lang.String name)
```
    マルチパートの一部を取得する。
    引数で指定した名称に合致するパートが存在しない場合、空のリストが返却される。
    
    Parameters:
    
    name - 名称(inputタグのname属性)
    
    Returns:
    
    マルチパート
  - setMultipart
```
@Published(tag="architect")
public void setMultipart(java.util.Map<java.lang.String,java.util.List<PartInfo>> multipart)
```
    マルチパートを設定する。
    
    Parameters:
    
    multipart - マルチパート
  - getMultipart
```
@Published
public java.util.Map<java.lang.String,java.util.List<PartInfo>> getMultipart()
```
    本HTTPリクエストの全マルチパートを取得する。
    戻り値のMapの構造を以下に示す。
    
    キー
    
    名称(inputタグのname属性)
    
    値
    
    キーのname属性でアップロードされたマルチパート
    
    Returns:
    
    全マルチパート
    
    See Also:
    
    getPart(String)
  - getUserAgent
```
@Published
public <UA extends UserAgent> UA getUserAgent()
```
    UserAgent情報を取得する。
    HTTPヘッダ("User-Agent")よりUser-Agent文字列を取得し、 SystemRepositoryに設定されたUserAgentParser(コンポーネント名"userAgentParser")で解析を行う。
    パーサーが取得できない場合は、全ての項目にデフォルト値が設定されたUserAgentオブジェクトが返却される。
    
    Type Parameters:
    
    UA - userAgentの型
    
    Returns:
    
    UserAgentオブジェクト

Class HttpRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpRequest

Method Detail

getMethod

getRequestUri

setRequestUri

getRequestPath

setRequestPath

getHttpVersion

getParamMap

getParam

setParam

setParamMap

getHeaderMap

getHeader

getHost

getCookie

getPart

setMultipart

getMultipart

getUserAgent