org.openid4java.message

Class AuthRequest

java.lang.Object

org.openid4java.message.Message

org.openid4java.message.AuthRequest

public class AuthRequest
extends Message

Author:

Marius Scurtescu, Johnny Bufu

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODE_IMMEDIATE
static String	MODE_SETUP
protected static List	optionalFields
protected static List	requiredFields
static String	SELECT_ID

Fields inherited from class org.openid4java.message.Message

_destinationUrl, MODE_CANCEL, MODE_IDRES, MODE_SETUP_NEEDED, OPENID2_NS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthRequest(ParameterList params)
protected	AuthRequest(String claimedId, String delegate, boolean compatibility, String returnToUrl, String handle, RealmVerifier verifier)
protected	AuthRequest(String claimedId, String delegate, boolean compatibility, String returnToUrl, String handle, String realm, RealmVerifier verifier)

Method Summary

Methods

Modifier and Type	Method and Description
static AuthRequest	createAuthRequest(ParameterList params, RealmVerifier realmVerifier)
static AuthRequest	createAuthRequest(String claimedId, String delegate, boolean compatibility, String returnToUrl, String handle, RealmVerifier verifier)
static AuthRequest	createAuthRequest(String claimedId, String delegate, boolean compatibility, String returnToUrl, String handle, String realm, RealmVerifier verifier)
String	getClaimed()
String	getHandle()
String	getIdentity()
String	getOPEndpoint()
String	getRealm()
RealmVerifier	getRealmVerifier() Gets the RealmVerifier used to verify realms against return_to URLs.
List	getRequiredFields()
String	getReturnTo()
boolean	isImmediate()
boolean	isVersion2()
void	setClaimed(String claimed)
void	setHandle(String handle)
void	setIdentity(String id)
void	setImmediate(boolean immediate)
void	setOPEndpoint(URL opEndpoint)
void	setRealm(String realm)
void	setRealmVerifier(RealmVerifier realmVerifier) Sets the RealmVerifier used to verify realms against return_to URLs.
void	setReturnTo(String returnTo)
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

MODE_SETUP

public static final String MODE_SETUP

See Also:

Constant Field Values

MODE_IMMEDIATE

public static final String MODE_IMMEDIATE

See Also:

Constant Field Values

SELECT_ID

public static final String SELECT_ID

See Also:

Constant Field Values

requiredFields

protected static final List requiredFields

optionalFields

protected static final List optionalFields

Constructor Detail

AuthRequest

protected AuthRequest(String claimedId,
           String delegate,
           boolean compatibility,
           String returnToUrl,
           String handle,
           RealmVerifier verifier)

AuthRequest

protected AuthRequest(String claimedId,
           String delegate,
           boolean compatibility,
           String returnToUrl,
           String handle,
           String realm,
           RealmVerifier verifier)

AuthRequest

protected AuthRequest(ParameterList params)

Method Detail

createAuthRequest

public static AuthRequest createAuthRequest(String claimedId,
                            String delegate,
                            boolean compatibility,
                            String returnToUrl,
                            String handle,
                            RealmVerifier verifier)
                                     throws MessageException

Throws:

MessageException

createAuthRequest

public static AuthRequest createAuthRequest(String claimedId,
                            String delegate,
                            boolean compatibility,
                            String returnToUrl,
                            String handle,
                            String realm,
                            RealmVerifier verifier)
                                     throws MessageException

Throws:

MessageException

createAuthRequest

public static AuthRequest createAuthRequest(ParameterList params,
                            RealmVerifier realmVerifier)
                                     throws MessageException

Throws:

MessageException

getRequiredFields

public List getRequiredFields()

Overrides:

getRequiredFields in class Message

setOPEndpoint

public void setOPEndpoint(URL opEndpoint)

getOPEndpoint

public String getOPEndpoint()

setImmediate

public void setImmediate(boolean immediate)

isImmediate

public boolean isImmediate()

isVersion2

public boolean isVersion2()

setIdentity

public void setIdentity(String id)

getIdentity

public String getIdentity()

setClaimed

public void setClaimed(String claimed)

getClaimed

public String getClaimed()

setHandle

public void setHandle(String handle)

getHandle

public String getHandle()

setReturnTo

public void setReturnTo(String returnTo)

getReturnTo

public String getReturnTo()

setRealm

public void setRealm(String realm)

getRealm

public String getRealm()

getRealmVerifier

public RealmVerifier getRealmVerifier()

Gets the RealmVerifier used to verify realms against return_to URLs.

setRealmVerifier

public void setRealmVerifier(RealmVerifier realmVerifier)

Sets the RealmVerifier used to verify realms against return_to URLs.

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