org.kohsuke.stapler.openid.client

Class OpenIDSession

java.lang.Object

org.kohsuke.stapler.openid.client.OpenIDSession

All Implemented Interfaces:

Serializable

public class OpenIDSession
extends Object
implements Serializable

Captures the in-progress OpenID authentication session and its result.

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.kohsuke.stapler.AttributeKey<OpenIDSession>	KEY

Constructor Summary

Constructors

Constructor and Description
OpenIDSession(org.openid4java.consumer.ConsumerManager manager, String openid, String thisUrl)

Method Summary

Methods

Modifier and Type	Method and Description
OpenIDIdentity	authenticate() If the user is already authenticated, return the identity information.
void	commence() Starts the login session.
org.kohsuke.stapler.HttpResponse	doFinishLogin(org.kohsuke.stapler.StaplerRequest request) When the identity provider is done with its thing, the user comes back here.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final org.kohsuke.stapler.AttributeKey<OpenIDSession> KEY

Constructor Detail

OpenIDSession

public OpenIDSession(org.openid4java.consumer.ConsumerManager manager,
             String openid,
             String thisUrl)
              throws org.openid4java.OpenIDException,
                     IOException

Parameters:

openid - The identity that the user has claimed, which we are going to validate.

thisUrl - URL that this OpenIDSession object is mapped to. Used to construct the URL to bring the user back to. If this URL starts with '/', it's interpreted as relative to the context path. Otherwise it's assumed to be the absolute URL. It shouldn't end with '/'.

Throws:

org.openid4java.OpenIDException

IOException

Method Detail

authenticate

public OpenIDIdentity authenticate()

If the user is already authenticated, return the identity information. Otherwise start an authentication session (by throwing HttpResponse.)

commence

public void commence()

Starts the login session.

doFinishLogin

public org.kohsuke.stapler.HttpResponse doFinishLogin(org.kohsuke.stapler.StaplerRequest request)
                                               throws IOException,
                                                      org.openid4java.OpenIDException

When the identity provider is done with its thing, the user comes back here.

Throws:

IOException

org.openid4java.OpenIDException