votorola.a.web.wic

Class VSession

java.lang.Object

org.apache.wicket.Session

org.apache.wicket.protocol.http.WebSession

VSession

All Implemented Interfaces:

Serializable, IEventSink, IClusterable, ServiceSession

@ThreadSafe
public final class VSession
extends WebSession
implements ServiceSession

A user session in the Wicket web interface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VSession.User An authenticated Wicket user.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	URI_STRIP_PATTERN Pattern to strip from an HTTP URI the mangling that occurs temporarily for new sessions.

Fields inherited from class org.apache.wicket.Session

clientInfo, SESSION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
VSession(WebRequest request, WebResponse _response, VOWicket app) Creates a VSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearUser(VRequestCycle cycle) Clears the authenticated user.
static VSession	get() Returns the session associated with the current thread.
(package private) NavBar.SessionScope	scopeNavBar() The session scope for instances of NavBar.
WP_OpenIDReturn.SessionScope	scopeOpenIDReturn() The session scope for instances of WP_OpenIDReturn, or null if the authenticator is not OpenIDAuthenticator.
WP_Poll.SessionScope	scopePoll() The session scope for instances of WP_Poll.
VoterPage.SessionScope	scopeVoterPage() The session scope for instances of VoterPage.
void	setUser(IDPair id, boolean persistent, TraceNode traceNode, VRequestCycle cycle) Sets the authenticated user.
static String	uriStripped(String uriString) Returns the stripped version of the HTTP URI string if it matches URI_STRIP_PATTERN; otherwise the original string.
VSession.User	user() The authenticated user, or null if the user is unauthenticated.
VSession.User	userOrNobody() The authenticated user, or NOBODY if the user is unauthenticated.
VOWicket	vApplication()

Methods inherited from class org.apache.wicket.protocol.http.WebSession

authenticate, cleanupComponentFeedbackMessages, cleanupFeedbackMessages, getClientInfo, invalidate, newBrowserInfoPage

Methods inherited from class org.apache.wicket.Session

bind, clear, debug, detach, dirty, error, exists, fatal, getApplication, getAttribute, getAttributeNames, getAuthorizationStrategy, getClassResolver, getFeedbackMessages, getId, getLocale, getMetaData, getPageFactory, getPageManager, getSessionStore, getSizeInBytes, getStyle, info, internalDetach, invalidateNow, isCurrentRequestValid, isSessionInvalidated, isTemporary, nextPageId, nextSequenceValue, onEvent, removeAttribute, replaceSession, setAttribute, setClientInfo, setLocale, setMetaData, setStyle, success, warn

Methods inherited from class java.lang.Object

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

Field Detail

URI_STRIP_PATTERN

public static final Pattern URI_STRIP_PATTERN

Pattern to strip from an HTTP URI the mangling that occurs temporarily for new sessions. The stripped version is returned in group 1.

Constructor Detail

VSession

VSession(WebRequest request,
        WebResponse _response,
        VOWicket app)

Creates a VSession.

Method Detail

scopeNavBar

NavBar.SessionScope scopeNavBar()

The session scope for instances of NavBar.

scopeOpenIDReturn

public WP_OpenIDReturn.SessionScope scopeOpenIDReturn()

The session scope for instances of WP_OpenIDReturn, or null if the authenticator is not OpenIDAuthenticator.

scopePoll

public WP_Poll.SessionScope scopePoll()

The session scope for instances of WP_Poll.

scopeVoterPage

public VoterPage.SessionScope scopeVoterPage()

The session scope for instances of VoterPage.

uriStripped

public static final String uriStripped(String uriString)

Returns the stripped version of the HTTP URI string if it matches URI_STRIP_PATTERN; otherwise the original string.

vApplication

public VOWicket vApplication()

See Also:

Session.getApplication()

user

public VSession.User user()

Description copied from interface: ServiceSession

The authenticated user, or null if the user is unauthenticated.

Specified by:

user in interface ServiceSession

setUser

public void setUser(IDPair id,
           boolean persistent,
           TraceNode traceNode,
           VRequestCycle cycle)

Sets the authenticated user.

Throws:

NullPointerException - if 'id' is null.

See Also:

VSession.User.isPersistent(), VSession.User.traceNode(), clearUser(VRequestCycle)

clearUser

public void clearUser(VRequestCycle cycle)

Clears the authenticated user.

See Also:

setUser(IDPair,boolean,TraceNode,VRequestCycle)

userOrNobody

public VSession.User userOrNobody()

Description copied from interface: ServiceSession

The authenticated user, or NOBODY if the user is unauthenticated.

Specified by:

userOrNobody in interface ServiceSession

get

public static VSession get()

Returns the session associated with the current thread. Note that in Wicket 1.5, component.getSession() is no longer faster than this method.

See Also:

Session.get()