Tsukuyomi OpenID
0.2.1

jp.sourceforge.tsukuyomi.openid
インタフェース OpenIDConsumer

既知の実装クラスの一覧:
OpenIDConsumerImpl

public interface OpenIDConsumer

OpenID コンシューマに対するインタフェースです。

作成者:
asuka

メソッドの概要
 String associate()
          アソシエーション確立を行います。
 boolean findProvider(String identifier)
          OpenID Identifier で OpenID プロバイダを探しに行った際、OpenID プロバイダを取得できるかを調べます。
 AuthenticationRequest getAuthenticationRequest()
          認証リクエストを取得します。
 AuthenticationRequest getAuthenticationRequest(String returnTo)
          認証リクエストを取得します。
 void request()
          プロバイダに対してリクエストを送るまでの一連の処理を行います。
 void request(String returnTo)
          プロバイダに対してリクエストを送るまでの一連の処理を行います。
 String verify()
          認証応答結果に対するベリファイを行います。
 String verify(String requestURI)
          認証応答結果に対するベリファイを行います。
 String verifyRequest()
          認証応答結果に対するベリファイを行います。
 

メソッドの詳細

findProvider

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

パラメータ:
identifier - OpenID Identifier
戻り値:
取得できた場合 true

associate

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

戻り値:
認証サーバが要求する OpenID のバージョン

getAuthenticationRequest

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

戻り値:
認証リクエスト

getAuthenticationRequest

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

パラメータ:
returnTo - OP からの戻り先のパス
戻り値:
認証リクエスト
導入されたバージョン:
0.2.1

verify

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

戻り値:
ベリファイに成功した場合、ベリファイされた OpenID Identifier。失敗した場合は null

request

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


request

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

パラメータ:
returnTo - 戻り先パス

verify

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

パラメータ:
requestURI - リクエスト URI
戻り値:
ベリファイに成功した場合、ベリファイされた OpenID Identifier。失敗した場合は null
導入されたバージョン:
0.2.1

verifyRequest

String verifyRequest()
認証応答結果に対するベリファイを行います。リクエスト URI の検証は、内部で取得していますが、意図した値を取得しないようであれば呼び出し側で取得し、verify(String) を使用してください。

戻り値:
ベリファイに成功した場合、ベリファイされた OpenID Identifier。失敗した場合は null

Tsukuyomi OpenID
0.2.1

Copyright © 2008-2009 Project Tsukuyomi. All Rights Reserved.