org.wicketstuff.security

Class WaspSession

java.lang.Object

org.apache.wicket.Session

org.apache.wicket.protocol.http.WebSession

org.wicketstuff.security.WaspSession

All Implemented Interfaces:

Serializable, org.apache.wicket.event.IEventSink, org.apache.wicket.util.io.IClusterable

public class WaspSession
extends org.apache.wicket.protocol.http.WebSession

Session for keeping the session scoped IAuthorizationStrategy and for providing easy access to login, logoff and isAuthenticated.

Author:

marrink

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Session

clientInfo, SESSION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
WaspSession(WaspApplication application, org.apache.wicket.request.Request request)

Method Summary

Methods

Modifier and Type	Method and Description
void	detach()
org.apache.wicket.authorization.IAuthorizationStrategy	getAuthorizationStrategy() Returns a session scoped WaspAuthorizationStrategy.
void	invalidateNow() Cleans up the WaspAuthorizationStrategy before killing this session.
boolean	isUserAuthenticated() Quick check if any user at all is currently authenticated.
void	login(Object context) Attempts to login with the current login info.
boolean	logoff(Object context) Attempts to log off the current user.

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

get, getClientInfo, invalidate, newBrowserInfoPage

Methods inherited from class org.apache.wicket.Session

bind, clear, debug, dirty, dirty, error, exists, fatal, getApplication, getAttribute, getAttributeNames, getClassResolver, getFeedbackMessages, getId, getLocale, getMetaData, getPageFactory, getPageManager, getSessionStore, getSizeInBytes, getStyle, info, internalDetach, isSessionInvalidated, isTemporary, newPageAccessSynchronizer, nextPageId, nextSequenceValue, onEvent, onInvalidate, 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

Constructor Detail

WaspSession

public WaspSession(WaspApplication application,
           org.apache.wicket.request.Request request)

Method Detail

getAuthorizationStrategy

public org.apache.wicket.authorization.IAuthorizationStrategy getAuthorizationStrategy()

Returns a session scoped WaspAuthorizationStrategy.

Overrides:

getAuthorizationStrategy in class org.apache.wicket.Session

See Also:

Session.getAuthorizationStrategy()

login

public void login(Object context)
           throws LoginException

Attempts to login with the current login info.

Parameters:

context - any type of information required to login

Throws:

LoginException

See Also:

WaspAuthorizationStrategy.login(Object)

logoff

public boolean logoff(Object context)

Attempts to log off the current user. Even though this call Already handles dirty flags. The WaspAuthorizationStrategy should also do the same as it is not guaranteed that every logoff comes from the session.

Parameters:

context - the context to use for logging off

Returns:

true, if the logoff was successful, false otherwise

See Also:

WaspAuthorizationStrategy.logoff(Object)

isUserAuthenticated

public boolean isUserAuthenticated()

Quick check if any user at all is currently authenticated.

Returns:

true if an authenticated user is present, false otherwise

invalidateNow

public void invalidateNow()

Cleans up the WaspAuthorizationStrategy before killing this session. If you override this method you must call super.invalidateNow().

Overrides:

invalidateNow in class org.apache.wicket.Session

See Also:

Session.invalidateNow()

detach

public void detach()

Overrides:

detach in class org.apache.wicket.Session

See Also:

Session.detach()