org.jboss.seam.security.external.spi

Interface OpenIdRelyingPartySpi

public interface OpenIdRelyingPartySpi

Interface that needs to be implemented by applications that want to act as an OpenID Relying Party. It is the counterpart of the OpenIdRelyingPartyApi.

Most methods in this interface have a responseHolder parameter, which contains the HTTP response. This is a way of handing over the control over the browser to the application. The application is responsible for writing the response (either a normal HTML response, or an error, or a redirect). Typically, the application will redirect the user to a URL within the application.

Author:

Marcel Kolsteren

Method Summary

Methods

Modifier and Type	Method and Description
void	loginFailed(String message, ResponseHolder responseHolder) This method is called after failed external authentication of the user.
void	loginSucceeded(OpenIdPrincipal principal, ResponseHolder responseHolder) This method is called after successful external authentication of the user.

Method Detail

loginSucceeded

void loginSucceeded(OpenIdPrincipal principal,
                  ResponseHolder responseHolder)

This method is called after successful external authentication of the user. The principal contains the details about the user. The call takes place in the same dialogue context as the corresponding API call: OpenIdRelyingPartyApi.login(java.lang.String, java.util.List<org.jboss.seam.security.external.openid.api.OpenIdRequestedAttribute>, javax.servlet.http.HttpServletResponse). The dialogue can be used, for example, to store the page that the user requested, so that the user can be redirected to this page after login took place.

Parameters:

principal - principal

responseHolder - object holding the HTTP servlet response

loginFailed

void loginFailed(String message,
               ResponseHolder responseHolder)

This method is called after failed external authentication of the user. The call takes place in the same dialogue context as the corresponding API call: OpenIdRelyingPartyApi.login(java.lang.String, java.util.List<org.jboss.seam.security.external.openid.api.OpenIdRequestedAttribute>, javax.servlet.http.HttpServletResponse).

Parameters:

message - reason why the login failed

responseHolder - object holding the HTTP servlet response