|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface HttpServletRequest
HTTP Servlet のためのリクエスト情報を与えるために ServletRequest
インタフェースを拡張します。
Servlet コンテナは HttpServletRequest
オブジェクトを生成し、Servlet のサービスメソッド (doGet
、doPost
等) に引数で渡します。
フィールドの概要 | |
---|---|
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 を返します。 |
フィールドの詳細 |
---|
static final java.lang.String BASIC_AUTH
static final java.lang.String FORM_AUTH
static final java.lang.String CLIENT_CERT_AUTH
static final java.lang.String DIGEST_AUTH
メソッドの詳細 |
---|
java.lang.String getAuthType()
null
を返します。
この値は CGI 変数の AUTH_TYPE と同じ値です。
null
Cookie[] getCookies()
Cookie
オブジェクトの配列を返します。
Cookie が送られていない場合は null
を返します。
Cookie
の配列。
リクエストに Cookie が付加されていない場合は null
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
- ヘッダの値を日付に変換できない場合java.lang.String getHeader(java.lang.String name)
String
として返します。
リクエストが指定された名前を持つヘッダを持たない場合は null
を返します。
同じ名前で複数のヘッダがある場合は、リクエストの最初のヘッダを返します。
ヘッダ名は大文字小文字を区別しません。
あらゆるリクエストヘッダに関してこのメソッドを用いることができます。
name
- ヘッダ名を表す String
String
。
指定した名前を持つヘッダが存在しない場合は null
java.util.Enumeration getHeaders(java.lang.String name)
String
オブジェクトの Enumeration
として返します。
Accept-Language
のようないくつかのヘッダは、カンマで区切られたリストの形式ではなく、異なる値を持ついくつかのヘッダとしてクライアントから送信されることがあります。
このリクエストが指定された名前を持つヘッダを持たない場合、空の Enumeration
を返します。
ヘッダ名は大文字小文字を区別しません。
あらゆるリクエストヘッダに関してこのメソッドを用いることができます。
name
- ヘッダ名を表す String
Enumeration
。
このリクエストが指定された名前のヘッダを持たない場合、空の Enumeration を返す。
コンテナがヘッダ情報へのアクセスを禁止している場合、null を返すjava.util.Enumeration getHeaderNames()
ある種の Servlet コンテナは Servlet がこのメソッドを用いてヘッダにアクセスすることを禁じています。
その場合このメソッドは null
を返します。
null
int getIntHeader(java.lang.String name)
int
値として返します。
このリクエストが指定された名前のヘッダを持たない場合は -1 を返します。
ヘッダを整数に変換することができない場合は NumberFormatException
をスローします。
ヘッダ名は大文字小文字を区別しません。
name
- リクエストヘッダ名を表す String
java.lang.NumberFormatException
- ヘッダの値を int
に変換できなかった場合java.lang.String getMethod()
String
java.lang.String getPathInfo()
拡張パス情報が存在しない場合は null
を返します。
この値は CGI 変数の PATH_INFO の値を同じです。
String
。
拡張パス情報とは、リクエストされた URL のうち、Servlet のパスの後ろからクエリ文字列の前までの文字列。
URL が拡張パス情報を持たない場合は null
を返す。java.lang.String getPathTranslated()
URL が拡張パス情報を持たない場合は null
を返します。
Servlet コンテナはどんな場合 (Web アプリケーションがアーカイブから作成される時など) でも仮想パスを実際のパスに変換することはできません。
Web コンテナはこの文字列をデコードしません。
String
。
URL が拡張パス情報を持っていない場合は null
を返す。java.lang.String getContextPath()
String
java.lang.String getQueryString()
null
を返します。
この値は CGI 変数の QUERY_STRING の値と同じです。
String
。
URL がクエリ文字列を持たない場合は null
を返します。
値はコンテナによってデコードされません。java.lang.String getRemoteUser()
null
を返します。
一連のそれぞれのリクエストとともにユーザ名が送信されるかどうかは、ブラウザと認証タイプに依存します。
この値は CGI 変数の REMOTE_USER と同じです。
String
。
ユーザのログイン名が分からない場合は null
を返します。boolean isUserInRole(java.lang.String role)
false
を返します。
role
- ロール名を表す String
boolean
。
ユーザが認証されていない場合は false
を返す。java.security.Principal getUserPrincipal()
java.security.Principal
オブジェクトを返します。
ユーザが認証されていない場合は null
を返します。
java.security.Principal
。
ユーザが認証されていない場合は null
を返す。java.lang.String getRequestedSessionId()
null
を返します。
String
。
リクエストがセッション ID を持ってない場合は null
isRequestedSessionIdValid()
java.lang.String getRequestURI()
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)
を用いて下さい。
String
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
java.lang.StringBuffer getRequestURL()
このメソッドは文字列ではなく StringBuffer
を返すので、例えばクエリパラメータを加えるなど、URL を簡単に変更することができます。
このメソッドはリダイレクトメッセージを生成したりエラーを報告したりするために役に立ちます。
StringBuffer
java.lang.String getServletPath()
String
。
Servlet のリクエスト処理で "/*" パターンにマッチした場合は空の文字列。HttpSession getSession(boolean create)
HttpSession
もしくは現在のセッションが存在せずかつ create
が真である場合は新しいセッションを返します。
create
が false
の時、リクエストが有効な HttpSession
を持たない場合は null
を返します。
セッションを確実に正しく維持するために、レスポンスがコミットされる前にこのメソッドを呼び出して下さい。 コンテナが Cookie を使ってセッションを維持している場合、レスポンスがコミットされる時に新しいセッションを生成するように指定されると IllegalStateException をスローします。
create
- 必要に応じてこのリクエストのために新しいセッションを生成する場合は true
。
この値を false
にすると、現在のセッションが存在しない場合に null
を返す。
HttpSession
。
create
の値が false
である場合、リクエストが有効なセッションを持っていなければ null
。getSession()
HttpSession getSession()
HttpSession
getSession(boolean)
boolean isRequestedSessionIdValid()
true
を返し、そうでない場合は false
を返します。getRequestedSessionId()
,
getSession(boolean)
,
HttpSessionContext
boolean isRequestedSessionIdFromCookie()
true
。
そうでない場合は false
。getSession(boolean)
boolean isRequestedSessionIdFromURL()
true
。そうでない場合は false
。getSession(boolean)
boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromURL()
を使うようにして下さい。
|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |