メソッドの概要

返却値の型 メソッド名
Array getAttributeNames ()
このリクエストで利用可能な属性名を含む配列型のオブジェクトを返します。
Object getAttribute (String name)
指定された名前の属性値を返します。
Number getContentLength ()
リクエストコンテンツの長さを取得します。
String getContentType ()
リクエストコンテンツタイプを取得します。
Array getCookieNames ()
すべてのクッキーの名前の配列を返します。
String getCookie (String name)
指定の名前を持つクッキーの値を返します。
Array getCookies (String name)
指定の名前を持つすべてのクッキーの値の配列を返します。
Array getHeaderNames ()
このリクエストに含まれる全てのヘッダ名の配列を返します。
String getHeader (String name)
指定されたリクエストヘッダの値をStringとして返します。
Array getHeaders (String name)
指定されたリクエストヘッダの全ての値をStringの配列として返します。
String getMessageBodyAsStream ()
メッセージボディに含まれているバイナリデータをStringとして返します。
String getMessageBodyAsString ()
メッセージボディに含まれているデータをStringとして返します。
String getMessageBody (String enc)
メッセージボディに含まれているバイナリデータをStringとして返します。
String getMethod ()
このリクエストを生成したHTTPメソッドの名前を返します。
Array getParameterNames ()
すべてのリクエストパラメータ名を返します。
String getParameterValue (String key)
指定のキーに該当する URL 引数データを返却します。
Array getParameterValues (String key)
指定のキーに該当する URL 引数データ群を返却します。
RequestParameter getParameter (String name)
指定されたパラメータの値をRequestParameterオブジェクトとして返します。
Array getParameters (String name)
指定されたパラメータのすべての値が格納された配列を返します。
String getQueryString ()
リクエストされたURLのパスの後ろに含まれているクエリ文字列を返します。
Array get (String key) 非推奨
指定のキーに該当する URL 引数データ群を返却します。
Request.getParameterValues()に置き換えられました。
ByteReader openMessageBodyAsBinary (Function [callback])
メッセージボディに含まれているバイナリデータを ByteReader として返します。
TextReader openMessageBodyAsText (Function [callback], String [enc])
メッセージボディに含まれているデータを TextReader として返します。
String query () 非推奨
URL 引数文字列の取得します。
Request.getMessageBodyAsStream()およびgetQueryString()に置き換えられました。
void removeAttribute (String name)
このリクエストから属性を削除します。
void setAttribute (String name, Object object)
このリクエストに属性をセットします。

メソッドの詳細

Array getAttributeNames ()
このリクエストで利用可能な属性名を含む配列型のオブジェクトを返します。

返却値
Array
Array リクエストに付随する属性名を含む文字列からなる配列
Object getAttribute (String name)
指定された名前の属性値を返します。

指定された名前が存在しない場合は、null を返します。
パラメータ
name : String
属性の名前を指定する String
返却値
Object
Object 属性の値が含まれている Object。 指定された名前の属性が無い場合は null
Number getContentLength ()
リクエストコンテンツの長さを取得します。

リクエストのメッセージボディ、あるいは、入力ストリームから読み込めるバイト長を返しますが、長さがわからない場合は -1 を返します。
HTTP Servlet では CGI 環境変数 CONTENT_LENGTH の値に相当します。
返却値
Number
Number リクエストのメッセージボディの長さを表す整数値
String getContentType ()
リクエストコンテンツタイプを取得します。

リクエストに含まれるメッセージボディの MIME タイプを返しますが、タイプがわからない場合は null を返します。
HTTP Servlet では CGI 環境変数の CONTENT_TYPE の値に相当します。
返却値
String
String リクエストの MIME タイプの名前を含む String
Array getCookieNames ()
すべてのクッキーの名前の配列を返します。

クッキーが一つも存在しない場合、空の配列を返します。
リクエストに Cookie が付加されていない場合は null を返します。
返却値
Array
Array 指定された名前をもつ値の配列
String getCookie (String name)
指定の名前を持つクッキーの値を返します。

指定の名前を持つクッキーの値が複数あった場合、その中のどれかが返されます。
指定の名前をもつクッキーの値が存在しない場合、nullを返します。
リクエストに Cookie が付加されていない場合も null を返します。
パラメータ
name : String
クッキーの名前を表すString
返却値
String
String 指定された名前をもつ値を表すString
Array getCookies (String name)
指定の名前を持つすべてのクッキーの値の配列を返します。

指定の名前をもつクッキーの値が存在しない場合、空の配列を返します。
リクエストに Cookie が付加されていない場合は null を返します。
パラメータ
name : String
クッキーの名前を表すString
返却値
Array
Array 指定された名前をもつ値の配列
Array getHeaderNames ()
このリクエストに含まれる全てのヘッダ名の配列を返します。

リクエストがヘッダを1つも持たない場合は空の配列を返します。
Servletがこのメソッドを用いることを Servletコンテナが禁止している場合はnullを返却します。
返却値
Array
Array このリクエストとともに送信された全てのヘッダの名前の配列
String getHeader (String name)
指定されたリクエストヘッダの値をStringとして返します。

指定した名前を持つヘッダが複数ある場合は、先頭のヘッダを返却します。
指定した名前を持つヘッダが存在しない場合はnullを返却します。
パラメータ
name : String
ヘッダ名を表すString
返却値
String
String 要求したヘッダの値を持つString
Array getHeaders (String name)
指定されたリクエストヘッダの全ての値をStringの配列として返します。

このリクエストが指定された名前のヘッダを持たない場合、 空の配列を返します。
コンテナがヘッダ情報へのアクセスを禁止している場合、 nullを返します。
パラメータ
name : String
ヘッダ名を表すString
返却値
Array
Array リクエストヘッダの値を持つ配列
String getMessageBodyAsStream ()
メッセージボディに含まれているバイナリデータをStringとして返します。

文字コード変換されません。バイナリデータ1バイトが1文字となります。
返却値
String
String メッセージボディ部を表すString
String getMessageBodyAsString ()
メッセージボディに含まれているデータをStringとして返します。

データは、ServletRequest のエンコーディング名によって Unicode に変換します。
返却値
String
String メッセージボディ部を表すString
String getMessageBody (String enc)
メッセージボディに含まれているバイナリデータをStringとして返します。

返されるデータは、指定の文字エンコーディング名によってUnicode に変換されています。
パラメータ
enc : String
エンコーディング名
返却値
String
String メッセージボディ部を表すString
String getMethod ()
このリクエストを生成したHTTPメソッドの名前を返します。

例えばGET、POST、PUTのような、HTTPメソッドの名前です。
返却値
String
String このリクエストを生成したメソッドの名前を表すString
Array getParameterNames ()
すべてのリクエストパラメータ名を返します。

配列の各要素は、パラメータ名を表す String です。
返却値
Array
Array パラメータ名の配列
String getParameterValue (String key)
指定のキーに該当する URL 引数データを返却します。

キーは、フォームのコントロール名称(name 属性)を指定します。
返却値は指定キーに該当するデータ(文字列)です。
該当するデータが配列の場合は、先頭のデータを返却します。
指定キーに該当する URL 引数が1つも存在しない場合はnullを返却します。
パラメータ
key : String
URL 引数設定名称
返却値
String
String URL 引数データ
Array getParameterValues (String key)
指定のキーに該当する URL 引数データ群を返却します。

キーは、フォームのコントロール名称(name 属性)を指定します。
返却値は指定キーに該当するデータ(文字列)の個数と同等の要素を持つ配列です。
指定キーに該当する URL 引数が1つも存在しない場合は空の配列を返却します。
パラメータ
key : String
URL 引数設定名称
返却値
Array
Array URL 引数データの配列
RequestParameter getParameter (String name)
指定されたパラメータの値をRequestParameterオブジェクトとして返します。
パラメータが存在しない場合は、null を返します。

パラメータに 1 つの値のみが含まれていることが確実な場合にのみ、このメソッドを使用してください。 パラメータに複数の値が含まれている可能性がある場合は、 request.getParameters(String name)を使用します。

複数の値を持つパラメータに対してこのメソッドを使用した場合、返される値は、getParameters で返される配列内の最初の値と同じです。
パラメータ
name : String
パラメータ名
返却値
RequestParameter
RequestParameter パラメータ情報をもつオブジェクト
Array getParameters (String name)
指定されたパラメータのすべての値が格納された配列を返します。
配列の要素は、RequestParameter#オブジェクトです。 パラメータが存在しない場合は、空の配列を返却します。

パラメータの値が 1 つのみである場合、配列の長さは 1 です。
パラメータ
name : String
パラメータ名
返却値
Array
Array パラメータの値が格納されたRequestParameter#オブジェクトの配列
String getQueryString ()
リクエストされたURLのパスの後ろに含まれているクエリ文字列を返します。

URLがクエリ文字列を持っていない場合はnullを返します。
値はコンテナによってデコードされません。
この値はCGI変数のQUERY_STRINGの値と同じです。
返却値
String
String クエリ文字列を表すString
Array get (String key) 非推奨
Request.getParameterValues()に置き換えられました。
指定のキーに該当する URL 引数データ群を返却します。

キーは、フォームのコントロール名称(name 属性)を指定します。
返却値は指定キーに該当するデータ(文字列)の個数と同等の要素を持つ配列です。
指定キーに該当する URL 引数が1つも存在しない場合は空の配列を返却します。
パラメータ
key : String
URL 引数設定名称
返却値
Array
Array URL 引数データの配列
ByteReader openMessageBodyAsBinary (Function [callback])
メッセージボディに含まれているバイナリデータを ByteReader として返します。

文字コード変換されません。バイナリデータ1バイトが1文字となります。
パラメータ
[callback] : Function
ByteReaderとエラー情報を受け取るコールバック関数
返却値
ByteReader
ByteReader メッセージボディ部を表すByteReader
TextReader openMessageBodyAsText (Function [callback], String [enc])
メッセージボディに含まれているデータを TextReader として返します。

返されるデータは、指定の文字エンコーディング名によってUnicode に変換されています。
パラメータ
[callback] : Function
TextReaderとエラー情報を受け取るコールバック関数
[enc] : String
エンコーディング名
返却値
TextReader
TextReader メッセージボディ部を表すTextReader
String query () 非推奨
Request.getMessageBodyAsStream()およびgetQueryString()に置き換えられました。
URL 引数文字列の取得します。

返却値はクライアントより受信した状態の URL 引数文字列です。
POST or GET どちらのリクエストでも引数を受け取る事が可能です
返却値
String
String クライアントから受け取った URL 引数文字列
void removeAttribute (String name)
このリクエストから属性を削除します。

属性はリクエストがコンテナ内で処理されている間だけ維持されるにすぎないので、 通常、このメソッドは必要ありません。
パラメータ
name : String
削除する属性の名前を示す String
返却値
void
void setAttribute (String name, Object object)
このリクエストに属性をセットします。

パラメータ
name : String
属性名を示す String
object : Object
セットするObject
返却値
void