org.kotemaru.auth
クラス PAMBase

java.lang.Object
  上位を拡張 org.kotemaru.auth.PAMBase
すべての実装されたインタフェース:
java.io.Serializable, PAM
直系の既知のサブクラス:
PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl

public abstract class PAMBase
extends java.lang.Object
implements PAM

関連項目:
直列化された形式

フィールドの概要
protected static java.lang.String CHARSET
           
protected static java.lang.String LOGIN_URL
           
protected static java.lang.String RETURN_URL
           
 
コンストラクタの概要
PAMBase(java.util.Map props)
           
 
メソッドの概要
 AuthResult authForRequest(javax.servlet.http.HttpServletRequest request)
          リクエスト時の自動認証を行う。
protected  java.lang.String getLoginUrl()
           
 java.lang.String getLoginURL(javax.servlet.http.HttpServletRequest request, java.lang.String returnUrl, java.lang.String charset)
          ログイン画面への転送先URLを得る。
 java.lang.String getLogoutURL(javax.servlet.http.HttpServletRequest request, java.lang.String returnUrl, java.lang.String charset)
          ログイン画面への転送先URLを得る。
 boolean isServletAuth()
          Servlet認証の場合のみtrueを返す。
 java.lang.String prepare(javax.servlet.http.HttpServletRequest request, java.util.Map props)
          認証の準備を行う。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース org.kotemaru.auth.PAM から継承されたメソッド
authenticate, getDescription, getIdProvider, getName
 

フィールドの詳細

RETURN_URL

protected static final java.lang.String RETURN_URL
関連項目:
定数フィールド値

LOGIN_URL

protected static final java.lang.String LOGIN_URL
関連項目:
定数フィールド値

CHARSET

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

PAMBase

public PAMBase(java.util.Map props)
メソッドの詳細

isServletAuth

public boolean isServletAuth()
インタフェース PAM の記述:
Servlet認証の場合のみtrueを返す。

定義:
インタフェース PAM 内の isServletAuth
戻り値:
Servlet認証か否か。

prepare

public java.lang.String prepare(javax.servlet.http.HttpServletRequest request,
                                java.util.Map props)
                         throws java.lang.Exception
インタフェース PAM の記述:
認証の準備を行う。
  • 認証の準備を行い次のステップとなるURLを返す。
  • 複数回呼ばれる場合も有る。
  • 実装は任意。SSOでは通常必要になる。
  • リクエストパラメータはプロトコルで決っていない限り使わない。

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

  • authForRequest

    public AuthResult authForRequest(javax.servlet.http.HttpServletRequest request)
                              throws java.lang.Exception
    インタフェース PAM の記述:
    リクエスト時の自動認証を行う。
  • ログインに必要な情報はリクエスト情報から取得。
  • セッション属性にユーザは保存しているのでクッキー等の処理は不要。
  • 認証できない場合にはステータスを AuthResult.MOOT で返す。
  • Servlet認証以外での実装は通常不要。
  • 認証失敗の場合には VisitUser を返す。

    定義:
    インタフェース PAM 内の authForRequest
    パラメータ:
    request - リクエスト情報
    戻り値:
    認証結果
    例外:
    java.lang.Exception

  • getLoginUrl

    protected java.lang.String getLoginUrl()

    getLoginURL

    public java.lang.String getLoginURL(javax.servlet.http.HttpServletRequest request,
                                        java.lang.String returnUrl,
                                        java.lang.String charset)
    インタフェース PAM の記述:
    ログイン画面への転送先URLを得る。
  • PAMFactory#login(HttpServletRequest,String,String) から呼ばれる。
  • 転送先URLに PAMFactory#login(HttpServletRequest,String,String)を呼ぶHTMLを用意して置く必要がある。
  • returnUrl はリクエストパラメータ returnUrl として転送先URLに渡す。 扱いは転送先URLのHTMLに任せる。

    定義:
    インタフェース PAM 内の getLoginURL
    パラメータ:
    request - リクエスト情報
    returnUrl - ログイン後転送するURL
    charset - エンコードする場合の文字コード

  • getLogoutURL

    public java.lang.String getLogoutURL(javax.servlet.http.HttpServletRequest request,
                                         java.lang.String returnUrl,
                                         java.lang.String charset)
    インタフェース PAM の記述:
    ログイン画面への転送先URLを得る。
  • セッションの切断以外に特別な処理が有る場合に記述する。

    定義:
    インタフェース PAM 内の getLogoutURL
    パラメータ:
    request - リクエスト情報
    returnUrl - ログイン後転送するURL
    charset - エンコードする場合の文字コード


  • Copyright © 2009 kotemaru.