HttpRequest (NablarchApi)

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

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

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

作成者:

Iwauo Tajima

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`abstract HttpCookie`	`getCookie()` 本リクエストで送信されるクッキー情報を取得する。
`abstract String`	`getHeader(String headerName)` HTTPリクエストヘッダの値を返す。
`abstract Map`	`getHeaderMap()` HTTPリクエストヘッダを格納したMapを取得する。
`String`	`getHost()` HTTPリクエストのホストヘッダを取得する。
`abstract String`	`getHttpVersion()` HTTPバージョン名を返す。
`abstract String`	`getMethod()` HTTPリクエストメソッド名を返す。
`Map<List<PartInfo>>`	`getMultipart()` 本HTTPリクエストの全マルチパートを取得する。
`List<PartInfo>`	`getPart(String name)` マルチパートの一部を取得する。
`String`	`getRequestPath()` HTTPリクエストURIのパス部分(クエリストリングを除いた部分)を返す。
`String`	`getRequestUri()` HTTPリクエストURIを返す。
`<UA extends UserAgent> UA`	`getUserAgent()` UserAgent情報を取得する。
`void`	`setMultipart(Map<List<PartInfo>> multipart)` マルチパートを設定する。
`abstract HttpRequest`	`setParam(String name, String... params)` リクエストパラメータを設定する。
`abstract HttpRequest`	`setParamMap(Map<String[]> params)` リクエストパラメータを設定する。
`HttpRequest`	`setRequestPath(String requestPath)` リクエストパスを設定する。

インタフェースから継承されたメソッド nablarch.fw.Request
getParam, getParamMap

インタフェースから継承されたメソッド nablarch.core.validation.Validatable
getParamMap

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

クラス HttpRequest

メソッドのサマリー

インタフェースから継承されたメソッド nablarch.fw.Request

インタフェースから継承されたメソッド nablarch.core.validation.Validatable

メソッドの詳細

getMethod

getRequestUri

getRequestPath

setRequestPath

getHttpVersion

setParam

setParamMap

getHeaderMap

getHeader

getHost

getCookie

getPart

setMultipart

getMultipart

getUserAgent