org.openid4java.message
Class AuthSuccess

java.lang.Object
  extended by org.openid4java.message.Message
      extended by org.openid4java.message.AuthSuccess
Direct Known Subclasses:
VerifyRequest

public class AuthSuccess
extends Message

Author:
Marius Scurtescu, Johnny Bufu

Field Summary
protected  java.util.List _signExtensions
           
protected  java.util.List _signFields
           
protected static java.util.List optionalFields
           
protected static java.util.List requiredFields
           
protected static java.lang.String signRequired1
           
protected static java.lang.String signRequired2
           
protected static java.lang.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(java.lang.String opEndpoint, java.lang.String claimedId, java.lang.String delegate, boolean compatibility, java.lang.String returnTo, java.lang.String nonce, java.lang.String invalidateHandle, Association assoc, boolean signNow)
           
 
Method Summary
 void addSignExtension(java.lang.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(java.lang.String opEndpoint, java.lang.String claimedId, java.lang.String delegate, boolean compatibility, java.lang.String returnTo, java.lang.String nonce, java.lang.String invalidateHandle, Association assoc, boolean signNow)
           
 java.lang.String getClaimed()
           
 java.lang.String getHandle()
           
 java.lang.String getIdentity()
           
 java.lang.String getInvalidateHandle()
           
 java.lang.String getMode()
           
 java.lang.String getNonce()
           
 java.lang.String getOpEndpoint()
           
 java.util.List getRequiredFields()
           
 java.lang.String getReturnTo()
           
 java.lang.String getSignature()
           
 java.lang.String getSignedText()
          Return the text on which the signature is applied.
 java.util.List getSignExtensions()
           
 java.lang.String getSignList()
           
 boolean isVersion2()
           
 void setClaimed(java.lang.String claimed)
           
 void setHandle(java.lang.String handle)
           
 void setIdentity(java.lang.String id)
           
 void setInvalidateHandle(java.lang.String handle)
           
 void setMode(java.lang.String mode)
           
 void setNonce(java.lang.String nonce)
           
 void setOpEndpoint(java.lang.String opEndpoint)
           
 void setReturnTo(java.lang.String returnTo)
           
 void setSignature(java.lang.String sig)
           
 void setSignExtensions(java.lang.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(java.lang.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, 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 java.util.List requiredFields

optionalFields

protected static final java.util.List optionalFields

signRequired1

protected static final java.lang.String signRequired1
See Also:
Constant Field Values

signRequired2

protected static final java.lang.String signRequired2
See Also:
Constant Field Values

signRequired3

protected static final java.lang.String signRequired3
See Also:
Constant Field Values

_signFields

protected java.util.List _signFields

_signExtensions

protected java.util.List _signExtensions
Constructor Detail

AuthSuccess

protected AuthSuccess(java.lang.String opEndpoint,
                      java.lang.String claimedId,
                      java.lang.String delegate,
                      boolean compatibility,
                      java.lang.String returnTo,
                      java.lang.String nonce,
                      java.lang.String invalidateHandle,
                      Association assoc,
                      boolean signNow)
               throws AssociationException
Throws:
AssociationException

AuthSuccess

protected AuthSuccess(ParameterList params)
Method Detail

createAuthSuccess

public static AuthSuccess createAuthSuccess(java.lang.String opEndpoint,
                                            java.lang.String claimedId,
                                            java.lang.String delegate,
                                            boolean compatibility,
                                            java.lang.String returnTo,
                                            java.lang.String nonce,
                                            java.lang.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 java.util.List getRequiredFields()
Overrides:
getRequiredFields in class Message

isVersion2

public boolean isVersion2()

setMode

public void setMode(java.lang.String mode)
             throws MessageException
Throws:
MessageException

getMode

public java.lang.String getMode()

setOpEndpoint

public void setOpEndpoint(java.lang.String opEndpoint)

getOpEndpoint

public java.lang.String getOpEndpoint()

setIdentity

public void setIdentity(java.lang.String id)

getIdentity

public java.lang.String getIdentity()
                             throws DiscoveryException
Throws:
DiscoveryException

setClaimed

public void setClaimed(java.lang.String claimed)

getClaimed

public java.lang.String getClaimed()

setReturnTo

public void setReturnTo(java.lang.String returnTo)

getReturnTo

public java.lang.String getReturnTo()

setNonce

public void setNonce(java.lang.String nonce)

getNonce

public java.lang.String getNonce()

setInvalidateHandle

public void setInvalidateHandle(java.lang.String handle)

getInvalidateHandle

public java.lang.String getInvalidateHandle()

setHandle

public void setHandle(java.lang.String handle)

getHandle

public java.lang.String getHandle()

buildSignedList

public void buildSignedList()
Builds the list of fields that will be signed. Three input sources are considered for this:

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


setSignFields

public void setSignFields(java.lang.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(java.lang.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(java.lang.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 java.util.List getSignExtensions()

setSignature

public void setSignature(java.lang.String sig)

getSignature

public java.lang.String getSignature()

getSignList

public java.lang.String getSignList()

getSignedText

public java.lang.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


Copyright © 2012 Sxip. All Rights Reserved.