com.atlassian.crowd.openid.client.consumer

Interface CrowdConsumer

All Known Implementing Classes:

OpenID4JavaConsumer

public interface CrowdConsumer

A generic interface for the Relying Party aka OpenID Consumer aka OpenID Client. Implementations are required to be able to authenticate a request and verify the response to the OpenID Provider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPENID_AUTH_CUSTOM_REALM
static String	OPENID_AUTH_REQUEST
static String	OPENID_AUTH_RESPONSE
static String	OPENID_RETURN_TO_URL

Method Summary

Modifier and Type	Method and Description
void	authenticateRequest(OpenIDAuthRequest openidReq, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Makes a request to an OpenIDProvider to authenticate a particular identifier.
OpenIDAuthResponse	verifyResponse(javax.servlet.http.HttpServletRequest request) Verifies an OpenID response from the OpenID server.

Field Detail

OPENID_AUTH_RESPONSE

static final String OPENID_AUTH_RESPONSE

OPENID_AUTH_REQUEST

static final String OPENID_AUTH_REQUEST

OPENID_AUTH_CUSTOM_REALM

static final String OPENID_AUTH_CUSTOM_REALM

OPENID_RETURN_TO_URL

static final String OPENID_RETURN_TO_URL

Method Detail

authenticateRequest

void authenticateRequest(OpenIDAuthRequest openidReq,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws OpenIDAuthRequestException

Makes a request to an OpenIDProvider to authenticate a particular identifier. The details of the It is responsible for sending a redirect, and thus handing over control to the OpenID Provider. The eventual response (resulting redirect from the OpenIDProvider and any other processing on the server side) should go to the return URL specified in the OpenIDAuthRequest object.

Parameters:

openidReq - contains all OpenID request data.

request - HttpServletRequest object.

response - HttpServletResponse object.

Throws:

OpenIDAuthRequestException - if an error occurs while making the request.

verifyResponse

OpenIDAuthResponse verifyResponse(javax.servlet.http.HttpServletRequest request)

Verifies an OpenID response from the OpenID server.

Parameters:

request - HttpServletRequest object.

Returns:

response object containing principal details or an error message.