Tsukuyomi OpenID
0.2.0

jp.sourceforge.tsukuyomi.openid.message.ax
クラス StoreRequest

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage
      上位を拡張 jp.sourceforge.tsukuyomi.openid.message.ax.StoreRequest
すべての実装されたインタフェース:
MessageExtension, MessageExtensionFactory

public class StoreRequest
extends AxMessage

Implements the extension for Attribute Exchange store requests.

作成者:
Marius Scurtescu, Johnny Bufu

フィールドの概要
 
クラス jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage から継承されたフィールド
OPENID_NS_AX, parameters
 
コンストラクタの概要
protected StoreRequest()
          Constructs a Store Request with an empty parameter list.
protected StoreRequest(ParameterList params)
          Constructs a StoreRequest from a parameter list.
 
メソッドの概要
 void addAttribute(String alias, String typeUri, String value)
          Adds an attribute to the store request.
static StoreRequest createStoreRequest()
          Constructs a Store Request with an empty parameter list.
static StoreRequest createStoreRequest(ParameterList params)
          Constructs a StoreRequest from a parameter list.
 List<String> getAttributeAliases()
          Gets a list of attribute aliases.
 Map<String,Object> getAttributes()
          Gets a map with attribute aliases -> list of values.
 List<String> getAttributeValues(String alias)
          Returns a list with the attribute value(s) associated with the specified alias.
 int getCount(String alias)
          Gets the number of values provided in the fetch response for the specified attribute alias.
 boolean isValid()
          Checks the validity of the extension.
 
クラス jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage から継承されたメソッド
getExtension, getParameters, getParameterValue, getTypeUri, multivalDecode, multivalEncode, providesIdentifier, setParameters
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

StoreRequest

protected StoreRequest()
Constructs a Store Request with an empty parameter list.


StoreRequest

protected StoreRequest(ParameterList params)
Constructs a StoreRequest 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.

メソッドの詳細

createStoreRequest

public static StoreRequest createStoreRequest()
Constructs a Store Request with an empty parameter list.


createStoreRequest

public static StoreRequest createStoreRequest(ParameterList params)
                                       throws MessageException
Constructs a StoreRequest 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 alias,
                         String typeUri,
                         String value)
Adds an attribute to the store request.

パラメータ:
alias - The identifier that will be associated with the attribute name URI
typeUri - The attribute name URI
value - The value of the attribute

getAttributeValues

public List<String> getAttributeValues(String alias)
Returns a list with the attribute value(s) associated with the specified alias.

パラメータ:
alias - Attribute alias.
戻り値:
List of attribute values.

getAttributeAliases

public List<String> getAttributeAliases()
Gets a list of attribute aliases.


getAttributes

public Map<String,Object> getAttributes()
Gets a map with attribute aliases -> list of values.


getCount

public int getCount(String alias)
Gets the number of values provided in the fetch response for the specified attribute alias.

パラメータ:
alias - The attribute alias.

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.

Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.