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

## jp.sourceforge.tsukuyomi.openid.message.ax
クラス AxMessage

    java.lang.Object
      jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage

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

直系の既知のサブクラス:
  FetchRequest, FetchResponse, StoreRequest, StoreResponse

    public class AxMessage

extends Object
implements MessageExtension, MessageExtensionFactory

Base class for the Attribute Exchange implementation.

Encapsulates:

- the Type URI that identifies the Attribute Exchange extension
- a list of extension-specific parameters, with the openid. prefix removed
- methods for handling the extension-specific support of parameters with multpile values

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

フィールドの概要
`static String` | `OPENID_NS_AX` The Attribute Exchange Type URI.
`protected ParameterList` | `parameters` The Attribute Exchange extension-specific parameters.

コンストラクタの概要
`AxMessage()` Constructs an empty (no parameters) Attribute Exchange extension.
`AxMessage(ParameterList params)` Constructs an Attribute Exchange extension with a specified list of parameters.

メソッドの概要
`MessageExtension` | `getExtension(ParameterList parameterList, boolean isRequest)` Instantiates the apropriate Attribute Exchange object (fetch / store - request / response) for the supplied parameter list.
`ParameterList` | `getParameters()` Gets ParameterList containing the Attribute Exchange extension-specific parameters.
`String` | `getParameterValue(String name)` Gets a the value of the parameter with the specified name.
`String` | `getTypeUri()` Gets the Type URI that identifies the Attribute Exchange extension.
`String` | `multivalDecode(String value)` Decodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).
`String` | `multivalEncode(String value)` Encodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).
`boolean` | `providesIdentifier()` Attribute exchange doesn't implement authentication services.
`void` | `setParameters(ParameterList params)` Sets the extension's parameters to the supplied list.

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

フィールドの詳細

### OPENID_NS_AX

    public static final String OPENID_NS_AX

  The Attribute Exchange Type URI.

  関連項目:
    定数フィールド値

### parameters

    protected ParameterList parameters

  The Attribute Exchange extension-specific parameters.

  The openid. prefix is not part of the parameter names

コンストラクタの詳細

### AxMessage

    public AxMessage()

  Constructs an empty (no parameters) Attribute Exchange extension.

### AxMessage

    public AxMessage(ParameterList params)

  Constructs an Attribute Exchange extension with a specified list of parameters.

  The parameter names in the list should not contain the openid..

メソッドの詳細

### getTypeUri

    public String getTypeUri()

  Gets the Type URI that identifies the Attribute Exchange extension.

  定義:
    インタフェース `MessageExtension` 内の `getTypeUri`
  定義:
    インタフェース `MessageExtensionFactory` 内の `getTypeUri`

### getParameters

    public ParameterList getParameters()

  Gets ParameterList containing the Attribute Exchange extension-specific parameters.

  The openid. prefix is not part of the parameter names, as it is handled internally by the Message class.

  The openid.ns. parameter is also handled by the Message class.

  定義:
    インタフェース `MessageExtension` 内の `getParameters`
  関連項目:
    `Message`

### getParameterValue

    public String getParameterValue(String name)

  Gets a the value of the parameter with the specified name.

  パラメータ:
    `name` - The name of the parameter, without the openid. prefix.
  戻り値:
    The parameter value, or null if not found.

### setParameters

    public void setParameters(ParameterList params)

  Sets the extension's parameters to the supplied list.

  The parameter names in the list should not contain the openid. prefix.

  定義:
    インタフェース `MessageExtension` 内の `setParameters`
  関連項目:
    `Message`

### multivalEncode

    public String multivalEncode(String value)

  Encodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).

  パラメータ:
    `value` - String value to be encoded.
  戻り値:
    The encoded value.

### multivalDecode

    public String multivalDecode(String value)

  Decodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).

  パラメータ:
    `value` - String value to be decoded.
  戻り値:
    The dencoded value.

### providesIdentifier

    public boolean providesIdentifier()

  Attribute exchange doesn't implement authentication services.

  定義:
    インタフェース `MessageExtension` 内の `providesIdentifier`
  戻り値:
    false

### getExtension

    public MessageExtension getExtension(ParameterList parameterList,
                                         boolean isRequest)
                                  throws MessageException

  Instantiates the apropriate Attribute Exchange object (fetch / store - request / response) for the supplied parameter list.

  定義:
    インタフェース `MessageExtensionFactory` 内の `getExtension`
  パラメータ:
    `parameterList` - The Attribute Exchange specific parameters (without the openid. prefix) extracted from the openid message.
    `isRequest` - Indicates whether the parameters were extracted from an OpenID request (true), or from an OpenID response.
  戻り値:
    MessageExtension implementation for the supplied extension parameters.
  例外:
    `MessageException` - If a Attribute Exchange object could not be instantiated from the supplied parameter list.

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

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.