org.springframework.security.openid

Class OpenID4JavaConsumer

java.lang.Object

org.springframework.security.openid.OpenID4JavaConsumer

All Implemented Interfaces:

OpenIDConsumer

public class OpenID4JavaConsumer
extends java.lang.Object
implements OpenIDConsumer

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger

Constructor Summary

Constructors

Constructor and Description
OpenID4JavaConsumer()
OpenID4JavaConsumer(AxFetchListFactory attributesToFetchFactory)
OpenID4JavaConsumer(ConsumerManager consumerManager, AxFetchListFactory attributesToFetchFactory)

Method Summary

Modifier and Type	Method and Description
java.lang.String	beginConsumption(HttpServletRequest req, java.lang.String identityUrl, java.lang.String returnToUrl, java.lang.String realm) Given the request, the claimedIdentity, the return to url, and a realm, lookup the openId authentication page the user should be redirected to.
OpenIDAuthenticationToken	endConsumption(HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

Constructor Detail

OpenID4JavaConsumer

public OpenID4JavaConsumer()
                    throws ConsumerException

Throws:

ConsumerException

OpenID4JavaConsumer

public OpenID4JavaConsumer(AxFetchListFactory attributesToFetchFactory)
                    throws ConsumerException

Throws:

ConsumerException

OpenID4JavaConsumer

public OpenID4JavaConsumer(ConsumerManager consumerManager,
                           AxFetchListFactory attributesToFetchFactory)
                    throws ConsumerException

Throws:

ConsumerException

Method Detail

beginConsumption

public java.lang.String beginConsumption(HttpServletRequest req,
                                         java.lang.String identityUrl,
                                         java.lang.String returnToUrl,
                                         java.lang.String realm)
                                  throws OpenIDConsumerException

Description copied from interface: OpenIDConsumer

Given the request, the claimedIdentity, the return to url, and a realm, lookup the openId authentication page the user should be redirected to.

Specified by:

beginConsumption in interface OpenIDConsumer

Parameters:

req - HttpServletRequest

identityUrl - String URI the user presented during authentication

returnToUrl - String URI of the URL we want the user sent back to by the OP

realm - URI pattern matching the realm we want the user to see

Returns:

String URI to redirect user to for authentication

Throws:

OpenIDConsumerException - if anything bad happens

endConsumption

public OpenIDAuthenticationToken endConsumption(HttpServletRequest request)
                                         throws OpenIDConsumerException

Specified by:

endConsumption in interface OpenIDConsumer

Throws:

OpenIDConsumerException