org.kohsuke.stapler.openid.server

Class Session

java.lang.Object

org.kohsuke.stapler.openid.server.Session

public abstract class Session
extends Object

Represents an in-flight OpenID authentication sequence.

For each user going through the OpenID protocol, one instance is created.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
OpenIDServer	server

Constructor Summary

Constructors

Constructor and Description
Session(OpenIDServer server)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.kohsuke.stapler.HttpResponse	authenticateUser(OpenIDIdentity id) When the protocol gets to the point of needing to authenticate the user on the server side, this method is called.
void	doDynamic(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) "/~USERID" is mapped to OpenID.
org.kohsuke.stapler.HttpResponse	doEntryPoint(org.kohsuke.stapler.StaplerRequest request) Landing page for the OpenID protocol.
OpenIDIdentity	getIdentity() Returns the current user's identity.
String	getRealm() A string that represents the client who is requesting an authentication.
String	getReturnTo() URL to send the user back to, once the authentication is complete.
org.kohsuke.stapler.HttpResponse	handleRequest()
protected org.openid4java.message.ax.FetchResponse	respondToAx(org.openid4java.message.ax.FetchRequest req)
protected void	respondToFetchRequest(org.openid4java.message.Message rsp) Responds to the fetch request by adding them.
protected org.openid4java.message.sreg.SRegResponse	respondToSReg(org.openid4java.message.sreg.SRegRequest req)

Methods inherited from class java.lang.Object

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

Field Detail

server

public final OpenIDServer server

Constructor Detail

Session

public Session(OpenIDServer server)

Method Detail

getRealm

public String getRealm()

A string that represents the client who is requesting an authentication. This is either the host name of the client, or in a rare case it is the "openid.realm" attribute.

This value can be trusted, even though it came from the client.

getReturnTo

public String getReturnTo()

URL to send the user back to, once the authentication is complete.

getIdentity

public OpenIDIdentity getIdentity()

Returns the current user's identity. This is the same object that gets passed to authenticateUser(OpenIDIdentity), and is null until the authentication gets to that point.

doEntryPoint

public org.kohsuke.stapler.HttpResponse doEntryPoint(org.kohsuke.stapler.StaplerRequest request)
                                              throws IOException

Landing page for the OpenID protocol.

Throws:

IOException

authenticateUser

protected abstract org.kohsuke.stapler.HttpResponse authenticateUser(OpenIDIdentity id)

When the protocol gets to the point of needing to authenticate the user on the server side, this method is called.

If the user needs to be redirected elsewhere for the server to authenticate (such as sending him to the login page), this method can return a non-null object (for example see HttpResponses.redirectViaContextPath(String)) or throw an HttpResponse as an exception. The caller will use this HttpResponse as a response to the client. After such authentication, the handleRequest() must be called to pick up the OpenID dance where we left off.

If the user is already authenticated on the server side, then the OpenIDIdentity object should be populated with the information about the user, and this method shall return null. In this case, the protocol will continue.

Another common practice is to verify with the user that he actually intended to login to the realm requesting authentication.

handleRequest

public org.kohsuke.stapler.HttpResponse handleRequest()

respondToFetchRequest

protected void respondToFetchRequest(org.openid4java.message.Message rsp)
                              throws org.openid4java.message.MessageException

Responds to the fetch request by adding them. Java.net only gives us the ID, and everything else is just mechanically derived from it, so there's no need to get the confirmation from users for passing them.

Throws:

org.openid4java.message.MessageException

respondToSReg

protected org.openid4java.message.sreg.SRegResponse respondToSReg(org.openid4java.message.sreg.SRegRequest req)
                                                           throws org.openid4java.message.MessageException

Throws:

org.openid4java.message.MessageException

respondToAx

protected org.openid4java.message.ax.FetchResponse respondToAx(org.openid4java.message.ax.FetchRequest req)
                                                        throws org.openid4java.message.MessageException

Throws:

org.openid4java.message.MessageException

doDynamic

public void doDynamic(org.kohsuke.stapler.StaplerRequest req,
             org.kohsuke.stapler.StaplerResponse rsp)
               throws IOException,
                      javax.servlet.ServletException

"/~USERID" is mapped to OpenID.

Throws:

IOException

javax.servlet.ServletException