nablarch.fw.web

Class HttpRequest

java.lang.Object

nablarch.fw.web.HttpRequest

All Implemented Interfaces:

nablarch.core.validation.Validatable<java.lang.String[]>, Request<java.lang.String[]>

Direct Known Subclasses:

JaxRsHttpRequest, nablarch.fw.web.MockHttpRequest

public abstract class HttpRequest
extends java.lang.Object
implements Request<java.lang.String[]>, nablarch.core.validation.Validatable<java.lang.String[]>

HTTP/1.1(RFC2616)におけるリクエストメッセージのパーサ及び その結果を格納するデータオブジェクト。

Author:

Iwauo Tajima

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getHeader(java.lang.String headerName) HTTPリクエストヘッダの値を返す。
abstract java.util.Map	getHeaderMap() HTTPリクエストヘッダを格納したMapを取得する。
java.lang.String	getHost() HTTPリクエストのホストヘッダを取得する。
abstract java.lang.String	getHttpVersion() HTTPバージョン名を返す。
abstract java.lang.String	getMethod() HTTPリクエストメソッド名を返す。
java.util.Map<java.util.List<PartInfo>>	getMultipart() 本HTTPリクエストの全マルチパートを取得する。 戻り値のMapの構造を以下に示す。 キー 名称(inputタグのname属性) 値 キーのname属性でアップロードされたマルチパート
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オブジェクトが返却される。
abstract HttpRequest	setParam(java.lang.String name, java.lang.String... params) リクエストパラメータを設定する。

Methods inherited from interface nablarch.fw.Request

getParam, getParamMap, setRequestPath

Method Detail

getMethod

@Published
public abstract java.lang.String getMethod()

HTTPリクエストメソッド名を返す。

Returns:

リクエストメソッド名

getRequestUri

@Published
public java.lang.String getRequestUri()

HTTPリクエストURIを返す。

Returns:

リクエストURI

getRequestPath

@Published
public java.lang.String getRequestPath()

HTTPリクエストURIのパス部分(クエリストリングを除いた部分)を返す。

Specified by:

getRequestPath in interface Request<java.lang.String[]>

Returns:

HTTPリクエストURIのパス部分

getHttpVersion

@Published
public abstract java.lang.String getHttpVersion()

HTTPバージョン名を返す。

Returns:

HTTPバージョン名

setParam

@Published
public abstract HttpRequest setParam(java.lang.String name,
                                                java.lang.String... params)

リクエストパラメータを設定する。

Parameters:

name - パラメータ名

params - パラメータの値

Returns:

本オブジェクト

getHeaderMap

@Published
public abstract java.util.Map 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:

ホストヘッダ

getPart

@Published
public java.util.List<PartInfo> getPart(java.lang.String name)

マルチパートの一部を取得する。

引数で指定した名称に合致するパートが存在しない場合、空のリストが返却される。

Parameters:

name - 名称(inputタグのname属性)

Returns:

マルチパート

getMultipart

@Published
public java.util.Map<java.util.List<PartInfo>> getMultipart()

本HTTPリクエストの全マルチパートを取得する。

戻り値のMapの構造を以下に示す。

キー

名称(inputタグのname属性)

値

キーのname属性でアップロードされたマルチパート

Returns:

全マルチパート

See Also:

HttpRequest.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オブジェクト