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

## jp.sourceforge.tsukuyomi.openid.message.sreg
クラス SRegRequest

    java.lang.Object
      jp.sourceforge.tsukuyomi.openid.message.sreg.SRegMessage
          jp.sourceforge.tsukuyomi.openid.message.sreg.SRegRequest

すべての実装されたインタフェース:
  MessageExtension, MessageExtensionFactory

    public class SRegRequest

extends SRegMessage

Implements the extension for Simple Registration fetch requests.

作成者:
  Marius Scurtescu, Johnny Bufu
関連項目:
  `Message`

フィールドの概要

クラス jp.sourceforge.tsukuyomi.openid.message.sreg.SRegMessage から継承されたフィールド
`OPENID_NS_SREG, parameters`

コンストラクタの概要
`protected` | `SRegRequest()` Constructs a SReg Request with an empty parameter list.
`protected` | `SRegRequest(ParameterList params)` Constructs a SRegRequest from a parameter list.

メソッドの概要
`void` | `addAttribute(String attr, boolean required)` Adds an attribute to the SReg request.
`static SRegRequest` | `createFetchRequest()` Constructs a SReg Request with an empty parameter list.
`static SRegRequest` | `createSRegRequest(ParameterList params)` Constructs a SRegRequest from a parameter list.
`List<String>` | `getAttributes()` Gets all requested attributes (required and optional).
`List<String>` | `getAttributes(boolean required)` Returns a map with the requested attributes.
`String` | `getUpdateUrl()` Gets the optional policy URL parameter if available, or null otherwise.
`boolean` | `isValid()` Checks the validity of the extension.
`void` | `setPolicyUrl(String policyUrl)` Sets the optional policy URL.

クラス jp.sourceforge.tsukuyomi.openid.message.sreg.SRegMessage から継承されたメソッド
`getExtension, getParameters, getParameterValue, getTypeUri, multivalDecode, multivalEncode, providesIdentifier, setParameters`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### SRegRequest

    protected SRegRequest()

  Constructs a SReg Request with an empty parameter list.

### SRegRequest

    protected SRegRequest(ParameterList params)

  Constructs a SRegRequest from a parameter list.

  The parameter list can be extracted from a received message with the getExtensionParams method of the Message class, and MUST NOT contain the "openid.." prefix.

メソッドの詳細

### createFetchRequest

    public static SRegRequest createFetchRequest()

  Constructs a SReg Request with an empty parameter list.

### createSRegRequest

    public static SRegRequest createSRegRequest(ParameterList params)
                                         throws MessageException

  Constructs a SRegRequest from a parameter list.

  The parameter list can be extracted from a received message with the getExtensionParams method of the Message class, and MUST NOT contain the "openid.." prefix.

  例外:
    `MessageException`

### addAttribute

    public void addAttribute(String attr,
                             boolean required)

  Adds an attribute to the SReg request.

  パラメータ:
    `attr` - A requested attribute name.
    `required` - If true, marks the attribute as 'required'; 'if_available' otherwise.

### getAttributes

    public List<String> getAttributes(boolean required)

  Returns a map with the requested attributes.

  パラメータ:
    `required` - If set to true the list of 'required' attributes is returned, otherwise the list of 'optional' attributes.
  戻り値:
    List of attribute names.

### getAttributes

    public List<String> getAttributes()

  Gets all requested attributes (required and optional).

  戻り値:
    List of attribute names.

### setPolicyUrl

    public void setPolicyUrl(String policyUrl)
                      throws MessageException

  Sets the optional policy URL.

  パラメータ:
    `policyUrl` - A URL which the Consumer provides to give the End User a place to read about the how the profile data will be used. The Identity Provider SHOULD display this URL to the End User if it is given.
  例外:
    `MessageException`

### getUpdateUrl

    public String getUpdateUrl()

  Gets the optional policy URL parameter if available, or null otherwise.

### isValid

    public boolean isValid()

  Checks the validity of the extension.

  Used when constructing a extension from a parameter list.

  戻り値:
    True if the extension is valid, false otherwise.

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

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.