概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| Tsukuyomi OpenID 0.2.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## 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()` 認証リクエストを取得します。
`AuthenticationRequest` | `getAuthenticationRequest(String returnTo)` 認証リクエストを取得します。
`void` | `request()` プロバイダに対してリクエストを送るまでの一連の処理を行います。
`void` | `request(String returnTo)` プロバイダに対してリクエストを送るまでの一連の処理を行います。
`void` | `setRelayParty(RelayParty relayParty)`
`void` | `setRelayPartyConfig(RelayPartyConfig relayPartyConfig)`
`void` | `setRequest(HttpServletRequest request)` HTTP サーブレットリクエストオブジェクトを設定します。
`void` | `setResponse(HttpServletResponse response)` HTTP サーブレットレスポンスオブジェクトを設定します。
`String` | `verify()` 認証応答結果に対するベリファイを行います。
`String` | `verify(String requestURI)` 認証応答結果に対するベリファイを行います。
`String` | `verifyRequest()` 認証応答結果に対するベリファイを行います。

クラス 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`
  戻り値:
    認証リクエスト

### getAuthenticationRequest

    public AuthenticationRequest getAuthenticationRequest(String returnTo)

  認証リクエストを取得します。

  定義:
    インタフェース `OpenIDConsumer` 内の `getAuthenticationRequest`
  パラメータ:
    `returnTo` - OP からの戻り先のパス
  戻り値:
    認証リクエスト

### setResponse

    public void setResponse(HttpServletResponse response)

  HTTP サーブレットレスポンスオブジェクトを設定します。

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

### setRequest

    public void setRequest(HttpServletRequest request)

  HTTP サーブレットリクエストオブジェクトを設定します。

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

### verify

    public String verify()

  認証応答結果に対するベリファイを行います。リクエスト URI の検証に関しては、固定値（`RelayPartyConfig.getReturnURL()` の値）を用いるので呼び出し側で保証しなければなりません。

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

### verify

    public String verify(String requestURI)

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

  定義:
    インタフェース `OpenIDConsumer` 内の `verify`
  パラメータ:
    `requestURI` - リクエスト URI
  戻り値:
    ベリファイに成功した場合、ベリファイされた OpenID Identifier。失敗した場合は null

### verifyRequest

    public String verifyRequest()

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

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

### request

    public void request()

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

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

### request

    public void request(String returnTo)

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

  定義:
    インタフェース `OpenIDConsumer` 内の `request`
  パラメータ:
    `returnTo` - 戻り先パス

### setRelayParty

    public void setRelayParty(RelayParty relayParty)

### setRelayPartyConfig

    public void setRelayPartyConfig(RelayPartyConfig relayPartyConfig)

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| Tsukuyomi OpenID 0.2.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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