WebPasswordHandlerコンストラクタ
説明
WebPasswordHandlerクラスのインスタンスを生成します。
WebPasswordHandlerコンストラクタには,Credential(UserAttributes)に格納するユーザ情報(属性)をメモリで指定する場合と,ファイルで指定する場合の二つの形式があります。なお,requestパラメタおよびresponseパラメタは,必ず指定してください。nullが指定されていた場合は,ParameterError例外が発生します。
形式
public WebPasswordHandler(HttpServletRequest request, HttpServletResponse response, AttributeEntry[] aliases, String url, boolean urlforward) throws FormatError, ParameterError; public WebPasswordHandler(HttpServletRequest request, HttpServletResponse response, String aliasesFile, String url, boolean urlforward) throws IOException, SecurityException, FormatError, ParameterError;
パラメタ
- request:
-
JSP/Servlet起動時のパラメタをそのまま指定します。
- response:
-
JSP/Servlet起動時のパラメタをそのまま指定します。
- aliases:
-
認証が成功したときに作成するCredential(UserAttributes)に格納する情報を指定します。取得する情報がない場合はnullを指定します。このとき,Credentialは作成されません(空のUserAttributesオブジェクトが作成されます)。aliasesには,AttributeEntryオブジェクトの配列を指定します。指定した内容で必要な情報がない場合は,FormatError例外が発生します(必須の値が格納されていない,またはFormatにない値が指定されている場合)。
- aliasesFile:
-
認証が成功したときに作成するCredential(UserAttributes)に格納する情報を指定します。取得する情報がない場合はnullを指定します。このとき,Credentialは作成されません(空のUserAttributesオブジェクトが作成されます)。aliasesFileにはファイル名を指定します。指定した内容で必要な情報がない場合は,FormatError例外が発生します(必須の値が格納されていない,またはFormatにない値が指定されている場合)。
- url:
-
ユーザから認証情報(ユーザID/パスワード)を取得するためのURLを指定します。URLの指定がある場合,urlforwardの指定に従ってLogin FormをRequestDispatcherオブジェクトに渡します(ユーザに対して入力情報を取得する場合)。この指定が不要であればnullを指定します。また,nullの場合は,urlforwardの値を参照しません。nullの場合で,handleメソッドの延長で認証情報の取得ができない(HttpServletRequest内に格納されていない)ときは,LoginContextクラスのloginメソッドの延長でLoginException例外が発生します。
- urlforward:
-
URLの表示方法を選択します。指定されたURLに対して,trueの場合,RequestDispatcherオブジェクトのforwardメソッドを呼び出します。falseの場合,RequestDispatcherオブジェクトに対してincludeメソッドを呼び出します。
例外
- java.io.FileNotFoundException:
-
ファイルがない,ファイルではなくディレクトリである,または何かの理由で開くことができません(FileInputStreamクラスのコンストラクタで例外が発生した場合)。
- java.lang.SecurityException:
-
SecurityManagerが存在し,SecurityManagerのcheckReadメソッドでファイルへの読み込みアクセスが拒否されました。
- java.io.IOException:
-
ファイルの読み込みに失敗しました。
- com.cosminexus.admin.common.ParameterError:
-
HttpServletRequestまたはHttpServletResponseのリファレンスが指定されていません。
- com.cosminexus.admin.common.FormatError:
-
aliasesおよびaliasesFileに指定された内容で必要な情報がありません。または余分に指定されています。