votorola.a.web.wic.authen

Class Authenticator

java.lang.Object

Authenticator

Direct Known Subclasses:

OpenIDAuthenticator, WikiAuthenticator

@ThreadSafe
public abstract class Authenticator
extends Object

A facility to verify the identity of a user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRELOGIN_EMAIL The email address to automatically login for each session, as defined by the system property "votorola.a.web.wic.authen.Authenticator.PRELOGIN_EMAIL", or null if there is none.

Constructor Summary

Constructors

Constructor and Description
Authenticator()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) static Class<? extends Page>	extractReturnClass(PageParameters pP) Removes "returnClass" from pP and returns the class it specifies.
abstract Class<? extends VPageHTML>	loginPageClass() The class of login page for this authenticator.
abstract void	logOut() Ensures that the user is logged out.
abstract VPageHTML	newLoginPage(PageParameters pP) Constructs a login page that redirects to a newly constructed, bookmarkable, return page if authentication succeeds.

Methods inherited from class java.lang.Object

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

Field Detail

PRELOGIN_EMAIL

public static final String PRELOGIN_EMAIL

The email address to automatically login for each session, as defined by the system property "votorola.a.web.wic.authen.Authenticator.PRELOGIN_EMAIL", or null if there is none. This is intended for testing in private deployments.

Constructor Detail

Authenticator

public Authenticator()

Method Detail

extractReturnClass

static Class<? extends Page> extractReturnClass(PageParameters pP)

Removes "returnClass" from pP and returns the class it specifies.

loginPageClass

public abstract Class<? extends VPageHTML> loginPageClass()

The class of login page for this authenticator.

logOut

public abstract void logOut()

Ensures that the user is logged out.

newLoginPage

public abstract VPageHTML newLoginPage(PageParameters pP)

Constructs a login page that redirects to a newly constructed, bookmarkable, return page if authentication succeeds. If the return page is a voter page without a specified voter, then pP is altered to specify the newly authenticated user.

Parameters:

pP - The type and parameters of the return page to construct after the login attempt. Parameter "returnClass" specifies the page type, while the remainder of pP is passed to the page instance.