JaxRsHttpRequest (Nablarch-API)

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

All Implemented Interfaces:

Validatable<java.lang.String[]>, Request<java.lang.String[]>
```
public class JaxRsHttpRequest
extends HttpRequest
```
JAX-RS用のHttpRequestクラス。
getParamMap()、getParam(String) を公開APIとし、それ以外のメソッドは保持するHttpRequestに委譲している。

Constructor Summary

Constructors
Constructor and Description

JaxRsHttpRequest(HttpRequest request)

Constructors
Constructor and Description
`JaxRsHttpRequest(HttpRequest request)`

Method Summary

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

Class JaxRsHttpRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JaxRsHttpRequest

Method Detail

getParamMap

getParam

getPathParam

getMethod

getRequestUri

setRequestUri

getRequestPath

setRequestPath

getHttpVersion

setParam

setParamMap

getHeaderMap

getHeader

getHost

getCookie

getPart

setMultipart

getMultipart

getUserAgent