org.openid4java.message.sreg

Class SRegMessage

java.lang.Object

org.openid4java.message.sreg.SRegMessage

All Implemented Interfaces:

MessageExtension, MessageExtensionFactory

Direct Known Subclasses:

SRegRequest, SRegResponse

public class SRegMessage
extends Object
implements MessageExtension, MessageExtensionFactory

Base class for the Simple Registration implementation.

Encapsulates:

• the Type URI that identifies the Simple Registration extension
• a list of extension-specific parameters, with the openid. prefix removed
• methods for handling the extension-specific support of parameters with multpile values

Considering that:

• SREG 1.0 and SREG 1.1 use the same type URI ("http://openid.net/sreg/1.0") in XRDS documents
• The only differences between the two are the hardcoded "sreg" extension alias in SREG1.0 and the openid.ns. namespace declaration in SREG1.1

Support for Simple Registration is implemented as follows:

• Both SREG1.0 and SREG1.1 are implemented using the same extension framework
• In OpenID2 messages only SREG1.1 is accepted, i.e. the namespace declaration (openid.ns.) MUST be present
• For seamless inteoperation, the extension alias is forced to "sreg" for OpenID 2 messages / SREG1.1

Author:

Marius Scurtescu, Johnny Bufu

See Also:

MessageExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected ParameterList	_parameters The Simple Registration extension-specific parameters.
static String	OPENID_NS_SREG The Simple Registration 1.0 namespace URI.
static String	OPENID_NS_SREG11 The Simple Registration 1.1 namespace URI.

Constructor Summary

Constructors

Constructor and Description
SRegMessage() Constructs an empty (no parameters) Simple Registration extension.
SRegMessage(ParameterList params) Constructs an Simple Registration extension with a specified list of parameters.

Method Summary

Methods

Modifier and Type	Method and Description
MessageExtension	getExtension(ParameterList parameterList, boolean isRequest) Instantiates the apropriate Simple Registration object (request / response) for the supplied parameter list.
ParameterList	getParameters() Gets ParameterList containing the Simple Registration extension-specific parameters.
String	getParameterValue(String name) Gets a the value of the parameter with the specified name.
String	getTypeUri() Gets the Type URI that identifies the Simple Registration extension.
String	multivalDecode(String value) Decodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).
String	multivalEncode(String value) Encodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).
boolean	providesIdentifier() Simple Registration doesn't implement authentication services.
void	setParameters(ParameterList params) Sets the extension's parameters to the supplied list.
void	setTypeUri(String typeUri) Sets the SREG type URI.
boolean	signRequired() Simple registration parameters are REQUIRED to be signed.

Methods inherited from class java.lang.Object

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

Field Detail

OPENID_NS_SREG

public static final String OPENID_NS_SREG

The Simple Registration 1.0 namespace URI.

See Also:

Constant Field Values

OPENID_NS_SREG11

public static final String OPENID_NS_SREG11

The Simple Registration 1.1 namespace URI.

See Also:

Constant Field Values

_parameters

protected ParameterList _parameters

The Simple Registration extension-specific parameters.

The openid. prefix is not part of the parameter names

Constructor Detail

SRegMessage

public SRegMessage()

Constructs an empty (no parameters) Simple Registration extension.

SRegMessage

public SRegMessage(ParameterList params)

Constructs an Simple Registration extension with a specified list of parameters.

The parameter names in the list should not contain the openid..

Method Detail

getTypeUri

public String getTypeUri()

Gets the Type URI that identifies the Simple Registration extension.

Specified by:

getTypeUri in interface MessageExtension

Specified by:

getTypeUri in interface MessageExtensionFactory

setTypeUri

public void setTypeUri(String typeUri)

Sets the SREG type URI. Hack to support both SREG 1.0 and 1.1, until 1.1 spec gets fixed.

getParameters

public ParameterList getParameters()

Gets ParameterList containing the Simple Registration extension-specific parameters.

The openid. prefix is not part of the parameter names, as it is handled internally by the Message class.

The openid.ns. parameter is also handled by the Message class.

Specified by:

getParameters in interface MessageExtension

See Also:

Message

setParameters

public void setParameters(ParameterList params)

Sets the extension's parameters to the supplied list.

The parameter names in the list should not contain the openid. prefix.

Specified by:

setParameters in interface MessageExtension

See Also:

Message

getParameterValue

public String getParameterValue(String name)

Gets a the value of the parameter with the specified name.

Parameters:

name - The name of the parameter, without the openid. prefix.

Returns:

The parameter value, or null if not found.

multivalEncode

public String multivalEncode(String value)

Encodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).

Parameters:

value - String value to be encoded.

Returns:

The encoded value.

multivalDecode

public String multivalDecode(String value)

Decodes a string value according to the conventions for supporting multiple values for a parameter (commas and backslashes are escaped).

Parameters:

value - String value to be decoded.

Returns:

The dencoded value.

providesIdentifier

public boolean providesIdentifier()

Simple Registration doesn't implement authentication services.

Specified by:

providesIdentifier in interface MessageExtension

Returns:

false

signRequired

public boolean signRequired()

Simple registration parameters are REQUIRED to be signed.

Specified by:

signRequired in interface MessageExtension

Returns:

true

getExtension

public MessageExtension getExtension(ParameterList parameterList,
                            boolean isRequest)
                              throws MessageException

Instantiates the apropriate Simple Registration object (request / response) for the supplied parameter list.

Specified by:

getExtension in interface MessageExtensionFactory

Parameters:

parameterList - The Simple Registration specific parameters (without the openid. prefix) extracted from the openid message.

isRequest - Indicates whether the parameters were extracted from an OpenID request (true), or from an OpenID response.

Returns:

MessageExtension implementation for the supplied extension parameters.

Throws:

MessageException - If a Simple Registration object could not be instantiated from the supplied parameter list.