org.openid4java.message.pape

Class PapeMessage

java.lang.Object

org.openid4java.message.pape.PapeMessage

All Implemented Interfaces:

MessageExtension, MessageExtensionFactory

Direct Known Subclasses:

PapeRequest, PapeResponse

public class PapeMessage
extends Object
implements MessageExtension, MessageExtensionFactory

Base class for the OpenID Provider Authentication Policy extension implementation.

Encapsulates:

• the Type URI that identifies the OpenID Provider Authentication Policy extension
• a list of extension-specific parameters, with the openid. prefix removed

Author:

Marius Scurtescu, Johnny Bufu

See Also:

MessageExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected ParameterList	_parameters The OpenID Provider Authentication Policy extension-specific parameters.
protected static String	AUTH_LEVEL_NS_PREFIX
protected static String	AUTH_LEVEL_PREFIX
protected Map	authLevelAliases
static String	OPENID_NS_PAPE The OpenID Provider Authentication Policy extension URI.
static String	PAPE_POLICY_MULTI_FACTOR
static String	PAPE_POLICY_MULTI_FACTOR_PHYSICAL
static String	PAPE_POLICY_PHISHING_RESISTANT

Constructor Summary

Constructors

Constructor and Description
PapeMessage() Constructs an empty (no parameters) OpenID Provider Authentication Policy extension.
PapeMessage(ParameterList params) Constructs an OpenID Provider Authentication Policy extension with a specified list of parameters.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	addAuthLevelExtension(String authLevelTypeUri)
protected String	getCustomAuthLevelAlias(String authLevelTypeUri)
MessageExtension	getExtension(ParameterList parameterList, boolean isRequest) Instantiates the apropriate OpenID Provider Authentication Policy extension object (request / response) for the supplied parameter list.
protected Parameter	getParameter(String name) Gets a the value of the parameter with the specified name.
ParameterList	getParameters() Gets ParameterList containing the OpenID Provider Authentication Policy 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 OpenID Provider Authentication Policy extension.
boolean	hasCustomAuthLevel(String authLevelTypeUri)
boolean	hasParameter(String name) Checks if the extension contains a parameter.
boolean	providesIdentifier() OpenID Provider Authentication Policy extension doesn't implement authentication services.
protected void	set(String name, String value) Sets the value for the parameter with the specified name.
void	setParameters(ParameterList params) Sets the extension's parameters to the supplied list.
boolean	signRequired() PAPE 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

PAPE_POLICY_PHISHING_RESISTANT

public static final String PAPE_POLICY_PHISHING_RESISTANT

See Also:

Constant Field Values

PAPE_POLICY_MULTI_FACTOR

public static final String PAPE_POLICY_MULTI_FACTOR

See Also:

Constant Field Values

PAPE_POLICY_MULTI_FACTOR_PHYSICAL

public static final String PAPE_POLICY_MULTI_FACTOR_PHYSICAL

See Also:

Constant Field Values

AUTH_LEVEL_PREFIX

protected static final String AUTH_LEVEL_PREFIX

See Also:

Constant Field Values

AUTH_LEVEL_NS_PREFIX

protected static final String AUTH_LEVEL_NS_PREFIX

See Also:

Constant Field Values

authLevelAliases

protected Map authLevelAliases

OPENID_NS_PAPE

public static final String OPENID_NS_PAPE

The OpenID Provider Authentication Policy extension URI.

See Also:

Constant Field Values

_parameters

protected ParameterList _parameters

The OpenID Provider Authentication Policy extension-specific parameters.

The openid. prefix is not part of the parameter names

Constructor Detail

PapeMessage

public PapeMessage()

Constructs an empty (no parameters) OpenID Provider Authentication Policy extension.

PapeMessage

public PapeMessage(ParameterList params)

Constructs an OpenID Provider Authentication Policy 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 OpenID Provider Authentication Policy extension.

Specified by:

getTypeUri in interface MessageExtension

Specified by:

getTypeUri in interface MessageExtensionFactory

getParameters

public ParameterList getParameters()

Gets ParameterList containing the OpenID Provider Authentication Policy 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

hasParameter

public boolean hasParameter(String name)

Checks if the extension contains a parameter.

Parameters:

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

Returns:

True if a parameter with the specified name exists, false otherwise.

set

protected void set(String name,
       String value)

Sets the value for the parameter with the specified name.

Parameters:

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

addAuthLevelExtension

protected String addAuthLevelExtension(String authLevelTypeUri)

hasCustomAuthLevel

public boolean hasCustomAuthLevel(String authLevelTypeUri)

getCustomAuthLevelAlias

protected String getCustomAuthLevelAlias(String authLevelTypeUri)

getParameter

protected Parameter getParameter(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.

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.

providesIdentifier

public boolean providesIdentifier()

OpenID Provider Authentication Policy extension doesn't implement authentication services.

Specified by:

providesIdentifier in interface MessageExtension

Returns:

false

signRequired

public boolean signRequired()

PAPE parameters are REQUIRED to be signed.

Specified by:

signRequired in interface MessageExtension

Returns:

getExtension

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

Instantiates the apropriate OpenID Provider Authentication Policy extension object (request / response) for the supplied parameter list.

Specified by:

getExtension in interface MessageExtensionFactory

Parameters:

parameterList - The OpenID Provider Authentication Policy extension 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 OpenID Provider Authentication Policy extension object could not be instantiated from the supplied parameter list.