votorola.a.web.wic.authen

Class WikiAuthenticator

java.lang.Object

Authenticator

WikiAuthenticator

All Implemented Interfaces:

ISessionListener

@ThreadSafe
public final class WikiAuthenticator
extends Authenticator
implements ISessionListener

An authenticator based on the authentication facilities of the pollwiki, enabling synchronized login between it and the Wicket interface. Example configuration for vowicket.js:

   function constructingVOWicket( wicCC )
   {
       wicCC.setAuthenticatorClass(
         Packages.votorola.a.web.wic.authen.WikiAuthenticator );
   }

   function initializingVOWicket( wic )
   {
       wic.authenticator().setCookiePrefix( 'pollwiki' ); }
   }

Pollwiki configuration changes will usually be required in order for this to work correctly. The pollwiki's cookie domain must match the request domain of the Wicket interface. Also the pollwiki must not send the cookies HttpOnly, which is the default mode.

See Also:

Manual:$wgCookieDomain, Manual:$wgCookieHttpOnly, Manual:Configuration_settings#Cookies

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	WikiAuthenticator.FailureMessage A container for a failure message that might or might not be localized.

Field Summary

Fields inherited from class Authenticator

PRELOGIN_EMAIL

Constructor Summary

Constructors

Constructor and Description
WikiAuthenticator(VOWicket _app) Creates a WikiAuthenticator.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) WikiAuthenticator.FailureMessage	authenticateEmail(IDPair wikiUser, CookieHandler cookieRelayer) Compares two email addresses for the wiki user: (1) the email address authenticated by the wiki, and (2) the email address implied by the user identifier.
String	getCookiePrefix() The prefix used by the pollwiki for cookie names.
Class<? extends VPageHTML>	loginPageClass() The class of login page for this authenticator.
void	logOut() Ensures that the user is logged out.
VPageHTML	newLoginPage(PageParameters _pP) Constructs a login page that redirects to a newly constructed, bookmarkable, return page if authentication succeeds.
void	onCreated(Session s)
void	setCookiePrefix(String cP) Sets prefix used by the pollwiki for cookie names.

Methods inherited from class Authenticator

extractReturnClass

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiAuthenticator

public WikiAuthenticator(VOWicket _app)

Creates a WikiAuthenticator.

Method Detail

authenticateEmail

WikiAuthenticator.FailureMessage authenticateEmail(IDPair wikiUser,
                                                 CookieHandler cookieRelayer)
                                             throws VotorolaException

Compares two email addresses for the wiki user: (1) the email address authenticated by the wiki, and (2) the email address implied by the user identifier. Returns null if they match, in which case the caller may accept the user as authenticated for the vote-server. Otherwise returns the localization key of a failure message.

If the user is a pipe, then the implied address (2) is instead effectively taken from the pipe minder's username; while the authenticated address (1) remains that of the pipe user. The comparison is therefore the same as when calling this method to authenticate the pipe minder as herself. But here she is instead authenticated as the pipe. We know it is she because (1) the pipe's email address is privately set to her address, and she has answered the resulting mail challenge. We further require that (2) the minder property of the pipe page be publicly set to her username, so everyone knows who can login as the minder.

Parameters:

wikiUser - who is persistently logged into the wiki via cookies.

cookieRelayer - a cookie handler that 'gets' its cookies from the incoming client request.

Throws:

VotorolaException

See Also:

Category:Pipe

getCookiePrefix

public String getCookiePrefix()

The prefix used by the pollwiki for cookie names.

See Also:

setCookiePrefix(String), Manual:$wgCookiePrefix, Manual:Configuration_settings#Cookies

setCookiePrefix

public void setCookiePrefix(String cP)

Sets prefix used by the pollwiki for cookie names. The default value is "wikidb".

See Also:

getCookiePrefix()

loginPageClass

public Class<? extends VPageHTML> loginPageClass()

Description copied from class: Authenticator

The class of login page for this authenticator.

Specified by:

loginPageClass in class Authenticator

logOut

public void logOut()

Description copied from class: Authenticator

Ensures that the user is logged out.

Specified by:

logOut in class Authenticator

newLoginPage

public VPageHTML newLoginPage(PageParameters _pP)

Description copied from class: Authenticator

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.

Specified by:

newLoginPage in class Authenticator

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.

onCreated

public void onCreated(Session s)

Specified by:

onCreated in interface ISessionListener