org.springframework.security.openid

Interface OpenIDConsumer

All Known Implementing Classes:

OpenID4JavaConsumer

public interface OpenIDConsumer

An interface for OpenID library implementations

Method Summary

Modifier and Type	Method and Description
String	beginConsumption(javax.servlet.http.HttpServletRequest req, String claimedIdentity, String returnToUrl, 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(javax.servlet.http.HttpServletRequest req)

Method Detail

beginConsumption

String beginConsumption(javax.servlet.http.HttpServletRequest req,
                        String claimedIdentity,
                        String returnToUrl,
                        String realm)
                 throws OpenIDConsumerException

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

Parameters:

req - HttpServletRequest

claimedIdentity - 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

OpenIDAuthenticationToken endConsumption(javax.servlet.http.HttpServletRequest req)
                                  throws OpenIDConsumerException

Throws:

OpenIDConsumerException