Web オブジェクト

Webクラス。
バージョン:1.0
導入されたバージョン:5.0

メソッドの概要
static String base()
WebサーバのベースURLを取得します。
static String current()
現在処理中ページパスを取得します。
static String encodeRedirectURL(String url)
sendRedirectメソッドの中で使えるように、 指定されたURLをエンコードします。
static String encodeURL(String url)
指定されたURLがセッションIDを含むようにエンコードします。
static String getContextPath()
リクエストされたURIのうち、 リクエストのコンテキストを指す部分を返します。
static HTTPResponse getHTTPResponse()
レスポンスオブジェクトを返します。
static String getHTTPResponseHeader(String name)
推奨されていません。代替えメソッドはありません。
static String getProtocol()
リクエストのプロトコル名とバージョンを HTTP/1.1 のように プロトコル名/メジャーバージョン番号.マイナーバージョン番号 の形式で返します。
static String getRemoteAddr()
リクエストを送ってきたクライアントの IP(Internet Protocol) アドレスを返します。
static String getRemoteHost()
リクエストを送ってきたクライアントの FQDN(Fully Qualified Domain Name: 完全修飾ドメイン名)を返します。
static String getScheme()
例えば http や https, ftp のようなリクエストのスキームを返します。
static String getServerName()
リクエストを受け取ったサーバのホスト名を返します。
static int getServerPort()
このリクエストを受け取るのに使われたポート番号を返します。
static String getenv(String ref_name)
CGI 環境変数データを取得します。
static String host()
Webサーバ名を取得します。
static Boolean isSecure()
このリクエストが HTTPS のようなセキュアなチャネルを使って 送られたものかどうかを示す boolean を返します。
static String location()
リクエストURLを取得します。
static int port()
WebサーバのHTTPポートを取得します。
static String protocol()
Webサーバのプロトコルを取得します。
static String referer()
リクエストを要求したページパスを取得します。
static String referrer()
推奨されていません。Web.refererに置き換えられました。
static String removeHTTPResponseHeader(String name)
推奨されていません。代替えメソッドはありません。
static String script()
Webサーバスクリプト名を取得します。
static void setHTTPResponseHeader(String name ,String value)
HTTP ヘッダを設定します。

メソッドの詳細
base

static String base()

WebサーバのベースURLを取得します。
"http://server:port/path" を返却します。
返却値
String ベースURL

current

static String current()

現在処理中ページパスを取得します。
返却値
String 処理中のページパス

encodeRedirectURL

static String encodeRedirectURL(String url)

sendRedirectメソッドの中で使えるように、 指定されたURLをエンコードします。
エンコードが不要である場合は指定されたURLをそのまま返します。 このメソッドの実装はセッションIDを URLにエンコードするかどうかを決定するためのロジックを含みます。
このメソッドがencodeURLメソッドとは別になっているのは、 この決定をするための規則が通常のリンクをエンコードするかどうかを 決定する規則と異なることがあるからです。
HttpServletResponse.sendRedirect メソッドに送られる全てのURLは このメソッドを通すべきです。
そうでなければ、Cookieをサポートしないブラウザでは URLリライティングの処理を行なうことができません。
パラメータ
url String エンコードするURL
返却値
String エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

encodeURL

static String encodeURL(String url)

指定されたURLがセッションIDを含むようにエンコードします。
パラメータ
url String エンコードするURL
返却値
String エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

getContextPath

static String getContextPath()

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

getHTTPResponse

static HTTPResponse getHTTPResponse()

レスポンスオブジェクトを返します。
返却値
HTTPResponse レスポンス

getHTTPResponseHeader

static String getHTTPResponseHeader(String name)

推奨されていません。代替えメソッドはありません。
HTTP ヘッダを取得します。
パラメータ
name String HTTPヘッダの名称(文字列)
返却値
String 常にnullを返します。

getProtocol

static String getProtocol()

リクエストのプロトコル名とバージョンを HTTP/1.1 のように プロトコル名/メジャーバージョン番号.マイナーバージョン番号 の形式で返します。
HTTP Servlet ではこのメソッドで取得できる値は CGI で使用する環境変数の SERVER_PROTOCOL と同等です。
返却値
String プロトコル名とバージョンを示す

getRemoteAddr

static String getRemoteAddr()

リクエストを送ってきたクライアントの IP(Internet Protocol) アドレスを返します。
HTTP Servlet では CGI で使用される環境変数の REMOTE_ADDR と同等です。
返却値
String リクエストを送ってきたクライアントの IP アドレスを示す文字列

getRemoteHost

static String getRemoteHost()

リクエストを送ってきたクライアントの FQDN(Fully Qualified Domain Name: 完全修飾ドメイン名)を返します。
コンテナがホスト名を解決できないか、 (パフォーマンスを上げるため)解決しないように設定されている場合は IP アドレスをピリオドで区切った形式にして返します。
HTTP Servlet では CGI で使用される環境変数の REMOTE_HOST と同等です。
返却値
String クライアントの FQDN(Fullu Qualified Domain Name) を示す String

getScheme

static String getScheme()

例えば http や https, ftp のようなリクエストのスキームを返します。
RFC1738 で詳説されているように、スキームが違うと URL の形式も 違ってきます。
返却値
String このリクエストに使われたスキームを示す文字列

getServerName

static String getServerName()

リクエストを受け取ったサーバのホスト名を返します。
HTTP Servlet では CGI で使用する環境変数の SERVER_NAME と同等です。
返却値
String リクエストが送り込まれたサーバの名前を示す

getServerPort

static int getServerPort()

このリクエストを受け取るのに使われたポート番号を返します。
HTTP Servlet では CGI で使用される環境変数の SERVER_PORT と同等です。
返却値
int ポート番号を示す整数値

getenv

static String getenv(String ref_name)

CGI 環境変数データを取得します。
CGI環境変数引数を取得
指定キーに該当するCGI環境変数が存在しない場合は null
パラメータ
ref_name String CGI 環境変数参照名称
返却値
String 環境変数データ

host

static String host()

Webサーバ名を取得します。
返却値
String Webサーバ名

isSecure

static Boolean isSecure()

このリクエストが HTTPS のようなセキュアなチャネルを使って 送られたものかどうかを示す boolean を返します。
返却値
Boolean リクエストがセキュアなチャネルを使って送られたものかどうかを示す boolean

location

static String location()

リクエストURLを取得します。
返却値
String リクエストURL

port

static int port()

WebサーバのHTTPポートを取得します。
返却値
int WebサーバのHTTP待ち受けポート

protocol

static String protocol()

Webサーバのプロトコルを取得します。
返却値
String Webサーバのプロトコル

referer

static String referer()

リクエストを要求したページパスを取得します。
返却値
String リクエストを要求したページパス

referrer

static String referrer()

推奨されていません。Web.refererに置き換えられました。
リクエストを要求したページパスを取得します。
返却値
String リクエストを要求したページパス

removeHTTPResponseHeader

static String removeHTTPResponseHeader(String name)

推奨されていません。代替えメソッドはありません。
HTTPヘッダ情報を削除します。
パラメータ
name String HTTPヘッダの名称(文字列)
返却値
String 常にnullを返します。

script

static String script()

Webサーバスクリプト名を取得します。
返却値
String Webスクリプトファイル名

setHTTPResponseHeader

static void setHTTPResponseHeader(String name ,String value)

HTTP ヘッダを設定します。
パラメータ
name String HTTPヘッダの名称(文字列)
value String 値(文字列)
返却値
void