org.kotemaru.auth
クラス PAMFactory

java.lang.Object
  上位を拡張 org.kotemaru.auth.PAMFactory
直系の既知のサブクラス:
AuthManager

public class PAMFactory
extends java.lang.Object

PAMのファクトリクラス。

  • 同時に1つのPAMインスタンスしか持てない。


    フィールドの概要
    static java.lang.String AUTH_USER
               
     
    コンストラクタの概要
    PAMFactory()
               
     
    メソッドの概要
    static PAM getPAM()
              PAMインスタンスを返す。
    static RoleManager getRoleManager()
              RoleManagerインスタンスを返す。
    static User getUser(javax.servlet.http.HttpServletRequest request)
              リクエストからユーザを得る。
    static User getUser(java.lang.String userName)
              認証済みユーザとしてユーザを返す。
    static UserManager getUserManager()
               
    static User getVisitUser()
              未ログインユーザを返す。
    static void init(PAM pam, RoleManager roleMan, UserManager userMan)
              初期化 PAM情報からPAMインスタンスを生成し利用可能な状態にする。
    static AuthResult login(javax.servlet.http.HttpServletRequest request, java.util.Map props)
              ログイン処理を行う。
    static User logout(javax.servlet.http.HttpServletRequest request)
              ログアウト処理を行う。
    static java.lang.String prepare(javax.servlet.http.HttpServletRequest request, java.util.Map props)
              認証の準備を行う。
    static java.lang.String register(javax.servlet.http.HttpServletRequest request, java.util.Map props)
               
     
    クラス java.lang.Object から継承されたメソッド
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    フィールドの詳細

    AUTH_USER

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

    PAMFactory

    public PAMFactory()
    メソッドの詳細

    init

    public static void init(PAM pam,
                            RoleManager roleMan,
                            UserManager userMan)
                     throws java.lang.Exception
    初期化
    • PAM情報からPAMインスタンスを生成し利用可能な状態にする。

    パラメータ:
    pamInfo - PAM情報
    roleMans - RoleManager情報
    例外:
    java.lang.Exception

    getPAM

    public static PAM getPAM()
    PAMインスタンスを返す。

    戻り値:
    PAMインスタンス

    getRoleManager

    public static RoleManager getRoleManager()
    RoleManagerインスタンスを返す。

    戻り値:
    RoleManagerインスタンス

    getUserManager

    public static UserManager getUserManager()

    register

    public static java.lang.String register(javax.servlet.http.HttpServletRequest request,
                                            java.util.Map props)
                                     throws java.lang.Exception
    例外:
    java.lang.Exception

    prepare

    public static java.lang.String prepare(javax.servlet.http.HttpServletRequest request,
                                           java.util.Map props)
                                    throws java.lang.Exception
    認証の準備を行う。
  • 認証の準備を行い次のステップとなるURLを返す。
  • 複数回呼ばれる場合も有る。
  • 実装は任意。SSOでは通常必要になる。

    パラメータ:
    request - リクエスト情報
    props - プロパティ
    戻り値:
    転送先URL。転送不要の場合はnull。
    例外:
    java.lang.Exception

  • login

    public static AuthResult login(javax.servlet.http.HttpServletRequest request,
                                   java.util.Map props)
                            throws java.lang.Exception
    ログイン処理を行う。

    パラメータ:
    request - リクエスト情報
    props - プロパティ
    戻り値:
    認証結果
    例外:
    java.lang.Exception

    logout

    public static User logout(javax.servlet.http.HttpServletRequest request)
                       throws java.lang.Exception
    ログアウト処理を行う。
  • サーブレットセッションは無効になる。

    パラメータ:
    request - リクエスト情報
    戻り値:
    null
    例外:
    java.lang.Exception

  • getUser

    public static User getUser(javax.servlet.http.HttpServletRequest request)
                        throws java.lang.Exception
    リクエストからユーザを得る。
  • 未ログイン状態ならリクエスト情報からログインする。
  • ログインできなければ VisitUser となる。

    パラメータ:
    request - リクエスト情報
    戻り値:
    ユーザ
    例外:
    java.lang.Exception

  • getVisitUser

    public static User getVisitUser()
    未ログインユーザを返す。

    戻り値:
    VisitUserのインスタンス。

    getUser

    public static User getUser(java.lang.String userName)
    認証済みユーザとしてユーザを返す。
  • 内部利用のみ。スクリプトに対して機能を公開しないように。

    戻り値:
    ユーザ。


  • Copyright © 2009 kotemaru.