概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

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

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

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

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

バージョン:
$Version$
作成者:
Various

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

フィールドの詳細

BASIC_AUTH

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

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

FORM_AUTH

public static final String FORM_AUTH
基本認証のための識別文字列です。値は「FORM」です。

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

CLIENT_CERT_AUTH

public static final String CLIENT_CERT_AUTH
基本認証のための識別文字列です。値は「CLIENT_CERT」です。

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

DIGEST_AUTH

public static final String DIGEST_AUTH
基本認証のための識別文字列です。値は「DIGEST」です。

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

getAuthType

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

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

戻り値:
認証スキームを表す静的メンバBASIC_AUTH、FORM_AUTH、 CLIENT_CERT_AUTH、DIGEST_AUTHのいずれか。 （== 演算子で比較可能） リクエストが認証されていない場合は null

getCookies

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

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

getDateHeader

public long getDateHeader(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
例外:
IllegalArgumentException - ヘッダの値を日付に変換できない場合

getHeader

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

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

getHeaders

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

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

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

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

getHeaderNames

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

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

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

getIntHeader

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

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

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

getMethod

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

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

getPathInfo

public String getPathInfo()
このリクエストを生成した時にクライアントが URLに関連づけて送った拡張パス情報を返します。 拡張パス情報が存在しない場合はnullを返します。

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

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

getPathTranslated

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

URLが拡張パス情報を持たない場合はnullを返します。 Webコンテナはこの文字列をデコードしません。 （訳注：原文「The web container does not decode thins string.」 中のthins は this の typo？）

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

getContextPath

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

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

getQueryString

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

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

getRemoteUser

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

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

isUserInRole

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

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

getUserPrincipal

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

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

getRequestedSessionId

public String getRequestedSessionId()
クライアントによって指定されたセッションのIDを返します。 この値は使用中である実際のセッションのIDと一致するとは限りません。 例えば、古い（期限切れの）セッションのIDをリクエストが指定し、 サーバが新しいセッションを開始した場合、 このメソッドは新しいセッションのIDを返します。 リクエストがセッションIDを持っていない場合は nullを返します。

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

getRequestURI

public 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

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

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

This method is useful for creating redirect messages and for reporting errors.

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

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

getServletPath

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

戻り値:
リクエストされたURLによって指定された、 呼び出されたServletの名前もしくはパスを含む String。

getSession

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

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

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

戻り値:
このリクエストに関連づけられているHttpSession。 createの値がfalse である場合、リクエストが有効なセッションを持っていなければ null
関連項目:
getSession()

getSession

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

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

isRequestedSessionIdValid

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

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

isRequestedSessionIdFromCookie

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

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

isRequestedSessionIdFromURL

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

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

isRequestedSessionIdFromUrl

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

概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

このドキュメントは、Ja-Jakarta Project により翻訳されました。コメントがある場合は、jajakarta-report@jajakarta.good-day.netまでお願いします。

Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.