org.picketlink.social.standalone.openid.providers.helpers

Class OpenIDProtocolContext

java.lang.Object

org.picketlink.social.standalone.openid.providers.helpers.OpenIDProtocolContext

All Implemented Interfaces:

ProtocolContext

public class OpenIDProtocolContext
extends Object
implements ProtocolContext

ProtocolContext for the OpenID Layer

Since:

Jan 20, 2011

Author:

Anil.Saldhana@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenIDProtocolContext.AUTH_HOLDER Class to hold the information for authentication requests
static class	OpenIDProtocolContext.MODE An Enum indicating the OpenID mode

Field Summary

Fields

Modifier and Type	Field and Description
protected OpenIDProtocolContext.AUTH_HOLDER	authenticationHolder STS uses the AUTH_HOLDER information for processing authentication requests
protected String	endpoint The Server Manager needs an endpoint
protected String	errorText What is the text the STS should use for the error?
protected Boolean	issueError Should the STS issue an error?
protected OpenIDProtocolContext.MODE	mode The OpenID mode
static String	OPENID_1_0_NS
static String	OPENID_1_1_NS
static String	OPENID_2_0_NS
protected OpenIDParameterList	requestParameterList The list of request parameters for use by the STS
protected OpenIDProviderManager.OpenIDMessage	responseMessage The response message generated by the STS

Constructor Summary

Constructors

Constructor and Description
OpenIDProtocolContext()

Method Summary

Methods

Modifier and Type	Method and Description
String	family()
OpenIDProtocolContext.AUTH_HOLDER	getAuthenticationHolder() Get the holder of authentication information
String	getEndpoint() Get the endpoint address
String	getErrorText() Get the error text (Null by default)
Boolean	getIssueError() Should the STS issue an error response token
OpenIDProtocolContext.MODE	getMode() Get the Open ID mode
QName	getQName()
OpenIDParameterList	getRequestParameterList() Get the request parameter list
OpenIDProviderManager.OpenIDMessage	getResponseMessage() Get the OpenIDMessage response message that the STS has generated
String	serviceName()
void	setAuthenticationHolder(OpenIDProtocolContext.AUTH_HOLDER authenticationHolder) Set an authentication holder
void	setEndpoint(String endpoint) Set the endpoint address
void	setErrorText(String errorText) Set the error text
void	setIssueError(Boolean issueError) Set the error response token for the STS
void	setMode(OpenIDProtocolContext.MODE theMode) Set the OpenID mode
void	setRequestParameterList(OpenIDParameterList requestParameterList) Set the request parameter list
void	setResponseMessage(OpenIDProviderManager.OpenIDMessage responseMessage) Set the OpenIDMessage response message
String	tokenType()

Methods inherited from class java.lang.Object

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

Field Detail

OPENID_1_0_NS

public static final String OPENID_1_0_NS

See Also:

Constant Field Values

OPENID_1_1_NS

public static final String OPENID_1_1_NS

See Also:

Constant Field Values

OPENID_2_0_NS

public static final String OPENID_2_0_NS

See Also:

Constant Field Values

responseMessage

protected OpenIDProviderManager.OpenIDMessage responseMessage

The response message generated by the STS

requestParameterList

protected OpenIDParameterList requestParameterList

The list of request parameters for use by the STS

endpoint

protected String endpoint

The Server Manager needs an endpoint

issueError

protected Boolean issueError

Should the STS issue an error?

errorText

protected String errorText

What is the text the STS should use for the error?

mode

protected OpenIDProtocolContext.MODE mode

The OpenID mode

authenticationHolder

protected OpenIDProtocolContext.AUTH_HOLDER authenticationHolder

STS uses the AUTH_HOLDER information for processing authentication requests

Constructor Detail

OpenIDProtocolContext

public OpenIDProtocolContext()

Method Detail

getAuthenticationHolder

public OpenIDProtocolContext.AUTH_HOLDER getAuthenticationHolder()

Get the holder of authentication information

Returns:

setAuthenticationHolder

public void setAuthenticationHolder(OpenIDProtocolContext.AUTH_HOLDER authenticationHolder)

Set an authentication holder

Parameters:

authenticationHolder -

getMode

public OpenIDProtocolContext.MODE getMode()

Get the Open ID mode

Returns:

setMode

public void setMode(OpenIDProtocolContext.MODE theMode)

Set the OpenID mode

Parameters:

theMode -

getErrorText

public String getErrorText()

Get the error text (Null by default)

Returns:

setErrorText

public void setErrorText(String errorText)

Set the error text

Parameters:

errorText -

getIssueError

public Boolean getIssueError()

Should the STS issue an error response token

Returns:

setIssueError

public void setIssueError(Boolean issueError)

Set the error response token for the STS

Parameters:

issueError -

getEndpoint

public String getEndpoint()

Get the endpoint address

Returns:

setEndpoint

public void setEndpoint(String endpoint)

Set the endpoint address

Parameters:

endpoint -

getRequestParameterList

public OpenIDParameterList getRequestParameterList()

Get the request parameter list

Returns:

an instanceof OpenIDParameterList

setRequestParameterList

public void setRequestParameterList(OpenIDParameterList requestParameterList)

Set the request parameter list

Parameters:

requestParameterList - an instanceof OpenIDParameterList

getResponseMessage

public OpenIDProviderManager.OpenIDMessage getResponseMessage()

Get the OpenIDMessage response message that the STS has generated

Returns:

setResponseMessage

public void setResponseMessage(OpenIDProviderManager.OpenIDMessage responseMessage)

Set the OpenIDMessage response message

Parameters:

responseMessage -

serviceName

public String serviceName()

Specified by:

serviceName in interface ProtocolContext

See Also:

ProtocolContext.serviceName()

tokenType

public String tokenType()

Specified by:

tokenType in interface ProtocolContext

See Also:

ProtocolContext.tokenType()

getQName

public QName getQName()

Specified by:

getQName in interface ProtocolContext

See Also:

ProtocolContext.getQName()

family

public String family()

Specified by:

family in interface ProtocolContext

See Also:

ProtocolContext.family()