RequestParameterオブジェクト

コンポーネント情報
version	8.0.24
since	5.0

コンポーネント概要

リクエストパラメータ情報オブジェクト。

リクエストパラメータの情報を保持します。

メソッドの概要

返却値の型	メソッド名
String	getFileName () アップロードされたファイルのファイル名を取得します。
Array	getHeaderNames () ヘッダ名称一覧を返します。
String	getHeader (String `name`) 指定のヘッダ名をもつ値を返します。
Number	getLength () データ長を返します。
String	getName () このオブジェクトのパラメータ名を取得します。
String	getValueAsStream () 非推奨現在のパラメータ値を返します。 RequestParameter#openValueAsBinary(Function callback), RequestParameter#openValueAsText(Function callback, String charsetName) を使用してください。
String	getValue () 現在のパラメータ値を返します。
ByteReader	openValueAsBinary (Function `[callback]`) 現在のパラメータ値をバイナリストリームで返します。
TextReader	openValueAsText (Function `[callback]`, String `[charsetName]`) 現在のパラメータ値をテキストストリームで返します。

メソッドの詳細

String getFileName ()

アップロードされたファイルのファイル名を取得します。

ファイルアップロードをしたリクエストではない場合は、null を返します。

Content-Disposition: form-data; name="ctrl_name"; filename="file_path"
ヘッダは、上記のような形式で受け取れる
ctrl_name: <INPUT type="file"> の name 属性
file_path: クライアントでのファイル名
ヘッダ情報は他にもあるが、上記の行のみを対象に解析を行う

返却値

String: String ファイル名

Array getHeaderNames ()

ヘッダ名称一覧を返します。

このエンティティのもつヘッダ情報の名称一覧を返します。
ヘッダ情報がない場合、このメソッドは null を返します。

返却値

Array: Array ヘッダ名称の配列

String getHeader (String name)

指定のヘッダ名をもつ値を返します。

パラメータ

name : String: ヘッダ名

返却値

String: String ヘッダの値

Number getLength ()

データ長を返します。

返却値

Number: Number データ長（単位はバイト）

String getName ()

このオブジェクトのパラメータ名を取得します。

返却値

String: String パラメータ名

String getValueAsStream () 非推奨

RequestParameter#openValueAsBinary(Function callback), RequestParameter#openValueAsText(Function callback, String charsetName) を使用してください。

現在のパラメータ値を返します。

パラメータ値は、文字コード変換されません。
パラメータ値の各バイトがそれぞれ String の１文字に対応します。
つまり、パラメータ値のバイト数は、そのまま String の文字数に等しくなります。

返却値

String: String パラメータ値

String getValue ()

現在のパラメータ値を返します。

パラメータ値は、リクエストの文字エンコーディングから文字コード変換されています。

返却値

String: String パラメータ値

ByteReader openValueAsBinary (Function [callback])

現在のパラメータ値をバイナリストリームで返します。

パラメータ値は、文字コード変換されません。
パラメータ値の各バイトがそれぞれ String の１文字に対応します。
つまり、パラメータ値のバイト数は、そのまま String の文字数に等しくなります。
このメソッドはファイルアップロード時に使用されることを想定しています。

パラメータ

[callback] : Function: ByteReaderとエラー情報を受け取るコールバック関数

返却値

ByteReader: ByteReader パラメータ値

TextReader openValueAsText (Function [callback], String [charsetName])

現在のパラメータ値をテキストストリームで返します。

パラメータ値は、指定された文字コードに変換されます。
パラメータ値の各バイトがそれぞれ String の１文字に対応します。
つまり、パラメータ値のバイト数は、そのまま String の文字数に等しくなります。

パラメータ

[callback] : Function: TextReaderとエラー情報を受け取るコールバック関数

[charsetName] : String: エンコーディング名

返却値

TextReader: TextReader パラメータ値