wicket
Class Session

java.lang.Object
  wicket.Session

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WebSession

public abstract class Session

extends java.lang.Object

implements java.io.Serializable

Holds information about a user session, including some fixed number of most recent pages (and all their nested component information).

• Access via RequestCycle - The Session for a RequestCycle can be retrieved by calling RequestCycle.getSession().
• Access via Component - If a RequestCycle object is not available, the Session can be retrieved for a Component by calling Component.getSession(). As currently implemented, each Component does not itself have a reference to the session that contains it. However, the Page component at the root of the containment hierarchy does have a reference to the Session that holds the Page. So Component.getSession()traverses the component hierarchy to the root Page and then calls Component.getSession().
• Access via Thread Local - In the odd case where neither a RequestCycle nor a Component is available, the currently active Session for the calling thread can be retrieved by calling the static method Session.get(). This last form should only be used if the first two forms cannot be used since thread local access can involve a potentially more expensive hash map lookup.
• Locale - A session has a Locale property to support localization. The Locale for a session can be set by calling setLocale(Locale). The Locale for a Session determines how localized resources are found and loaded.
• Style - Besides having an appearance based on locale, resources can also have different looks in the same locale (a.k.a. "skins"). The style for a session determines the look which is used within the appopriate locale. The session style ("skin") can be set with the setStyle() method.
• Resource Loading - Based on the Session locale and style, searching for resources occurs in the following order (where sourcePath is set via the ApplicationSettings object for the current Application, and style and locale are Session properties):
  1. [sourcePath]/name[style][locale].[extension]
  2. [sourcePath]/name[locale].[extension]
  3. [sourcePath]/name[style].[extension]
  4. [sourcePath]/name.[extension]
  5. [classPath]/name[style][locale].[extension]
  6. [classPath]/name[locale].[extension]
  7. [classPath]/name[style].[extension]
  8. [classPath]/name.[extension]
  
• Session Properties - Arbitrary objects can be attached to a Session by installing a session factory on your Application class which creates custom Session subclasses that have typesafe properties specific to the application (see Applicationfor details). To discourage non-typesafe access to Session properties, no setProperty() or getProperty() method is provided.
• Class Resolver - Sessions have a class resolver ( IClassResolver) implementation that is used to locate classes for components such as pages.
• Page Factory - A pluggable implementation of IPageFactory is used to instantiate pages for the session.
• Removal - Pages can be removed from the Session forcibly by calling remove(Page) or removeAll(), although such an action should rarely be necessary.

  Author:

  Jonathan Locke

  See Also:

  Serialized Form

  Field Summary

  static java.lang.String

  sessionAttributeName Name of session attribute under which this session is stored

  Constructor Summary

  protected

  Session(Application application) Constructor.

  Method Summary

  protected void	add(Page page) Adds page to session if not already added.
  static Session	get() Get the session for the calling thread.
  Application	getApplication() Get the application that is currently working with this session.
  protected abstract java.lang.Object	getAttribute(java.lang.String name)
  protected abstract java.util.List	getAttributeNames()
  IClassResolver	getClassResolver()
  IConverter	getConverter() Gets the converter instance.
  java.util.Locale	getLocale() Get this session's locale.
  Page	getPage(java.lang.String pageMapName, java.lang.String path, int versionNumber) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  IPageFactory	getPageFactory()
  IPageFactory	getPageFactory(Page page)
  PageMap	getPageMap(java.lang.String pageMapName)
  RequestCycle	getRequestCycle() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected abstract IRequestCycleFactory	getRequestCycleFactory()
  java.lang.String	getStyle() Get the style (see Session).
  abstract void	invalidate() Invalidates this session
  PageMap	newPageMap(java.lang.String name) Creates a new page map with a given name
  protected PageState	newPageState(Page page) Gets a PageState record for a given Page.
  RequestCycle	newRequestCycle(Request request, Response response) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  void	remove(Page page) Removes the given page from the cache.
  void	removeAll() Removes all pages from the session.
  protected abstract void	removeAttribute(java.lang.String name)
  static void	set(Session session) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  void	setApplication(Application application) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected abstract void	setAttribute(java.lang.String name, java.lang.Object object)
  void	setLocale(java.util.Locale locale) Set the locale for this session.
  void	setRequestCycle(RequestCycle cycle) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  void	setStyle(java.lang.String style) Set the style (see Session).
  void	updateCluster() Replicates this session to the cluster if it has changed.
  void	updateSession() Updates this session using changed state information that may have been replicated to this node on a cluster.

  Methods inherited from class java.lang.Object

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

  Field Detail

  sessionAttributeName

  public static final java.lang.String sessionAttributeName

  Name of session attribute under which this session is stored

  See Also:

  Constant Field Values

  Constructor Detail

  Session

  protected Session(Application application)

  Constructor.

  Parameters:

  application - The application that this is a session of

  Method Detail

  get

  public static Session get()

  Get the session for the calling thread.

  Returns:

  Session for calling thread

  set

  public static void set(Session session)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Sets session for calling thread.

  Parameters:

  session - The session

  getApplication

  public final Application getApplication()

  Get the application that is currently working with this session.

  Returns:

  Returns the application.

  getClassResolver

  public final IClassResolver getClassResolver()

  Returns:

  The class resolver for this Session

  getConverter

  public final IConverter getConverter()

  Gets the converter instance.

  Returns:

  the converter

  getLocale

  public java.util.Locale getLocale()

  Get this session's locale.

  Returns:

  This session's locale

  getPage

  public final Page getPage(java.lang.String pageMapName,
                            java.lang.String path,
                            int versionNumber)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT. Get the page for the given path.

  Parameters:

  pageMapName - The name of the page map where the page is

  path - Component path

  versionNumber - The version of the page required

  Returns:

  The page based on the first path component (the page id), or null if the requested version of the page cannot be found.

  getPageFactory

  public final IPageFactory getPageFactory()

  Returns:

  The page factory for this session

  getPageFactory

  public final IPageFactory getPageFactory(Page page)

  Parameters:

  page - The page, or null if no page context is available

  Returns:

  The page factory for the page, or the default page factory if page was null

  getPageMap

  public final PageMap getPageMap(java.lang.String pageMapName)

  Parameters:

  pageMapName - Name of page map, or null for default page map

  Returns:

  PageMap for name

  getRequestCycle

  public final RequestCycle getRequestCycle()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Returns:

  The currently active request cycle for this session

  getStyle

  public final java.lang.String getStyle()

  Get the style (see Session).

  Returns:

  Returns the style (see Session)

  invalidate

  public abstract void invalidate()

  Invalidates this session

  newPageMap

  public final PageMap newPageMap(java.lang.String name)

  Creates a new page map with a given name

  Parameters:

  name - The name for the new page map

  Returns:

  The newly created page map

  newRequestCycle

  public final RequestCycle newRequestCycle(Request request,
                                            Response response)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT. Creates a new RequestCycle for the given request and response using the session's request cycle factory.

  Parameters:

  request - The request

  response - The response

  Returns:

  The new request cycle.

  remove

  public final void remove(Page page)

  Removes the given page from the cache. This method may be useful if you have special knowledge that a given page cannot be accessed again. For example, the user may have closed a popup window.

  Parameters:

  page - The page to remove

  removeAll

  public final void removeAll()

  Removes all pages from the session. Although this method should rarely be needed, it is available (possibly for security reasons).

  setApplication

  public final void setApplication(Application application)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.

  Sets the application that this session is associated with.

  Parameters:

  application - The application

  setLocale

  public final void setLocale(java.util.Locale locale)

  Set the locale for this session.

  Parameters:

  locale - New locale

  setRequestCycle

  public final void setRequestCycle(RequestCycle cycle)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT. Sets the currently active request cycle for this session.

  Parameters:

  cycle - The request cycle

  setStyle

  public final void setStyle(java.lang.String style)

  Set the style (see Session).

  Parameters:

  style - The style to set.

  updateCluster

  public void updateCluster()

  Replicates this session to the cluster if it has changed.

  updateSession

  public final void updateSession()

  Updates this session using changed state information that may have been replicated to this node on a cluster.

  add

  protected final void add(Page page)

  Adds page to session if not already added.

  Parameters:

  page - Page to add to this session

  getAttribute

  protected abstract java.lang.Object getAttribute(java.lang.String name)

  Parameters:

  name - The name of the attribute to store

  Returns:

  The value of the attribute

  getAttributeNames

  protected abstract java.util.List getAttributeNames()

  Returns:

  List of attributes for this session

  getRequestCycleFactory

  protected abstract IRequestCycleFactory getRequestCycleFactory()

  Returns:

  Request cycle factory for this kind of session.

  newPageState

  protected PageState newPageState(Page page)

  Gets a PageState record for a given Page. The default, inefficient implementation is to simply wrap the entire Page object. More intimate knowledge of a Page, however, may allow significant compression of state information.

  Parameters:

  page - The page

  Returns:

  The page state record

  removeAttribute

  protected abstract void removeAttribute(java.lang.String name)

  Parameters:

  name - The name of the attribute to remove

  setAttribute

  protected abstract void setAttribute(java.lang.String name,
                                       java.lang.Object object)

  Parameters:

  name - The name of the attribute to store

  object - The attribute value