org.kotemaru.auth.gae
クラス PAMImpl

java.lang.Object
  上位を拡張 org.kotemaru.auth.PAMBase
      上位を拡張 org.kotemaru.auth.gae.PAMImpl
すべての実装されたインタフェース:
java.io.Serializable, PAM

public class PAMImpl
extends PAMBase

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

フィールドの概要
 
クラス org.kotemaru.auth.PAMBase から継承されたフィールド
CHARSET, LOGIN_URL, RETURN_URL
 
コンストラクタの概要
PAMImpl(java.util.Map props)
           
 
メソッドの概要
 AuthResult authenticate(javax.servlet.http.HttpServletRequest request, java.util.Map props)
          認証を行う。
 AuthResult authForRequest(javax.servlet.http.HttpServletRequest request)
          リクエスト時の自動認証を行う。
 java.lang.String getDescription()
          PAMの説明を返す。
 IdProvider getIdProvider()
          ユーザを認証するプロバイダ情報を返す。
 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を得る。
 java.lang.String getName()
          PAMの名前を返す。
 boolean isServletAuth()
          Servlet認証の場合のみtrueを返す。
 
クラス org.kotemaru.auth.PAMBase から継承されたメソッド
getLoginUrl, prepare
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PAMImpl

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

getName

public java.lang.String getName()
インタフェース PAM の記述:
PAMの名前を返す。

戻り値:
PAMの名前

getDescription

public java.lang.String getDescription()
インタフェース PAM の記述:
PAMの説明を返す。

戻り値:
PAMの説明

getIdProvider

public IdProvider getIdProvider()
インタフェース PAM の記述:
ユーザを認証するプロバイダ情報を返す。
  • プロバイダが固定で無い場合はnullを返す。

    戻り値:
    IdProvider

  • isServletAuth

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

    定義:
    インタフェース PAM 内の isServletAuth
    オーバーライド:
    クラス PAMBase 内の isServletAuth
    戻り値:
    Servlet認証か否か。

    authForRequest

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

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

  • authenticate

    public AuthResult authenticate(javax.servlet.http.HttpServletRequest request,
                                   java.util.Map props)
                            throws java.lang.Exception
    インタフェース PAM の記述:
    認証を行う。
  • 認証失敗の場合には VisitUser を返す。
  • Servlet認証以外では実装必須。
  • プロティの内容は実装依存。例: {user:"ユーザ名", pass:"パスワード"}
  • リクエストパラメータはプロトコルで決っていない限り使わない。

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

  • 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
    オーバーライド:
    クラス PAMBase 内の 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
    オーバーライド:
    クラス PAMBase 内の getLogoutURL
    パラメータ:
    request - リクエスト情報
    returnUrl - ログイン後転送するURL
    charset - エンコードする場合の文字コード


  • Copyright © 2009 kotemaru.