Mergedoc
Translation

javax.servlet.http
インタフェース HttpServletRequest

すべてのスーパーインタフェース:
ServletRequest
既知の実装クラスの一覧:
HttpServletRequestWrapper

public interface HttpServletRequest
extends ServletRequest

HTTP Servlet のためのリクエスト情報を与えるために ServletRequest インタフェースを拡張します。

Servlet コンテナは HttpServletRequest オブジェクトを生成し、Servlet のサービスメソッド (doGetdoPost 等) に引数で渡します。

作成者:
Various

フィールドの概要
static java.lang.String BASIC_AUTH
          基本認証のための識別文字列です。
static java.lang.String CLIENT_CERT_AUTH
          クライアント証明書認証のための識別文字列です。
static java.lang.String DIGEST_AUTH
          ダイジェスト認証のための識別文字列です。
static java.lang.String FORM_AUTH
          フォーム認証のための識別文字列です。
 
メソッドの概要
 java.lang.String getAuthType()
          Servlet を保護するために使われている認証スキームの名前を返します。
 java.lang.String getContextPath()
          リクエストされた URI のうち、リクエストのコンテキストを指す部分を返します。
 Cookie[] getCookies()
          このリクエストと一緒にクライアントから送られてきた全ての Cookie オブジェクトの配列を返します。
 long getDateHeader(java.lang.String name)
          指定されたリクエストヘッダの値を Date オブジェクトを表す long 値として返します。
 java.lang.String getHeader(java.lang.String name)
          指定されたリクエストヘッダの値を String として返します。
 java.util.Enumeration getHeaderNames()
          このリクエストに含まれる全てのヘッダ名の Enumeration を返します。
 java.util.Enumeration getHeaders(java.lang.String name)
          指定されたリクエストヘッダの全ての値を String オブジェクトの Enumeration として返します。
 int getIntHeader(java.lang.String name)
          指定されたリクエストヘッダの値を int 値として返します。
 java.lang.String getMethod()
          例えば GET、POST、PUT のような、このリクエストを生成した HTTP メソッドの名前を返します。
 java.lang.String getPathInfo()
          このリクエストを生成した時にクライアントが URL に関連づけて送った拡張パス情報を返します。
 java.lang.String getPathTranslated()
          Servlet 名の後ろからクエリ文字列の前にある拡張パス情報を返しますが、実際のパスに変換してから返します。
 java.lang.String getQueryString()
          リクエストされた URL のパスの後ろに含まれているクエリ文字列を返します。
 java.lang.String getRemoteUser()
          リクエストを生成したユーザが認証されている場合はそのユーザのログイン名を返します。
 java.lang.String getRequestedSessionId()
          クライアントによって指定されたセッションの ID を返します。
 java.lang.String getRequestURI()
          この HTTP リクエストの最初の行にある、リクエストの URL のうちプロトコル名からクエリ文字列までの部分を返します。
 java.lang.StringBuffer getRequestURL()
          クライアントがこのリクエストを生成するのに使ったURLを再構築します。
 java.lang.String getServletPath()
          このリクエストの URL のうち、Servlet を呼び出すための部分を返します。
 HttpSession getSession()
          このリクエストに関連づけられている現在のセッションを返します。
 HttpSession getSession(boolean create)
          このリクエストに関連づけられている現在の HttpSession もしくは現在のセッションが存在せずかつ create が真である場合は新しいセッションを返します。
 java.security.Principal getUserPrincipal()
          現在の認証ユーザの名前を含む java.security.Principal オブジェクトを返します。
 boolean isRequestedSessionIdFromCookie()
          リクエストされたセッションの ID が Cookie として送られてきたのかどうかを調べます。
 boolean isRequestedSessionIdFromUrl()
          推奨されていません。 Java Servlet API のバージョン 2.1 以降では、代わりに isRequestedSessionIdFromURL() を使うようにして下さい。
 boolean isRequestedSessionIdFromURL()
          リクエストされたセッション ID がリクエストされた URL の一部分として送られてきたのかどうかを調べます。
 boolean isRequestedSessionIdValid()
          リクエストされたセッションの ID が未だに有効であるかどうかを調べます。
 boolean isUserInRole(java.lang.String role)
          認証されているユーザが指定された論理的な「ロール」に含まれているかどうかを表す boolean を返します。
 
インタフェース javax.servlet.ServletRequest から継承されたメソッド
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 

フィールドの詳細

BASIC_AUTH

static final java.lang.String BASIC_AUTH
基本認証のための識別文字列です。値は「BASIC」です。

関連項目:
定数フィールド値

FORM_AUTH

static final java.lang.String FORM_AUTH
フォーム認証のための識別文字列です。値は「FORM」です。

関連項目:
定数フィールド値

CLIENT_CERT_AUTH

static final java.lang.String CLIENT_CERT_AUTH
クライアント証明書認証のための識別文字列です。値は「CLIENT_CERT」です。

関連項目:
定数フィールド値

DIGEST_AUTH

static final java.lang.String DIGEST_AUTH
ダイジェスト認証のための識別文字列です。値は「DIGEST」です。

関連項目:
定数フィールド値
メソッドの詳細

getAuthType

java.lang.String getAuthType()
Servlet を保護するために使われている認証スキームの名前を返します。 全ての Servlet コンテナは、基本認証、フォームベース認証、クライアント証明書認証をサポートします。 また、付加的にダイジェスト認証をサポートするコンテナもあります。 Servlet が認証されていない場合は null を返します。

この値は CGI 変数の AUTH_TYPE と同じ値です。

戻り値:
認証スキームを表す静的メンバ BASIC_AUTH、FORM_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH またはコンテナ指定文字列のいずれか (== 演算子で比較可能) 。リクエストが認証されていない場合は null

getCookies

Cookie[] getCookies()
このリクエストと一緒にクライアントから送られてきた全ての Cookie オブジェクトの配列を返します。 Cookie が送られていない場合は null を返します。

戻り値:
このリクエストに付加されている Cookie の配列。 リクエストに Cookie が付加されていない場合は null

getDateHeader

long getDateHeader(java.lang.String name)
指定されたリクエストヘッダの値を Date オブジェクトを表す long 値として返します。 このメソッドは If-Modified-Since のような、日付を含むヘッダに対して使用して下さい。

返す日付は、1970年1月1日グリニッジ標準時 00:00:00.000 からの経過時間をミリ秒で表した数値です。

このリクエストが指定された名前のヘッダを持たない場合、-1 を返します。 指定されたヘッダが日付に変換できない場合、IllegalArgumentException をスローします。

パラメータ:
name - ヘッダ名を表す String
戻り値:
日付を表す long 値。 日付は、1970年1月1日グリニッジ標準時 00:00:00.000 からの経過時間をミリ秒で表した数値。 指定された名前を持つヘッダがこのリクエストに存在しない場合は -1。
例外:
java.lang.IllegalArgumentException - ヘッダの値を日付に変換できない場合

getHeader

java.lang.String getHeader(java.lang.String name)
指定されたリクエストヘッダの値を String として返します。 リクエストが指定された名前を持つヘッダを持たない場合は null を返します。 同じ名前で複数のヘッダがある場合は、リクエストの最初のヘッダを返します。 ヘッダ名は大文字小文字を区別しません。 あらゆるリクエストヘッダに関してこのメソッドを用いることができます。

パラメータ:
name - ヘッダ名を表す String
戻り値:
要求したヘッダの値を持つ String。 指定した名前を持つヘッダが存在しない場合は null

getHeaders

java.util.Enumeration getHeaders(java.lang.String name)
指定されたリクエストヘッダの全ての値を String オブジェクトの Enumeration として返します。

Accept-Language のようないくつかのヘッダは、カンマで区切られたリストの形式ではなく、異なる値を持ついくつかのヘッダとしてクライアントから送信されることがあります。

このリクエストが指定された名前を持つヘッダを持たない場合、空の Enumeration を返します。 ヘッダ名は大文字小文字を区別しません。 あらゆるリクエストヘッダに関してこのメソッドを用いることができます。

パラメータ:
name - ヘッダ名を表す String
戻り値:
リクエストヘッダの値を持つ Enumeration。 このリクエストが指定された名前のヘッダを持たない場合、空の Enumeration を返す。 コンテナがヘッダ情報へのアクセスを禁止している場合、null を返す

getHeaderNames

java.util.Enumeration getHeaderNames()
このリクエストに含まれる全てのヘッダ名の Enumeration を返します。 リクエストがヘッダを1つも持たない場合は空の Enumeration を返します。

ある種の Servlet コンテナは Servlet がこのメソッドを用いてヘッダにアクセスすることを禁じています。 その場合このメソッドは null を返します。

戻り値:
このリクエストとともに送信された全てのヘッダの名前の Enumeration。 リクエストがヘッダを持たない場合は空の Enumeration を返す。 Servlet がこのメソッドを用いることを Servlet コンテナが禁止している場合は null

getIntHeader

int getIntHeader(java.lang.String name)
指定されたリクエストヘッダの値を int 値として返します。 このリクエストが指定された名前のヘッダを持たない場合は -1 を返します。 ヘッダを整数に変換することができない場合は NumberFormatException をスローします。

ヘッダ名は大文字小文字を区別しません。

パラメータ:
name - リクエストヘッダ名を表す String
戻り値:
リクエストヘッダの値を表す整数。 指定された名前のヘッダをリクエストが持たない場合は -1。
例外:
java.lang.NumberFormatException - ヘッダの値を int に変換できなかった場合

getMethod

java.lang.String getMethod()
例えば GET、POST、PUT のような、このリクエストを生成した HTTP メソッドの名前を返します。 CGI 変数の REQUEST_METHOD の値と同じです。

戻り値:
このリクエストを生成したメソッドの名前を表す String

getPathInfo

java.lang.String getPathInfo()
このリクエストを生成した時にクライアントが URL に関連づけて送った拡張パス情報を返します。 拡張パス情報は Servlet のパスの後ろからクエリ文字列の前までの文字列で "/" で始まります。

拡張パス情報が存在しない場合は null を返します。

この値は CGI 変数の PATH_INFO の値を同じです。

戻り値:
Web コンテナによってデコードされた、拡張パス情報を表す String。 拡張パス情報とは、リクエストされた URL のうち、Servlet のパスの後ろからクエリ文字列の前までの文字列。 URL が拡張パス情報を持たない場合は null を返す。

getPathTranslated

java.lang.String getPathTranslated()
Servlet 名の後ろからクエリ文字列の前にある拡張パス情報を返しますが、実際のパスに変換してから返します。 CGI 変数の PATH_TRANSLATED の値と同じです。

URL が拡張パス情報を持たない場合は null を返します。 Servlet コンテナはどんな場合 (Web アプリケーションがアーカイブから作成される時など) でも仮想パスを実際のパスに変換することはできません。 Web コンテナはこの文字列をデコードしません。

戻り値:
実際のパスを表す String。 URL が拡張パス情報を持っていない場合は null を返す。

getContextPath

java.lang.String getContextPath()
リクエストされた URI のうち、リクエストのコンテキストを指す部分を返します。 コンテキストパスは通常リクエスト URI の最初に来ます。 コンテキストパスは "/" から始まりますが、"/" では終わりません。 デフォルト (ルート) のコンテキストに属する Servlet の場合、このメソッドは "" を返します。 コンテナはこの文字列をデコードしません。

戻り値:
リクエストされた URI のうち、リクエストのコンテキストを指す部分の String

getQueryString

java.lang.String getQueryString()
リクエストされた URL のパスの後ろに含まれているクエリ文字列を返します。 URL がクエリ文字列を持っていない場合は null を返します。 この値は CGI 変数の QUERY_STRING の値と同じです。

戻り値:
クエリ文字列を表す String。 URL がクエリ文字列を持たない場合は null を返します。 値はコンテナによってデコードされません。

getRemoteUser

java.lang.String getRemoteUser()
リクエストを生成したユーザが認証されている場合はそのユーザのログイン名を返します。 認証されていない場合は null を返します。 一連のそれぞれのリクエストとともにユーザ名が送信されるかどうかは、ブラウザと認証タイプに依存します。 この値は CGI 変数の REMOTE_USER と同じです。

戻り値:
このリクエストを生成したユーザのログイン名を表す String。 ユーザのログイン名が分からない場合は null を返します。

isUserInRole

boolean isUserInRole(java.lang.String role)
認証されているユーザが指定された論理的な「ロール」に含まれているかどうかを表す boolean を返します。 ロールとロールの構成メンバは配備記述子を用いて定義することができます。 ユーザが認証されていない場合は false を返します。

パラメータ:
role - ロール名を表す String
戻り値:
このリクエストを生成したユーザが指定されたロールに属するかどうかを表す boolean。 ユーザが認証されていない場合は false を返す。

getUserPrincipal

java.security.Principal getUserPrincipal()
現在の認証ユーザの名前を含む java.security.Principal オブジェクトを返します。 ユーザが認証されていない場合は null を返します。

戻り値:
このリクエストを生成したユーザの名前を含む java.security.Principal。 ユーザが認証されていない場合は null を返す。

getRequestedSessionId

java.lang.String getRequestedSessionId()
クライアントによって指定されたセッションの ID を返します。 この値はリクエストの現在の有効なセッションの ID と一致するとは限りません。 クライアントがセッション ID を指定しなかった場合、null を返します。

戻り値:
セッション ID を表す String。 リクエストがセッション ID を持ってない場合は null
関連項目:
isRequestedSessionIdValid()

getRequestURI

java.lang.String getRequestURI()
この HTTP リクエストの最初の行にある、リクエストの URL のうちプロトコル名からクエリ文字列までの部分を返します。 Web コンテナはこの文字列をデコードしません。
例:
HTTPリクエストの最初の行 返される値
POST /some/path.html HTTP/1.1/some/path.html
GET http://foo.bar/a.html HTTP/1.0 /a.html
HEAD /xyz?a=b HTTP/1.1/xyz

スキームとホストを用いてURLを再構築するためには HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest) を用いて下さい。

戻り値:
URL のうちプロトコル名からクエリ文字列までの部分を表す String
関連項目:
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

getRequestURL

java.lang.StringBuffer getRequestURL()
クライアントがこのリクエストを生成するのに使ったURLを再構築します。 返すURLはプロトコルとサーバ名とポート番号とサーバのパスを含みますが、クエリ文字列パラメータは含まれません。

このメソッドは文字列ではなく StringBuffer を返すので、例えばクエリパラメータを加えるなど、URL を簡単に変更することができます。

このメソッドはリダイレクトメッセージを生成したりエラーを報告したりするために役に立ちます。

戻り値:
再構築された URL を持つ StringBuffer

getServletPath

java.lang.String getServletPath()
このリクエストの URL のうち、Servlet を呼び出すための部分を返します。 このパスは "/" で始まり、Servlet の名前または Servlet へのパスのどちらかを含みますが、拡張パス情報やクエリ文字列は含まれません。 この値は CGI 変数の SCRIPT_NAME と同じ値です。

戻り値:
リクエストされた URL によって呼び出された Servlet の名前もしくはパスを含むものをデコードした String。 Servlet のリクエスト処理で "/*" パターンにマッチした場合は空の文字列。

getSession

HttpSession getSession(boolean create)
このリクエストに関連づけられている現在の HttpSession もしくは現在のセッションが存在せずかつ create が真である場合は新しいセッションを返します。

createfalse の時、リクエストが有効な HttpSession を持たない場合は null を返します。

セッションを確実に正しく維持するために、レスポンスがコミットされる前にこのメソッドを呼び出して下さい。 コンテナが Cookie を使ってセッションを維持している場合、レスポンスがコミットされる時に新しいセッションを生成するように指定されると IllegalStateException をスローします。

パラメータ:
create - 必要に応じてこのリクエストのために新しいセッションを生成する場合は true。 この値を false にすると、現在のセッションが存在しない場合に null を返す。
戻り値:
このリクエストに関連づけられている HttpSessioncreate の値が false である場合、リクエストが有効なセッションを持っていなければ null
関連項目:
getSession()

getSession

HttpSession getSession()
このリクエストに関連づけられている現在のセッションを返します。 リクエストがセッションを持たない場合はセッションを生成します。

戻り値:
このリクエストに関連づけられている HttpSession
関連項目:
getSession(boolean)

isRequestedSessionIdValid

boolean isRequestedSessionIdValid()
リクエストされたセッションの ID が未だに有効であるかどうかを調べます。

戻り値:
このリクエストが現在のセッションのコンテキストにおいて有効なセッションの ID を持っている場合は true を返し、そうでない場合は false を返します。
関連項目:
getRequestedSessionId(), getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

boolean isRequestedSessionIdFromCookie()
リクエストされたセッションの ID が Cookie として送られてきたのかどうかを調べます。

戻り値:
セッション ID が Cookie として送られてきた場合は true。 そうでない場合は false
関連項目:
getSession(boolean)

isRequestedSessionIdFromURL

boolean isRequestedSessionIdFromURL()
リクエストされたセッション ID がリクエストされた URL の一部分として送られてきたのかどうかを調べます。

戻り値:
セッション ID が URL の一部分として送られてきた場合は true。そうでない場合は false
関連項目:
getSession(boolean)

isRequestedSessionIdFromUrl

boolean isRequestedSessionIdFromUrl()
推奨されていません。 Java Servlet API のバージョン 2.1 以降では、代わりに isRequestedSessionIdFromURL() を使うようにして下さい。


Mergedoc
Translation

Copyright © 2000- The Apache Software Foundation. All rights Reserved.