com.helger.photon.basic.app

Class PhotonSessionState

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.web.scope.singleton.AbstractSessionWebSingleton

com.helger.photon.basic.app.PhotonSessionState

All Implemented Interfaces:

com.helger.commons.scope.IScopeDestructionAware, com.helger.web.scope.singleton.IWebSingleton, Serializable

@ThreadSafe
public final class PhotonSessionState
extends com.helger.web.scope.singleton.AbstractSessionWebSingleton

This class maintains ph-oton specific settings within a session.

Since:

6.1.0

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.commons.scope.singleton.AbstractSingleton

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
PhotonSessionState() Deprecated.

Method Summary

Modifier and Type	Method and Description
static PhotonSessionState	getInstance()
static PhotonSessionState	getInstanceIfInstantiated()
String	getLastApplicationID()
Locale	getSelectedLocale(String sApplicationID)
static Locale	getSelectedLocaleOfCurrentSession(String sApplicationID)
IMenuItemPage	getSelectedMenuItem(String sApplicationID)
String	getSelectedMenuItemID(String sApplicationID)
static String	getSelectedMenuItemIDOfCurrentSession(String sApplicationID)
static IMenuItemPage	getSelectedMenuItemOfCurrentSession(String sApplicationID)
boolean	hasLastApplicationID()
void	setLastApplicationID(String sLastApplicationID) Set the last used application ID of an application servlet.
void	setSelectedLocale(String sApplicationID, Locale aLocale)
void	setSelectedMenuItem(String sApplicationID, IMenuItemPage aMenuItem)
String	toString()

Methods inherited from class com.helger.web.scope.singleton.AbstractSessionWebSingleton

getAllSessionSingletons, getSessionSingleton, getSessionSingletonIfInstantiated, isSessionSingletonInstantiated

Methods inherited from class com.helger.commons.scope.singleton.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInPreDestruction, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onBeforeDestroy, onBeforeScopeDestruction, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInPreDestruction, setInstantiated, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Constructor Detail

PhotonSessionState

@Deprecated
 @UsedViaReflection
public PhotonSessionState()

Deprecated.

Method Detail

getInstance

@Nonnull
public static PhotonSessionState getInstance()

Returns:

The one and only instance for the current session. Never null.

See Also:

getInstanceIfInstantiated()

getInstanceIfInstantiated

@Nullable
public static PhotonSessionState getInstanceIfInstantiated()

Returns:

The one and only instance for the current session. It may be null if this singleton was not yet instantiated.

See Also:

getInstance()

getLastApplicationID

@Nullable
public String getLastApplicationID()

Returns:

The last application ID used for the application servlet. May be null.

hasLastApplicationID

public boolean hasLastApplicationID()

Returns:

true if the last used application IDis present, false otherwise.

setLastApplicationID

public void setLastApplicationID(@Nullable
                                 String sLastApplicationID)

Set the last used application ID of an application servlet.

Parameters:

sLastApplicationID - The last application ID to be set. May be null.

getSelectedMenuItem

@Nullable
public IMenuItemPage getSelectedMenuItem(@Nullable
                                                    String sApplicationID)

getSelectedMenuItemID

@Nullable
public String getSelectedMenuItemID(@Nullable
                                               String sApplicationID)

getSelectedMenuItemOfCurrentSession

@Nullable
public static IMenuItemPage getSelectedMenuItemOfCurrentSession(@Nullable
                                                                           String sApplicationID)

getSelectedMenuItemIDOfCurrentSession

@Nullable
public static String getSelectedMenuItemIDOfCurrentSession(@Nullable
                                                                      String sApplicationID)

setSelectedMenuItem

public void setSelectedMenuItem(@Nonnull @Nonempty
                                String sApplicationID,
                                @Nonnull
                                IMenuItemPage aMenuItem)

getSelectedLocale

@Nullable
public Locale getSelectedLocale(@Nullable
                                           String sApplicationID)

getSelectedLocaleOfCurrentSession

@Nullable
public static Locale getSelectedLocaleOfCurrentSession(@Nullable
                                                                  String sApplicationID)

setSelectedLocale

public void setSelectedLocale(@Nonnull @Nonempty
                              String sApplicationID,
                              @Nonnull
                              Locale aLocale)

toString

public String toString()

Overrides:

toString in class com.helger.commons.scope.singleton.AbstractSingleton