org.openid4java.message

Class Message

java.lang.Object

org.openid4java.message.Message

Direct Known Subclasses:

AssociationRequest, AssociationResponse, AuthFailure, AuthImmediateFailure, AuthRequest, AuthSuccess, DirectError, IndirectError, VerifyResponse

public class Message
extends Object

Author:

Marius Scurtescu, Johnny Bufu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_destinationUrl
static String	MODE_CANCEL
static String	MODE_IDRES
static String	MODE_SETUP_NEEDED
static String	OPENID2_NS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Message()
protected	Message(ParameterList params)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(MessageExtension extension) Adds a set of extension-specific parameters to a message.
static void	addExtensionFactory(Class clazz) Adds a new extension factory.
static Message	createMessage()
static Message	createMessage(ParameterList params)
String	getDestinationUrl(boolean httpGet) Gets the URL where the message should be sent, where applicable.
MessageExtension	getExtension(String typeUri) Gets a MessageExtension for the specified Type URI if an implementation is available, or null otherwise.
String	getExtensionAlias(String extensionTypeUri) Retrieves the extension alias that will be used for the extension identified by the supplied extension type URI.
static MessageExtensionFactory	getExtensionFactory(String typeUri) Gets a MessageExtensionFactory for the specified Type URI if an implementation is available, or null otherwise.
Set	getExtensions() Gets a set of extension Type URIs that are present in the message.
protected Parameter	getParameter(String name)
Map	getParameterMap()
protected List	getParameters()
String	getParameterValue(String name)
List	getRequiredFields()
boolean	hasExtension(String typeUri) Returns true if the message has parameters for the specified extension type URI.
static boolean	hasExtensionFactory(String typeUri) Returns true if there is an extension factory available for extension identified by the specified Type URI, or false otherwise.
boolean	hasParameter(String name)
String	keyValueFormEncoding()
protected void	set(String name, String value)
void	validate() Checks that all required parameters are present
String	wwwFormEncoding()

Methods inherited from class java.lang.Object

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

Field Detail

MODE_IDRES

public static final String MODE_IDRES

See Also:

Constant Field Values

MODE_CANCEL

public static final String MODE_CANCEL

See Also:

Constant Field Values

MODE_SETUP_NEEDED

public static final String MODE_SETUP_NEEDED

See Also:

Constant Field Values

OPENID2_NS

public static final String OPENID2_NS

See Also:

Constant Field Values

_destinationUrl

protected String _destinationUrl

Constructor Detail

Message

protected Message()

Message

protected Message(ParameterList params)

Method Detail

createMessage

public static Message createMessage()
                             throws MessageException

Throws:

MessageException

createMessage

public static Message createMessage(ParameterList params)
                             throws MessageException

Throws:

MessageException

addExtensionFactory

public static void addExtensionFactory(Class clazz)
                                throws MessageException

Adds a new extension factory.

Parameters:

clazz - The implementation class for the extension factory, must implement MessageExtensionFactory.

Throws:

MessageException

hasExtensionFactory

public static boolean hasExtensionFactory(String typeUri)

Returns true if there is an extension factory available for extension identified by the specified Type URI, or false otherwise.

Parameters:

typeUri - The Type URI that identifies an extension.

getExtensionFactory

public static MessageExtensionFactory getExtensionFactory(String typeUri)

Gets a MessageExtensionFactory for the specified Type URI if an implementation is available, or null otherwise.

Parameters:

typeUri - The Type URI that identifies a extension.

See Also:

Message

getParameter

protected Parameter getParameter(String name)

getParameterValue

public String getParameterValue(String name)

hasParameter

public boolean hasParameter(String name)

set

protected void set(String name,
       String value)

getParameters

protected List getParameters()

getParameterMap

public Map getParameterMap()

validate

public void validate()
              throws MessageException

Checks that all required parameters are present

Throws:

MessageException

getRequiredFields

public List getRequiredFields()

keyValueFormEncoding

public String keyValueFormEncoding()

wwwFormEncoding

public String wwwFormEncoding()

getDestinationUrl

public String getDestinationUrl(boolean httpGet)

Gets the URL where the message should be sent, where applicable. Null for received messages.

Parameters:

httpGet - If true, the wwwFormEncoding() is appended to the destination URL; the return value should be used with a GET-redirect. If false, the verbatim destination URL is returned, which should be used with a FORM POST redirect.

See Also:

wwwFormEncoding()

hasExtension

public boolean hasExtension(String typeUri)

Returns true if the message has parameters for the specified extension type URI.

Parameters:

typeUri - The URI that identifies the extension.

getExtensions

public Set getExtensions()

Gets a set of extension Type URIs that are present in the message.

getExtensionAlias

public String getExtensionAlias(String extensionTypeUri)

Retrieves the extension alias that will be used for the extension identified by the supplied extension type URI.

If the message contains no parameters for the specified extension, null will be returned.

Parameters:

extensionTypeUri - The URI that identifies the extension

Returns:

The extension alias associated with the extension specifid by the Type URI

addExtension

public void addExtension(MessageExtension extension)
                  throws MessageException

Adds a set of extension-specific parameters to a message.

The parameter names must NOT contain the "openid." prefix; it will be generated dynamically, ensuring there are no conflicts between extensions.

Parameters:

extension - A MessageExtension containing parameters to be added to the message

Throws:

MessageException

getExtension

public MessageExtension getExtension(String typeUri)
                              throws MessageException

Gets a MessageExtension for the specified Type URI if an implementation is available, or null otherwise.

The returned object will contain the parameters from the message belonging to the specified extension.

Parameters:

typeUri - The Type URI that identifies a extension.

Throws:

MessageException