メソッドの概要
返却値の型 | メソッド名 |
---|---|
String | base () static WebサーバのベースURLを取得します。 |
String | current () static 現在処理中ページパスを取得します。 |
String | encodeRedirectURL (String url ) staticグローバル関数「redirect()」の中で使えるように、 指定されたURLをエンコードします。 |
String | encodeURL (String url ) static指定されたURLがセッションIDを含むようにエンコードします。 |
String | getContextPath () static リクエストされたURIのうち、 リクエストのコンテキストを指す部分を返します。 |
HTTPResponse | getHTTPResponse () static レスポンスオブジェクトを返します。 |
String | getProtocol () static リクエストのプロトコル名とバージョンを HTTP/1.1 のように プロトコル名/メジャーバージョン番号.マイナーバージョン番号 の形式で返します。 |
String | getRemoteAddr () static リクエストを送ってきたクライアントの IP(Internet Protocol) アドレスを返します。 |
String | getRemoteHost () static リクエストを送ってきたクライアントの FQDN(Fully Qualified Domain Name: 完全修飾ドメイン名)を返します。 |
Request | getRequest () static リクエストオブジェクトを返します。 |
String | getScheme () static 例えば http や https, ftp のようなリクエストのスキームを返します。 |
String | getServerName () static リクエストを受け取ったサーバのホスト名を返します。 |
Number | getServerPort () static このリクエストを受け取るのに使われたポート番号を返します。 |
String | getenv (String ref_name ) staticCGI 環境変数データを取得します。 |
String | host () static Webサーバ名を取得します。 |
Boolean | isSecure () static このリクエストが HTTPS のようなセキュアなチャネルを使って 送られたものかどうかを示す boolean を返します。 |
String | location () static リクエストURLを取得します。 |
Number | port () static WebサーバのHTTPポートを取得します。 |
String | protocol () static Webサーバのプロトコルを取得します。 |
String | referer () static リクエストを要求したページパスを取得します。 |
String | script () static Webサーバスクリプト名を取得します。 |
void | setHTTPResponseHeader (String name , String value ) staticHTTP ヘッダを設定します。 |
メソッドの詳細
String base ()
static
WebサーバのベースURLを取得します。
"http://server:port/path" を返却します。 この値は、設定ファイル(conf/server-context-config.xml)にベースURLが定義されている場合、その値を返却します。
返却値
|
String current ()
static
現在処理中ページパスを取得します。
返却値
|
String encodeRedirectURL (String url )
static
グローバル関数「redirect()」の中で使えるように、 指定されたURLをエンコードします。
エンコードが不要である場合は指定されたURLをそのまま返します。 このメソッドの実装はセッションIDを URLにエンコードするかどうかを決定するためのロジックを含みます。 このメソッドがencodeURLメソッドとは別になっているのは、 この決定をするための規則が通常のリンクをエンコードするかどうかを 決定する規則と異なることがあるからです。 グローバル関数「redirect()」に送られる全てのURLは このメソッドを通すべきです。 そうでなければ、Cookieをサポートしないブラウザでは URLの書き換えによるセッション管理を使用する事はできません。
パラメータ
返却値
|
String encodeURL (String url )
static
指定されたURLがセッションIDを含むようにエンコードします。
パラメータ
返却値
|
String getContextPath ()
static
リクエストされたURIのうち、 リクエストのコンテキストを指す部分を返します。
コンテキストパスは通常リクエストURIの最初に来ます。 コンテキストパスは "/" から始まりますが、"/" では終わりません。 デフォルト(ルート)のコンテキストに属するServletの場合、 このメソッドは "" を返します。 コンテナはこの文字列をデコードしません。
返却値
|
HTTPResponse getHTTPResponse ()
static
レスポンスオブジェクトを返します。
返却値
|
String getProtocol ()
static
リクエストのプロトコル名とバージョンを HTTP/1.1 のように プロトコル名/メジャーバージョン番号.マイナーバージョン番号 の形式で返します。
HTTP Servlet ではこのメソッドで取得できる値は CGI で使用する環境変数の SERVER_PROTOCOL と同等です。
返却値
|
String getRemoteAddr ()
static
リクエストを送ってきたクライアントの IP(Internet Protocol) アドレスを返します。
HTTP Servlet では CGI で使用される環境変数の REMOTE_ADDR と同等です。
返却値
|
String getRemoteHost ()
static
リクエストを送ってきたクライアントの FQDN(Fully Qualified Domain Name: 完全修飾ドメイン名)を返します。
コンテナがホスト名を解決できないか、 (パフォーマンスを上げるため)解決しないように設定されている場合は IP アドレスをピリオドで区切った形式にして返します。 HTTP Servlet では CGI で使用される環境変数の REMOTE_HOST と同等です。
返却値
|
Request getRequest ()
static
リクエストオブジェクトを返します。
返却値
|
String getScheme ()
static
例えば http や https, ftp のようなリクエストのスキームを返します。
RFC1738 で詳説されているように、スキームが違うと URL の形式も 違ってきます。
返却値
|
String getServerName ()
static
リクエストを受け取ったサーバのホスト名を返します。
HTTP Servlet では CGI で使用する環境変数の SERVER_NAME と同等です。
返却値
|
Number getServerPort ()
static
このリクエストを受け取るのに使われたポート番号を返します。
HTTP Servlet では CGI で使用される環境変数の SERVER_PORT と同等です。
返却値
|
String getenv (String ref_name )
static
CGI 環境変数データを取得します。
CGI環境変数引数を取得 指定キーに該当するCGI環境変数が存在しない場合は null
パラメータ
返却値
|
String host ()
static
Webサーバ名を取得します。
返却値
|
Boolean isSecure ()
static
このリクエストが HTTPS のようなセキュアなチャネルを使って 送られたものかどうかを示す boolean を返します。
返却値
|
String location ()
static
リクエストURLを取得します。
返却値
|
Number port ()
static
WebサーバのHTTPポートを取得します。
返却値
|
String protocol ()
static
Webサーバのプロトコルを取得します。
返却値
|
String referer ()
static
リクエストを要求したページパスを取得します。
返却値
|
String script ()
static
Webサーバスクリプト名を取得します。
返却値
|
void setHTTPResponseHeader (String name , String value )
static
HTTP ヘッダを設定します。
パラメータ
返却値
|