org.kotemaru.auth
インタフェース PAM

すべてのスーパーインタフェース:
java.io.Serializable
既知の実装クラスの一覧:
PAMBase, PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl, PAMImpl

public interface PAM
extends java.io.Serializable

PAM(Pluggable Authentication Modules)のインターフェース。


メソッドの概要
 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を返す。
 java.lang.String prepare(javax.servlet.http.HttpServletRequest request, java.util.Map props)
          認証の準備を行う。
 

メソッドの詳細

getName

java.lang.String getName()
PAMの名前を返す。

戻り値:
PAMの名前

getDescription

java.lang.String getDescription()
PAMの説明を返す。

戻り値:
PAMの説明

getIdProvider

IdProvider getIdProvider()
ユーザを認証するプロバイダ情報を返す。
  • プロバイダが固定で無い場合はnullを返す。

    戻り値:
    IdProvider

  • isServletAuth

    boolean isServletAuth()
    Servlet認証の場合のみtrueを返す。

    戻り値:
    Servlet認証か否か。

    authForRequest

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

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

  • prepare

    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

  • authenticate

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

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

  • getLoginURL

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

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

  • getLogoutURL

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

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


  • Copyright © 2009 kotemaru.