nablarch.fw.web

クラス HttpRequest

java.lang.Object

nablarch.fw.web.HttpRequest

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

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

直系の既知のサブクラス:

HttpRequestWrapper, MockHttpRequest

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

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

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HttpRequest()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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リクエストの全マルチパートを取得する。
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情報を取得する。
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) リクエストパスを設定する。
HttpRequest	setRequestUri(java.lang.String requestUri) HTTPリクエストURIを設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

HttpRequest

public HttpRequest()

メソッドの詳細

getMethod

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

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

戻り値:

リクエストメソッド名

getRequestUri

@Published
public java.lang.String getRequestUri()

HTTPリクエストURIを返す。

戻り値:

リクエストURI

setRequestUri

public HttpRequest setRequestUri(java.lang.String requestUri)

HTTPリクエストURIを設定する。

パラメータ:

requestUri - リクエストURI

戻り値:

本オブジェクト

getRequestPath

@Published
public java.lang.String getRequestPath()

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

定義:

getRequestPath インタフェース内 Request<java.lang.String[]>

戻り値:

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

setRequestPath

@Published(tag="architect")
public HttpRequest setRequestPath(java.lang.String requestPath)

リクエストパスを設定する。

この実装では、リクエストURI中のリクエストパスを書き換える。

定義:

setRequestPath インタフェース内 Request<java.lang.String[]>

パラメータ:

requestPath - リクエストパス

戻り値:

本オブジェクト

getHttpVersion

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

HTTPバージョン名を返す。

戻り値:

HTTPバージョン名

getParamMap

public abstract java.util.Map<java.lang.String,java.lang.String[]> getParamMap()

リクエストパラメータのMapを返す。

 HTTPリクエストメッセージ中の以下のパラメータを格納したMapを返す。
   1. リクエストURI中のクエリパラメータ
   2. メッセージボディ内のPOSTパラメータ
 パラメータ名は重複する可能性があるので、値の型はString[]で定義されている。
 

定義:

getParamMap インタフェース内 Validatable<java.lang.String[]>

定義:

getParamMap インタフェース内 Request<java.lang.String[]>

戻り値:

リクエストパラメータのMap

getParam

public abstract java.lang.String[] getParam(java.lang.String name)

リクエストパラメータを取得する。

定義:

getParam インタフェース内 Request<java.lang.String[]>

パラメータ:

name - パラメータ名

戻り値:

パラメータの値

関連項目:

getParamMap()

setParam

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

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

パラメータ:

name - パラメータ名

params - パラメータの値

戻り値:

本オブジェクト

setParamMap

@Published(tag="architect")
public abstract HttpRequest setParamMap(java.util.Map<java.lang.String,java.lang.String[]> params)

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

パラメータ:

params - リクエストパラメータのMap

戻り値:

本オブジェクト

getHeaderMap

@Published
public abstract java.util.Map<java.lang.String,java.lang.String> getHeaderMap()

HTTPリクエストヘッダを格納したMapを取得する。

戻り値:

HTTPリクエストヘッダのMap

getHeader

@Published
public abstract java.lang.String getHeader(java.lang.String headerName)

HTTPリクエストヘッダの値を返す。

パラメータ:

headerName - リクエストヘッダ名

戻り値:

HTTPリクエストヘッダの値

getHost

@Published
public java.lang.String getHost()

HTTPリクエストのホストヘッダを取得する。

戻り値:

ホストヘッダ

getCookie

@Published(tag="architect")
public abstract HttpCookie getCookie()

本リクエストで送信されるクッキー情報を取得する。

戻り値:

クッキー情報オブジェクト

getPart

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

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

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

パラメータ:

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

戻り値:

マルチパート

setMultipart

@Published(tag="architect")
public void setMultipart(java.util.Map<java.lang.String,java.util.List<PartInfo>> multipart)

マルチパートを設定する。

パラメータ:

multipart - マルチパート

getMultipart

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

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

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

キー

名称(inputタグのname属性)

値

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

戻り値:

全マルチパート

関連項目:

getPart(String)

getUserAgent

@Published
public <UA extends UserAgent> UA getUserAgent()

UserAgent情報を取得する。

HTTPヘッダ("User-Agent")よりUser-Agent文字列を取得し、 SystemRepositoryに設定されたUserAgentParser(コンポーネント名"userAgentParser")で解析を行う。
パーサーが取得できない場合は、 全ての項目にデフォルト値が設定されたUserAgentオブジェクトが返却される。

型パラメータ:

UA - userAgentの型

戻り値:

UserAgentオブジェクト