intra-mart 6.1.14

jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter
インタフェース RequestParameter


public interface RequestParameter

1つのリクエストパラメータを保持するオブジェクトの共通インターフェース。

導入されたバージョン:
Version 5.0

メソッドの概要
 String getHeader(String name)
          指定のヘッダの値を返します。
 String[] getHeaderNames()
          ヘッダ名称一覧を返します。
 String getName()
          パラメータ名を返します。
 InputStream getNameAsStream()
          パラメータの名称を返します。
 String getValue()
          データ部を文字列表現として返します。
 Reader getValueAsReader()
          推奨されていません。 getValueAsReader(String) に置き換えられました。
 Reader getValueAsReader(String encoding)
          データ部を Reader として取得します。
 InputStream getValueAsStream()
          データ部を入力ストリームとして取得します。
 long getValueLength()
          データ部のバイト長を返します。
 boolean hasHeader(String name)
          指定された文字列がヘッダの名称かどうかを判定します。
 boolean hasHeaders()
          このオブジェクトがヘッダ情報を持つかどうかを判定します。
 

メソッドの詳細

getName

public String getName()
パラメータ名を返します。

GET の場合、各パラメータのパラメータ名を返します。
POST の場合、 フォームから送信された情報のうち、このエンティティが表す情報の もととなったフォーム中に定義されたコントロールの名称を返します。

戻り値:
パラメータ名

getNameAsStream

public InputStream getNameAsStream()
                            throws IOException
パラメータの名称を返します。

戻り値:
パラメータ名を含む入力ストリーム
例外:
IOException - 入出力エラー

getValue

public String getValue()
データ部を文字列表現として返します。

入力されたバイトデータから文字列への変換には、 リクエストの文字エンコーディング(javax.servlet.ServletRequest#getCharacterEncoding())を使います。

戻り値:
データ

getValueAsReader

public Reader getValueAsReader()
                        throws UnsupportedEncodingException,
                               IOException
推奨されていません。 getValueAsReader(String) に置き換えられました。

データ部を Reader として取得します。

文字コード変換には、 リクエストの文字エンコーディング(javax.servlet.ServletRequest#getCharacterEncoding())を使います。

戻り値:
データ
例外:
UnsupportedEncodingException
IOException

getValueAsReader

public Reader getValueAsReader(String encoding)
                        throws UnsupportedEncodingException,
                               IOException
データ部を Reader として取得します。

文字コード変換には、指定された文字エンコーディングを使います。

戻り値:
データ
例外:
UnsupportedEncodingException
IOException
導入されたバージョン:
6.1.12

getValueAsStream

public InputStream getValueAsStream()
                             throws IOException
データ部を入力ストリームとして取得します。

戻り値:
データ
例外:
IOException

getValueLength

public long getValueLength()
データ部のバイト長を返します。

戻り値:
データのサイズ

hasHeaders

public boolean hasHeaders()
このオブジェクトがヘッダ情報を持つかどうかを判定します。

戻り値:
ヘッダ情報を持つ場合 true

getHeaderNames

public String[] getHeaderNames()
ヘッダ名称一覧を返します。

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

戻り値:
ヘッダ名称

getHeader

public String getHeader(String name)
指定のヘッダの値を返します。

指定のヘッダ名がない場合や、ヘッダ自体がない場合は、 null を返します。

パラメータ:
name - ヘッダ名称
戻り値:
ヘッダ名称にマップされている値

hasHeader

public boolean hasHeader(String name)
指定された文字列がヘッダの名称かどうかを判定します。

パラメータ:
name - ヘッダ名称
戻り値:
ヘッダ名称が値にマップされている場合 true

intra-mart 6.1.14

Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.