public class SRegRequest extends SRegMessage
Message
_parameters, OPENID_NS_SREG, OPENID_NS_SREG11
Modifier | Constructor and Description |
---|---|
protected |
SRegRequest()
Constructs a SReg Request with an empty parameter list.
|
protected |
SRegRequest(ParameterList params)
Constructs a SRegRequest from a parameter list.
|
Modifier and Type | Method and Description |
---|---|
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 |
getAttributes()
Gets all requested attributes (required and optional).
|
List |
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.
|
getExtension, getParameters, getParameterValue, getTypeUri, multivalDecode, multivalEncode, providesIdentifier, setParameters, setTypeUri, signRequired
protected SRegRequest()
protected SRegRequest(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 SRegRequest createFetchRequest()
public static SRegRequest createSRegRequest(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 attr, boolean required)
attr
- A requested attribute name.required
- If true, marks the attribute as 'required';
'if_available' otherwise.public List getAttributes(boolean required)
required
- If set to true the list of 'required' attributes
is returned, otherwise the list of 'optional'
attributes.public List getAttributes()
public void setPolicyUrl(String policyUrl) throws MessageException
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
public String getUpdateUrl()
public boolean isValid()
Used when constructing a extension from a parameter list.
Copyright © 2017 Sxip. All rights reserved.