Tsukuyomi OpenID
0.1.2

jp.sourceforge.tsukuyomi.openid.impl
クラス OpenIDConsumerImpl

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.impl.OpenIDConsumerImpl
すべての実装されたインタフェース:
OpenIDConsumer

public class OpenIDConsumerImpl
extends Object
implements OpenIDConsumer

OpenID コンシューマを提供するクラスです。インスタンスは、DI コンテナによって管理され、HTTP リクエスト毎にインスタンスが生成されることを期待しています。

作成者:
asuka

コンストラクタの概要
OpenIDConsumerImpl()
          新たにインスタンスを生成します。
 
メソッドの概要
 String associate()
          アソシエーション確立を行います。
 boolean findProvider(String identifier)
          OpenID Identifier で OpenID プロバイダを探しに行った際、OpenID プロバイダを取得できるかを調べます。
 AuthenticationRequest getAuthenticationRequest()
          認証リクエストを取得します。
 String getReturnURL()
          OpenID プロバイダからの戻り先を取得します。
 void request()
          プロバイダに対してリクエストを送るまでの一連の処理を行います。
 void setOpenIDManager(OpenIDManager openIDManager)
          OpenID に関するリソースを管理するマネージャを設定します。
 void setRequest(HttpServletRequest request)
          HTTP サーブレットリクエストオブジェクトを設定します。
 void setResponse(HttpServletResponse response)
          HTTP サーブレットレスポンスオブジェクトを設定します。
 void setReturnURL(String returnPath)
          OpenID プロバイダからの戻り先を設定します。
 String verify()
          認証応答結果に対するベリファイを行います。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OpenIDConsumerImpl

public OpenIDConsumerImpl()
新たにインスタンスを生成します。

メソッドの詳細

findProvider

public boolean findProvider(String identifier)
OpenID Identifier で OpenID プロバイダを探しに行った際、OpenID プロバイダを取得できるかを調べます。調べる際に実際にプロバイダを取得します。

定義:
インタフェース OpenIDConsumer 内の findProvider
パラメータ:
identifier - OpenID Identifier
戻り値:
取得できた場合 true

associate

public String associate()
アソシエーション確立を行います。

定義:
インタフェース OpenIDConsumer 内の associate
戻り値:
認証サーバが要求する OpenID のバージョン

getAuthenticationRequest

public AuthenticationRequest getAuthenticationRequest()
認証リクエストを取得します。

定義:
インタフェース OpenIDConsumer 内の getAuthenticationRequest
戻り値:
認証リクエスト

getReturnURL

public String getReturnURL()
OpenID プロバイダからの戻り先を取得します。

戻り値:
OpenID プロバイダからの戻り先

setReturnURL

public void setReturnURL(String returnPath)
OpenID プロバイダからの戻り先を設定します。サーブレットコンテキストパス以降のパスを指定してください。

パラメータ:
returnPath - OpenID プロバイダからの戻り先

setOpenIDManager

public void setOpenIDManager(OpenIDManager openIDManager)
OpenID に関するリソースを管理するマネージャを設定します。

パラメータ:
openIDManager - OpenID に関するリソースを管理するマネージャ

setResponse

public void setResponse(HttpServletResponse response)
HTTP サーブレットレスポンスオブジェクトを設定します。

パラメータ:
response - HTTP サーブレットレスポンスオブジェクト

setRequest

public void setRequest(HttpServletRequest request)
HTTP サーブレットリクエストオブジェクトを設定します。

パラメータ:
request - HTTP サーブレットリクエストオブジェクト

verify

public String verify()
認証応答結果に対するベリファイを行います。

定義:
インタフェース OpenIDConsumer 内の verify
戻り値:
ベリファイに成功した場合、ベリファイされた OpenID Identifier。失敗した場合は null

request

public void request()
プロバイダに対してリクエストを送るまでの一連の処理を行います。

定義:
インタフェース OpenIDConsumer 内の request

Tsukuyomi OpenID
0.1.2

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.