Package nablarch.fw.jaxrs

Class JaxRsHttpRequest

java.lang.Object
nablarch.fw.web.HttpRequest
nablarch.fw.jaxrs.JaxRsHttpRequest
All Implemented Interfaces:
Validatable<String[]>, Request<String[]>
public class JaxRsHttpRequest extends HttpRequest
JAX-RS用のHttpRequestクラス。

getParamMap()、getParam(String) を公開APIとし、それ以外のメソッドは保持するHttpRequestに委譲している。

  • Constructor Details

    • JaxRsHttpRequest

      public JaxRsHttpRequest(HttpRequest request)

  • Method Details

    • getParamMap

      @Published public Map<String,String[]> getParamMap()
      Description copied from class: HttpRequest
      リクエストパラメータのMapを返す。 
       HTTPリクエストメッセージ中の以下のパラメータを格納したMapを返す。
   1. リクエストURI中のクエリパラメータ
   2. メッセージボディ内のPOSTパラメータ
 パラメータ名は重複する可能性があるので、値の型はString[]で定義されている。
      Specified by:
      getParamMap in interface Request<String[]>
      Specified by:
      getParamMap in interface Validatable<String[]>
      Specified by:
      getParamMap in class HttpRequest
      Returns:
      リクエストパラメータのMap

    • getParam

      @Published public String[] getParam(String name)
      Description copied from class: HttpRequest
      リクエストパラメータを取得する。
      Specified by:
      getParam in interface Request<String[]>
      Specified by:
      getParam in class HttpRequest
      Parameters:
      name - パラメータ名
      Returns:
      パラメータの値
      See Also:

    • getPathParam

      @Published public String getPathParam(String name)
      HTTPリクエストからパスパラメータを取得する。
      Parameters:
      name - パラメータ名
      Returns:
      パラメータの値

    • getMethod

      public String getMethod()
      Description copied from class: HttpRequest
      HTTPリクエストメソッド名を返す。
      Specified by:
      getMethod in class HttpRequest
      Returns:
      リクエストメソッド名

    • getRequestUri

      public String getRequestUri()
      Description copied from class: HttpRequest
      HTTPリクエストURIを返す。
      Overrides:
      getRequestUri in class HttpRequest
      Returns:
      リクエストURI

    • setRequestUri

      public HttpRequest setRequestUri(String requestUri)
      Description copied from class: HttpRequest
      HTTPリクエストURIを設定する。
      Overrides:
      setRequestUri in class HttpRequest
      Parameters:
      requestUri - リクエストURI
      Returns:
      本オブジェクト

    • getRequestPath

      public String getRequestPath()
      Description copied from class: HttpRequest
      HTTPリクエストURIのパス部分(クエリストリングを除いた部分)を返す。
      Specified by:
      getRequestPath in interface Request<String[]>
      Overrides:
      getRequestPath in class HttpRequest
      Returns:
      HTTPリクエストURIのパス部分

    • setRequestPath

      public HttpRequest setRequestPath(String requestPath)
      Description copied from class: HttpRequest
      リクエストパスを設定する。

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

      Specified by:
      setRequestPath in interface Request<String[]>
      Overrides:
      setRequestPath in class HttpRequest
      Parameters:
      requestPath - リクエストパス
      Returns:
      本オブジェクト

    • getHttpVersion

      public String getHttpVersion()
      Description copied from class: HttpRequest
      HTTPバージョン名を返す。
      Specified by:
      getHttpVersion in class HttpRequest
      Returns:
      HTTPバージョン名

    • setParam

      public HttpRequest setParam(String name, String... params)
      Description copied from class: HttpRequest
      リクエストパラメータを設定する。
      Specified by:
      setParam in class HttpRequest
      Parameters:
      name - パラメータ名
      params - パラメータの値
      Returns:
      本オブジェクト

    • setParamMap

      public HttpRequest setParamMap(Map<String,String[]> params)
      Description copied from class: HttpRequest
      リクエストパラメータを設定する。
      Specified by:
      setParamMap in class HttpRequest
      Parameters:
      params - リクエストパラメータのMap
      Returns:
      本オブジェクト

    • getHeaderMap

      public Map<String,String> getHeaderMap()
      Description copied from class: HttpRequest
      HTTPリクエストヘッダを格納したMapを取得する。
      Specified by:
      getHeaderMap in class HttpRequest
      Returns:
      HTTPリクエストヘッダのMap

    • getHeader

      public String getHeader(String headerName)
      Description copied from class: HttpRequest
      HTTPリクエストヘッダの値を返す。
      Specified by:
      getHeader in class HttpRequest
      Parameters:
      headerName - リクエストヘッダ名
      Returns:
      HTTPリクエストヘッダの値

    • getHost

      public 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 List<PartInfo> getPart(String name)
      Description copied from class: HttpRequest
      マルチパートの一部を取得する。

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

      Overrides:
      getPart in class HttpRequest
      Parameters:
      name - 名称(inputタグのname属性)
      Returns:
      マルチパート

    • setMultipart

      public void setMultipart(Map<String,List<PartInfo>> multipart)
      Description copied from class: HttpRequest
      マルチパートを設定する。
      Overrides:
      setMultipart in class HttpRequest
      Parameters:
      multipart - マルチパート

    • getMultipart

      public Map<String,List<PartInfo>> getMultipart()
      Description copied from class: HttpRequest
      本HTTPリクエストの全マルチパートを取得する。

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

      キー
      名称(inputタグのname属性)
      値
      キーのname属性でアップロードされたマルチパート
      Overrides:
      getMultipart in class HttpRequest
      Returns:
      全マルチパート
      See Also:

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