|
Tsukuyomi OpenID 0.2.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.sourceforge.tsukuyomi.openid.message.ax.AxMessage
jp.sourceforge.tsukuyomi.openid.message.ax.FetchRequest
public class FetchRequest
Implements the extension for Attribute Exchange fetch requests.
Message
フィールドの概要 |
---|
クラス jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage から継承されたフィールド |
---|
OPENID_NS_AX, parameters |
コンストラクタの概要 | |
---|---|
protected |
FetchRequest()
Constructs a Fetch Request with an empty parameter list. |
protected |
FetchRequest(ParameterList params)
Constructs a FetchRequest from a parameter list. |
メソッドの概要 | |
---|---|
void |
addAttribute(String alias,
String typeUri,
boolean required)
Adds an attribute to the fetch request, with a default value-count of 1. |
void |
addAttribute(String alias,
String typeUri,
boolean required,
int count)
Adds an attribute to the fetch request. |
static FetchRequest |
createFetchRequest()
Constructs a Fetch Request with an empty parameter list. |
static FetchRequest |
createFetchRequest(ParameterList params)
Constructs a FetchRequest from a parameter list. |
Map<String,Object> |
getAttributes()
Gets all requested attributes (required and optional). |
Map<String,Object> |
getAttributes(boolean required)
Returns a map with the requested attributes. |
int |
getCount(String alias)
Returns the number of values requested for the specified attribute alias, or 1 (the default number) if the count parameter is absent. |
String |
getUpdateUrl()
Gets the optional 'update_url' parameter if available, or null otherwise. |
boolean |
isValid()
Checks the validity of the extension. |
void |
setCount(String alias,
int count)
Sets the desired number of attribute vaules requested for the specified attribute alias. |
void |
setUpdateUrl(String updateUrl)
Sets the optional 'update_url' parameter where the OP can later re-post fetch-response updates to the values of the requested attributes. |
クラス 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 |
コンストラクタの詳細 |
---|
protected FetchRequest()
protected FetchRequest(ParameterList params)
The parameter list can be extracted from a received message with the
getExtensionParams method of the Message class, and MUST NOT contain the
"openid.
メソッドの詳細 |
---|
public static FetchRequest createFetchRequest()
public static FetchRequest createFetchRequest(ParameterList params) throws MessageException
The parameter list can be extracted from a received message with the
getExtensionParams method of the Message class, and MUST NOT contain the
"openid.
MessageException
public void addAttribute(String alias, String typeUri, boolean required, int count)
alias
- The attribute alias that will be associated with the attribute
type URItypeUri
- The attribute type URIrequired
- If true, marks the attribute as 'required'; 'if_available'
otherwise.count
- The number of attribute values requested.public void addAttribute(String alias, String typeUri, boolean required)
addAttribute(String, String, boolean, int)
public void setCount(String alias, int count)
alias
- The attribute alias.public int getCount(String alias)
alias
- The attribute alias.public void setUpdateUrl(String updateUrl) throws MessageException
updateUrl
- The URL where the RP accepts later updates to the requested
attributes.
MessageException
public String getUpdateUrl()
public Map<String,Object> getAttributes(boolean required)
required
- If set to true the list of 'required' attributes is returned,
otherwise the list of 'if_available' attributes.
public Map<String,Object> getAttributes()
public boolean isValid()
Used when constructing a extension from a parameter list.
|
Tsukuyomi OpenID 0.2.0 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |