メソッドの概要

返却値の型 メソッド名
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) static
CGI 環境変数データを取得します。
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 ヘッダを設定します。

メソッドの詳細

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