org.openid4java.message.ax
Class FetchResponse

java.lang.Object
  extended by org.openid4java.message.ax.AxMessage
      extended by org.openid4java.message.ax.AxPayload
          extended by org.openid4java.message.ax.FetchResponse
All Implemented Interfaces:
MessageExtension, MessageExtensionFactory

public class FetchResponse
extends AxPayload

Implements the extension for Attribute Exchange fetch responses.

Author:
Marius Scurtescu, Johnny Bufu

Field Summary
private static org.apache.commons.logging.Log _log
           
private static boolean DEBUG
           
 
Fields inherited from class org.openid4java.message.ax.AxMessage
_parameters, OPENID_NS_AX
 
Constructor Summary
protected FetchResponse()
          Constructs a Fetch Response with an empty parameter list.
protected FetchResponse(ParameterList params)
          Constructs a FetchResponse from a parameter list.
 
Method Summary
static FetchResponse createFetchResponse()
          Constructs a Fetch Response with an empty parameter list.
static FetchResponse createFetchResponse(FetchRequest req, java.util.Map userData)
          Creates a FetchResponse from a FetchRequest message and the data released by the user.
static FetchResponse createFetchResponse(ParameterList params)
           
 java.lang.String getUpdateUrl()
          Gets the optional 'update_url' parameter if available, or null otherwise.
protected  boolean isValid()
          Checks the validity of the extension.
 void setUpdateUrl(java.lang.String updateUrl)
          Sets the optional 'update_url' parameter where the OP can later re-post fetch-response updates for the values of the requested attributes.
 
Methods inherited from class org.openid4java.message.ax.AxPayload
addAttribute, addAttribute, addAttributes, getAttributeAlias, getAttributeAliases, getAttributes, getAttributeTypes, getAttributeTypeUri, getAttributeValue, getAttributeValueByTypeUri, getAttributeValues, getAttributeValuesByTypeUri, getCount
 
Methods inherited from class org.openid4java.message.ax.AxMessage
getExtension, getParameters, getParameterValue, getTypeUri, providesIdentifier, setParameters, signRequired
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_log

private static org.apache.commons.logging.Log _log

DEBUG

private static final boolean DEBUG
Constructor Detail

FetchResponse

protected FetchResponse()
Constructs a Fetch Response with an empty parameter list.


FetchResponse

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

Method Detail

createFetchResponse

public static FetchResponse createFetchResponse()
Constructs a Fetch Response with an empty parameter list.


createFetchResponse

public static FetchResponse createFetchResponse(ParameterList params)
                                         throws MessageException
Throws:
MessageException

createFetchResponse

public static FetchResponse createFetchResponse(FetchRequest req,
                                                java.util.Map userData)
                                         throws MessageException
Creates a FetchResponse from a FetchRequest message and the data released by the user.

Parameters:
req - FetchRequest message.
userData - The userData may be a Map or a Map values>. The attribute values are provided by the calling application. If a list of values is specified per attribute, at most n will be sent, where n is the number of attribute values requested in the FetchRequest.
Returns:
Properly formed FetchResponse.
Throws:
MessageException

setUpdateUrl

public void setUpdateUrl(java.lang.String updateUrl)
                  throws MessageException
Sets the optional 'update_url' parameter where the OP can later re-post fetch-response updates for the values of the requested attributes.

Parameters:
updateUrl - The URL where the RP accepts later updates for the requested attributes.
Throws:
MessageException

getUpdateUrl

public java.lang.String getUpdateUrl()
Gets the optional 'update_url' parameter if available, or null otherwise.


isValid

protected boolean isValid()
Checks the validity of the extension.

Used when constructing a extension from a parameter list.

Overrides:
isValid in class AxPayload
Returns:
True if the extension is valid, false otherwise.


Copyright 2006-2008 Sxip Identity Corporation