votorola.a.web.wic.authen

Class WP_OpenIDLogin

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.Page

org.apache.wicket.markup.html.WebPage

VPage

VPageHTML

LoginPage

WP_OpenIDLogin

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IRedirectListener, IRequestListener, IHeaderContributor, IManageablePage, IRequestableComponent, IRequestablePage, IHierarchical<Component>

@ThreadRestricted(value="wicket")
public final class WP_OpenIDLogin
extends LoginPage

An OpenID login page. It provides the option of logging in by OpenID or email authentication. In the latter case, this page performs the same function as WP_EmailAuthen1.

The constructer accepts a request cycle runner as an argument, to handle any post-login processing. The runner will be called exactly once if authentication terminates, either successfully or by cancellation. Typically, the runner is coded to set a response page for the user.

See Also:

WP_OpenIDLogin.html, Serialized Form

Field Summary

Fields inherited from class LoginPage

COOKIE_PERSIST_BUTTON

Fields inherited from class VPageHTML

CACHE_DURATION_YEAR

Fields inherited from class VPage

SHORT_STRING_LENGTH_MAX

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Fields inherited from interface org.apache.wicket.IRedirectListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
WP_OpenIDLogin(PageParameters pP) Constructs a WP_OpenIDLogin that redirects to a newly constructed, bookmarkable, return page if authentication succeeds.
WP_OpenIDLogin(WP_OpenIDLogin previousLoginPage, String previousFailureString) Constructs a WP_OpenIDLogin that continues from a previous, failed authentication attempt.

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearPersistence(String userEmail, VRequestCycle cycle) Clears any cookie-persisted authentication.
(package private) boolean	isPersistent() Answers whether a successful authentication is to be persisted in client cookies.
(package private) boolean	isReauthenticationRequested() Answers whether the user is requesting reauthentication of his/her email address.
(package private) DiscoveryInformation	openIDDiscoveryInformation() The results of discovery on the user's OpenID, if any.
(package private) static void	persistPersistButton(boolean state, WebResponse resW) Persists the state of the "keep me logged in" button in a cookie.
void	renderHead(IHeaderResponse r)
(package private) RequestCycleRunner	requestCycleRunner() The runner to do any post-login processing, such as redirecting back to the original referring page.
(package private) static void	setUserInSession(String email, String _method, boolean _persistent, VRequestCycle _cycle) Sets the newly authenticated user in the session without replacing it.

Methods inherited from class LoginPage

respondWithReturnPage, setUserInSession

Methods inherited from class VPageHTML

appendStyleClass, getCacheDuration, getPageIcon, inputLengthConstrained, invalidStyled, isCacheable, newLabelNBSP, newNullComponentAsLabel, newPagingNavigator, setCacheable, setCacheDuration, setHeaders, setPageIcon

Methods inherited from class VPage

emailAddressValidator, inputLengthValidator, newBodyOnlyFragment, newNullComponent, shortened, shortenedWords, stringNonEmpty, stringRequired, vApplication, vRequestCycle

Methods inherited from class org.apache.wicket.markup.html.WebPage

configureResponse, dirty, getMarkupType, homePageLink, onAfterRender, onRender, renderXmlDecl

Methods inherited from class org.apache.wicket.Page

componentChanged, componentRendered, detachModels, dirty, endComponentRender, getAutoIndex, getId, getPageClass, getPageId, getPageParameters, getPageReference, getRenderCount, getSizeInBytes, getStatelessHint, hierarchyAsString, internalOnModelChanged, internalPrepareForRender, isBookmarkable, isErrorPage, isPageStateless, onBeforeRender, onDetach, onRedirect, renderPage, setFreezePageId, setNumericId, setStatelessHint, setWasCreatedBookmarkable, startComponentRender, toString, wasCreatedBookmarkable, wasRendered

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFeedbackMessages, getFlag, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onComponentTag, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.request.component.IRequestableComponent

canCallListenerInterface, detach, get, getBehaviorById, getBehaviorId, getPage, getPageRelativePath

Methods inherited from interface org.apache.wicket.page.IManageablePage

detach

Constructor Detail

WP_OpenIDLogin

public WP_OpenIDLogin(PageParameters pP)

Constructs a WP_OpenIDLogin that redirects to a newly constructed, bookmarkable, return page if authentication succeeds.

See Also:

LoginPage.respondWithReturnPage(org.apache.wicket.request.cycle.RequestCycle)

WP_OpenIDLogin

WP_OpenIDLogin(WP_OpenIDLogin previousLoginPage,
              String previousFailureString)

Constructs a WP_OpenIDLogin that continues from a previous, failed authentication attempt. Called by WP_OpenIDReturn.

Parameters:

previousLoginPage - the login page of the previous, failed authentication attempt.

previousFailureString - a message to present to the user relating the failure of the previous authentication attempt.

Method Detail

clearPersistence

public static void clearPersistence(String userEmail,
                    VRequestCycle cycle)

Clears any cookie-persisted authentication.

isPersistent

boolean isPersistent()

Answers whether a successful authentication is to be persisted in client cookies.

See Also:

VSession.User.isPersistent()

isReauthenticationRequested

boolean isReauthenticationRequested()

Answers whether the user is requesting reauthentication of his/her email address. This is false when the page is yet unsubmitted.

openIDDiscoveryInformation

DiscoveryInformation openIDDiscoveryInformation()

The results of discovery on the user's OpenID, if any.

Returns:

the discovery information, or null if nothing yet discovered.

persistPersistButton

static void persistPersistButton(boolean state,
                        WebResponse resW)

Persists the state of the "keep me logged in" button in a cookie.

See Also:

LoginPage.COOKIE_PERSIST_BUTTON

requestCycleRunner

RequestCycleRunner requestCycleRunner()

The runner to do any post-login processing, such as redirecting back to the original referring page. If the authentication is successful, it is guaranteed to run; otherwise it may or may not.

Returns:

the runner, which is never null.

setUserInSession

static void setUserInSession(String email,
                    String _method,
                    boolean _persistent,
                    VRequestCycle _cycle)

Sets the newly authenticated user in the session without replacing it. The session is not replaced here because going back to this login page after OpenID authentication alters the navigation history by removing the forward pages (Wicket 1.5.4) such that the user cannot return to them.

Parameters:

_method - the name of the authentication method for logging purposes.

See Also:

isPersistent()

renderHead

public void renderHead(IHeaderResponse r)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class VPageHTML