概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

wisdom.core.request
クラス ParameterParser

java.lang.Object
  拡張wisdom.core.CoreObject
      拡張wisdom.core.request.ParameterParser
すべての実装インタフェース:
IRequestParser
直系の既知のサブクラス:
MultiPartParameterParser
public class ParameterParser
extends CoreObject
implements IRequestParser

IRequestParserの実装クラス
このクラスは通常のHttpServletRequestを解析します。セッション情報へアクセスした場合、 UnsupportedExceptionが送出されます。
2004/10/29 WA0028対応 2005/5/24 WA0037の対応 2005/9/12 WA0041の対応

バージョン:
1.0
作成者:
Takao Kouda

フィールドの概要
static java.lang.String REQUEST_PARAMETER_ENCODEING
           
 
インタフェース wisdom.core.application.IRequestParser から継承したフィールド
ATTRIBUTE, ATTRIBUTE_NAME, BASIC, COMMAND, HEADER, PARAMETER
 
コンストラクタの概要
ParameterParser(javax.servlet.http.HttpServletRequest req)
          コンストラクタ
 
メソッドの概要
 java.lang.Object getAttribute(java.lang.String key)
          内包しているHttpServletRequestに設定された属性を取得します。
 java.lang.Object getAttribute(java.lang.String key, boolean allowNull)
          内包しているHttpServletRequestに設定された属性を取得します。
 RequestCommand getCommand()
          このRequestParserを実行したコマンドクラスを取得します。
 java.lang.String getCommandName()
          このRequestParserを実行したコマンドクラス名を取得します。
 java.lang.String getContextPath()
          ContextPathを取得します。
 double getDouble(java.lang.String name)
          double型のパラメータを取得する
 double getDouble(java.lang.String name, double def)
          double型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。
 java.lang.String getHeader(java.lang.String key)
          内包しているHttpServletRequestに設定されたヘッダー情報を取得します。
 java.lang.String getHeader(java.lang.String key, boolean allowNull)
          内包しているHttpServletRequestに設定されたヘッダー情報を取得します。
 int getInt(java.lang.String name)
          int型のパラメータを取得する
 int getInt(java.lang.String name, int def)
          int型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。
 java.util.Iterator getParameterNames()
          HttpServletRequestのパラメータ名の一覧を返します。
 Part getPart(java.lang.String name)
          Partのパラメータを取得する
 java.util.List getPartArray(java.lang.String name)
          Partのパラメータを取得する
static java.lang.String getPassword(javax.servlet.http.HttpServletRequest req, int type, boolean encode)
          HTTP BASIC認証のパスワードを取得する。
 java.lang.String getReqId()
          reqidを取得します
 javax.servlet.http.HttpServletRequest getRequest()
          HttpServletRequestのインスタンスを取得します。
 java.lang.String getString(java.lang.String name)
          String型のパラメータを取得します
戻り値はString#trim()が行われます。
 java.lang.String getString(java.lang.String name, java.lang.String def)
          String型のパラメータを取得します
値がない場合、defの値が戻され、値がある場合、戻り値はString#trim()が行われます。
 java.lang.String[] getStringArray(java.lang.String name)
          String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、長さ0のStringオブジェクトを含んだ配列を戻します。
 java.lang.String[] getStringArrayWithNull(java.lang.String name)
          String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、nullオブジェクトを戻します。
 java.lang.String getStringNoTrim(java.lang.String name)
          String型のパラメータを取得します
 java.lang.String getStringNoTrim(java.lang.String name, java.lang.String def)
          String型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。
static java.lang.String getUserId(javax.servlet.http.HttpServletRequest req, int type)
          HTTP BASIC認証のユーザーIDを取得する。
 java.lang.String parse()
          HttpServletRequestの内容を文字で返します。
 java.lang.String parse(int type)
          HttpServletRequestの内容を文字で返します。
 void setReqId(java.lang.String reqId)
           
 
クラス java.lang.Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

REQUEST_PARAMETER_ENCODEING

public static final java.lang.String REQUEST_PARAMETER_ENCODEING
関連項目:
定数フィールド値
コンストラクタの詳細

ParameterParser

public ParameterParser(javax.servlet.http.HttpServletRequest req)
コンストラクタ

パラメータ:
req - 解析するHttpServletRequestオブジェクト
メソッドの詳細

getString

public java.lang.String getString(java.lang.String name)
                           throws ParameterNotFoundException
インタフェース IRequestParser の記述:
String型のパラメータを取得します
戻り値はString#trim()が行われます。

定義:
インタフェース IRequestParser 内の getString
パラメータ:
name - 取得するパラメータ名
戻り値:
String型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String def)
インタフェース IRequestParser の記述:
String型のパラメータを取得します
値がない場合、defの値が戻され、値がある場合、戻り値はString#trim()が行われます。

定義:
インタフェース IRequestParser 内の getString
パラメータ:
name - 取得するパラメータ名
def - 取得できなかった場合の省略値
戻り値:
String型で取得された値

getStringNoTrim

public java.lang.String getStringNoTrim(java.lang.String name)
                                 throws ParameterNotFoundException
インタフェース IRequestParser の記述:
String型のパラメータを取得します

定義:
インタフェース IRequestParser 内の getStringNoTrim
パラメータ:
name - 取得するパラメータ名
戻り値:
String型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getStringNoTrim

public java.lang.String getStringNoTrim(java.lang.String name,
                                        java.lang.String def)
インタフェース IRequestParser の記述:
String型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。
取得できたパラメータ値は左右の空白は削除されません。

定義:
インタフェース IRequestParser 内の getStringNoTrim
パラメータ:
name - 取得するパラメータ名
def - 取得できなかった場合の省略値
戻り値:
String型で取得された値

getInt

public int getInt(java.lang.String name)
           throws ParameterNotFoundException,
                  java.lang.NumberFormatException
インタフェース IRequestParser の記述:
int型のパラメータを取得する

定義:
インタフェース IRequestParser 内の getInt
パラメータ:
name - 取得するパラメータ名
戻り値:
int型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合
java.lang.NumberFormatException

getInt

public int getInt(java.lang.String name,
                  int def)
インタフェース IRequestParser の記述:
int型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。

定義:
インタフェース IRequestParser 内の getInt
パラメータ:
name - 取得するパラメータ名
def - 取得できなかった場合の省略値
戻り値:
int型で取得された値

getDouble

public double getDouble(java.lang.String name)
                 throws ParameterNotFoundException,
                        java.lang.NumberFormatException
インタフェース IRequestParser の記述:
double型のパラメータを取得する

定義:
インタフェース IRequestParser 内の getDouble
パラメータ:
name - 取得するパラメータ名
戻り値:
doubleg型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合
java.lang.NumberFormatException

getDouble

public double getDouble(java.lang.String name,
                        double def)
インタフェース IRequestParser の記述:
double型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。

定義:
インタフェース IRequestParser 内の getDouble
パラメータ:
name - 取得するパラメータ名
def - double 取得できなかった場合の省略値
戻り値:
double型で取得された値

getPart

public Part getPart(java.lang.String name)
             throws ParameterNotFoundException
インタフェース IRequestParser の記述:
Partのパラメータを取得する

定義:
インタフェース IRequestParser 内の getPart
パラメータ:
name - 取得するパラメータ名
戻り値:
Part型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getPartArray

public java.util.List getPartArray(java.lang.String name)
                            throws ParameterNotFoundException
インタフェース IRequestParser の記述:
Partのパラメータを取得する

定義:
インタフェース IRequestParser 内の getPartArray
パラメータ:
name - 取得するパラメータ名
戻り値:
Part型の配列（Liist）で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getStringArray

public java.lang.String[] getStringArray(java.lang.String name)
                                  throws ParameterNotFoundException
インタフェース IRequestParser の記述:
String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、長さ0のStringオブジェクトを含んだ配列を戻します。

定義:
インタフェース IRequestParser 内の getStringArray
パラメータ:
name - 取得するパラメータ名
戻り値:
Stringの配列型で取得された値
例外:
ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getStringArrayWithNull

public java.lang.String[] getStringArrayWithNull(java.lang.String name)
インタフェース IRequestParser の記述:
String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、nullオブジェクトを戻します。

定義:
インタフェース IRequestParser 内の getStringArrayWithNull
パラメータ:
name - 取得するパラメータ名
戻り値:
Stringの配列型で取得された値

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
インタフェース IRequestParser の記述:
HttpServletRequestのインスタンスを取得します。

定義:
インタフェース IRequestParser 内の getRequest
戻り値:
HttpServletRequest HttpServletRequest

getContextPath

public java.lang.String getContextPath()
インタフェース IRequestParser の記述:
ContextPathを取得します。

定義:
インタフェース IRequestParser 内の getContextPath
戻り値:
String ContextPath

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
                              throws AttributeNotFoundException
インタフェース IRequestParser の記述:
内包しているHttpServletRequestに設定された属性を取得します。

定義:
インタフェース IRequestParser 内の getAttribute
パラメータ:
key - 属性を取得するキー
戻り値:
Object HttpServletRequest
例外:
AttributeNotFoundException - 指定された属性がnullの場合

getHeader

public java.lang.String getHeader(java.lang.String key)
                           throws AttributeNotFoundException
インタフェース IRequestParser の記述:
内包しているHttpServletRequestに設定されたヘッダー情報を取得します。

定義:
インタフェース IRequestParser 内の getHeader
パラメータ:
key - ヘッダー情報を取得するキー
戻り値:
String HttpServletRequest
例外:
AttributeNotFoundException - 指定された属性がnullの場合

getAttribute

public java.lang.Object getAttribute(java.lang.String key,
                                     boolean allowNull)
                              throws AttributeNotFoundException
インタフェース IRequestParser の記述:
内包しているHttpServletRequestに設定された属性を取得します。

定義:
インタフェース IRequestParser 内の getAttribute
パラメータ:
key - 属性を取得するキー
allowNull - trueの場合は戻り値がnullを許します。
戻り値:
Object HttpServletRequest
例外:
AttributeNotFoundException - 指定された属性がnullの場合

getHeader

public java.lang.String getHeader(java.lang.String key,
                                  boolean allowNull)
                           throws AttributeNotFoundException
インタフェース IRequestParser の記述:
内包しているHttpServletRequestに設定されたヘッダー情報を取得します。

定義:
インタフェース IRequestParser 内の getHeader
パラメータ:
key - ヘッダー情報を取得するキー
allowNull - trueの場合は戻り値がnullを許します。
戻り値:
String HttpServletRequest
例外:
AttributeNotFoundException - 指定された属性がnullの場合

getUserId

public static java.lang.String getUserId(javax.servlet.http.HttpServletRequest req,
                                         int type)
HTTP BASIC認証のユーザーIDを取得する。<>

パラメータ:
req - 解析するHttpServletRequestオブジェクト
type - 認証タイプ
戻り値:
String 解析されたユーザーID。この値はBase64からデコードされた値です。

getPassword

public static java.lang.String getPassword(javax.servlet.http.HttpServletRequest req,
                                           int type,
                                           boolean encode)
HTTP BASIC認証のパスワードを取得する。

パラメータ:
req - 解析するHttpServletRequestオブジェクト
type - 認証タイプ
encode - trueの場合はBase64からデコードされた値、falseの場合はBase64でエンコードされたまま戻します。
戻り値:
String 解析されたパスワード

parse

public java.lang.String parse()
インタフェース IRequestParser の記述:
HttpServletRequestの内容を文字で返します。

定義:
インタフェース IRequestParser 内の parse
戻り値:
String HttpServletRequestの内容

parse

public java.lang.String parse(int type)
インタフェース IRequestParser の記述:
HttpServletRequestの内容を文字で返します。

定義:
インタフェース IRequestParser 内の parse
パラメータ:
type - ParameterParser.PARAMETER HttpServletRequestに含まれるパラメータ。
ParameterParser.ATTRIBUTE HttpServletRequestに含まれる属性。
（HttpServletRequest.setAttibute(String key, Object value)で設定された値）
ParameterParser.HEADER HttpServletRequestに含まれるヘッダー情報。
戻り値:
String HttpServletRequestの内容

getParameterNames

public java.util.Iterator getParameterNames()
インタフェース IRequestParser の記述:
HttpServletRequestのパラメータ名の一覧を返します。

定義:
インタフェース IRequestParser 内の getParameterNames
戻り値:
Iterator パラメータの一覧

getCommand

public RequestCommand getCommand()
インタフェース IRequestParser の記述:
このRequestParserを実行したコマンドクラスを取得します。

定義:
インタフェース IRequestParser 内の getCommand

getCommandName

public java.lang.String getCommandName()
インタフェース IRequestParser の記述:
このRequestParserを実行したコマンドクラス名を取得します。

定義:
インタフェース IRequestParser 内の getCommandName

setReqId

public void setReqId(java.lang.String reqId)

getReqId

public java.lang.String getReqId()
インタフェース IRequestParser の記述:
reqidを取得します

定義:
インタフェース IRequestParser 内の getReqId
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド