org.openid4java.message
Class AuthSuccess

java.lang.Object
  org.openid4java.message.Message
      org.openid4java.message.AuthSuccess

Direct Known Subclasses:

VerifyRequest

public class AuthSuccess
extends Message

Author:

Marius Scurtescu, Johnny Bufu

Field Summary

protected List	_signExtensions
protected List	_signFields
protected static List	optionalFields
protected static List	requiredFields
protected static String	signRequired1
protected static String	signRequired2
protected static String	signRequired3

Fields inherited from class org.openid4java.message.Message

_destinationUrl, MODE_CANCEL, MODE_IDRES, MODE_SETUP_NEEDED, OPENID2_NS

Constructor Summary

protected	AuthSuccess(ParameterList params)
protected	AuthSuccess(String opEndpoint, String claimedId, String delegate, boolean compatibility, String returnTo, String nonce, String invalidateHandle, Association assoc, boolean signNow)

Method Summary

void	addSignExtension(String extensionNamespace) Adds the list of messages fields that will be signed, in addition to the ones required by the protocol to be signed and any additional fields already configured to be signed.
void	buildSignedList() Builds the list of fields that will be signed.
static AuthSuccess	createAuthSuccess(ParameterList params)
static AuthSuccess	createAuthSuccess(String opEndpoint, String claimedId, String delegate, boolean compatibility, String returnTo, String nonce, String invalidateHandle, Association assoc, boolean signNow)
String	getClaimed()
String	getHandle()
String	getIdentity()
String	getInvalidateHandle()
String	getMode()
String	getNonce()
String	getOpEndpoint()
List	getRequiredFields()
String	getReturnTo()
String	getSignature()
String	getSignedText() Return the text on which the signature is applied.
List	getSignExtensions()
String	getSignList()
boolean	isVersion2()
void	setClaimed(String claimed)
void	setHandle(String handle)
void	setIdentity(String id)
void	setInvalidateHandle(String handle)
void	setMode(String mode)
void	setNonce(String nonce)
void	setOpEndpoint(String opEndpoint)
void	setReturnTo(String returnTo)
void	setSignature(String sig)
void	setSignExtensions(String[] extensions) Sets the list of messages fields that will be signed, in addition to the ones required by the protocol to be signed and any additional fields already configured to be signed.
void	setSignFields(String userSuppliedList) Sets the messages fields that will be signed, in addition to the ones required by the protocol to be signed.
void	validate() Checks that all required parameters are present

Methods inherited from class org.openid4java.message.Message

addExtension, addExtension, addExtensionFactory, createMessage, createMessage, getDestinationUrl, getExtension, getExtensionAlias, getExtensionFactory, getExtensions, getParameter, getParameterMap, getParameters, getParameterValue, hasExtension, hasExtensionFactory, hasParameter, keyValueFormEncoding, set, wwwFormEncoding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

requiredFields

protected static final List requiredFields

optionalFields

protected static final List optionalFields

signRequired1

protected static final String signRequired1

See Also:

Constant Field Values

signRequired2

protected static final String signRequired2

See Also:

Constant Field Values

signRequired3

protected static final String signRequired3

See Also:

Constant Field Values

_signFields

protected List _signFields

_signExtensions

protected List _signExtensions

Constructor Detail

AuthSuccess

protected AuthSuccess(String opEndpoint,
                      String claimedId,
                      String delegate,
                      boolean compatibility,
                      String returnTo,
                      String nonce,
                      String invalidateHandle,
                      Association assoc,
                      boolean signNow)
               throws AssociationException

Throws:

AssociationException

AuthSuccess

protected AuthSuccess(ParameterList params)

Method Detail

createAuthSuccess

public static AuthSuccess createAuthSuccess(String opEndpoint,
                                            String claimedId,
                                            String delegate,
                                            boolean compatibility,
                                            String returnTo,
                                            String nonce,
                                            String invalidateHandle,
                                            Association assoc,
                                            boolean signNow)
                                     throws MessageException,
                                            AssociationException

Throws:

MessageException

AssociationException

createAuthSuccess

public static AuthSuccess createAuthSuccess(ParameterList params)
                                     throws MessageException

Throws:

MessageException

getRequiredFields

public List getRequiredFields()

Overrides:

getRequiredFields in class Message

isVersion2

public boolean isVersion2()

setMode

public void setMode(String mode)
             throws MessageException

Throws:

MessageException

getMode

public String getMode()

setOpEndpoint

public void setOpEndpoint(String opEndpoint)

getOpEndpoint

public String getOpEndpoint()

setIdentity

public void setIdentity(String id)

getIdentity

public String getIdentity()

setClaimed

public void setClaimed(String claimed)

getClaimed

public String getClaimed()

setReturnTo

public void setReturnTo(String returnTo)

getReturnTo

public String getReturnTo()

setNonce

public void setNonce(String nonce)

getNonce

public String getNonce()

setInvalidateHandle

public void setInvalidateHandle(String handle)

getInvalidateHandle

public String getInvalidateHandle()

setHandle

public void setHandle(String handle)

getHandle

public String getHandle()

buildSignedList

public void buildSignedList()

Builds the list of fields that will be signed. Three input sources are considered for this:

• fields required to be signed by the OpenID protocol
• the user defined list of fields to be signed setSignFields(String)
• fields belonging to extensions to be signed setSignExtensions(String[])

This method should be called after any field additions/deletions to/from the message.

setSignFields

public void setSignFields(String userSuppliedList)

Sets the messages fields that will be signed, in addition to the ones required by the protocol to be signed. The OpenID signature will only be applied to OpenID fields, starting with the "openid." prefix.

Parameters:

userSuppliedList - Comma-separated list of fields to be signed, without the "openid." prefix

See Also:

setSignExtensions(String[])

setSignExtensions

public void setSignExtensions(String[] extensions)

Sets the list of messages fields that will be signed, in addition to the ones required by the protocol to be signed and any additional fields already configured to be signed. The OpenID signature will only be applied to OpenID fields, starting with the "openid." prefix. Should be called after all relevant extension fields have been added to the message.

Parameters:

extensions - Array of extension namespace URIs to be signed.

See Also:

#setSignExtension

addSignExtension

public void addSignExtension(String extensionNamespace)

Adds the list of messages fields that will be signed, in addition to the ones required by the protocol to be signed and any additional fields already configured to be signed. The OpenID signature will only be applied to OpenID fields, starting with the "openid." prefix. Should be called after all relevant extension fields have been added to the message.

Parameters:

extensionNamespace - Extension namespace URI to be signed.

See Also:

#setSignExtensions

getSignExtensions

public List getSignExtensions()

setSignature

public void setSignature(String sig)

getSignature

public String getSignature()

getSignList

public String getSignList()

getSignedText

public String getSignedText()

Return the text on which the signature is applied.

validate

public void validate()
              throws MessageException

Description copied from class: Message

Checks that all required parameters are present

Overrides:

validate in class Message

Throws:

MessageException