com.helger.photon.basic.app.request

Class RequestParameterManager

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.web.scope.singleton.AbstractGlobalWebSingleton

com.helger.photon.basic.app.request.RequestParameterManager

All Implemented Interfaces:

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

@NotThreadSafe
public class RequestParameterManager
extends com.helger.web.scope.singleton.AbstractGlobalWebSingleton
implements IRequestParameterManager

This class holds the per-request configuration settings.

• Menu item to show
• Display locale

Since:

7.0.2

Author:

Philip Helger

Field Summary

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

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
RequestParameterManager() Deprecated.

Method Summary

Modifier and Type	Method and Description
static RequestParameterManager	getInstance()
com.helger.commons.url.SimpleURL	getLinkToMenuItem(String sApplicationID, com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, Locale aDisplayLocale, String sMenuItemID)
String	getLocaleFromURL(com.helger.commons.url.ISimpleURL aURL)
String	getMenuItemFromURL(com.helger.commons.url.ISimpleURL aURL)
IRequestParameterHandler	getParameterHandler()
Locale	getRequestDisplayLocale() Get the locale to be used for this request.
IMenuItemPage	getRequestMenuItem() Resolve the request parameter for the menu item to an IMenuItem object.
Locale	getSessionDisplayLocale() Get the locale stored in the session.
IMenuItemPage	getSessionMenuItem()
void	onRequestBegin(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, String sApplicationID) To be called upon the beginning of each request.
void	setParameterHandler(IRequestParameterHandler aRequestParameterHdl)
String	toString()

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

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

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

Methods inherited from interface com.helger.photon.basic.app.request.IRequestParameterManager

getLinkToMenuItem, getRequestDisplayCountry, getRequestDisplayLanguage, getRequestMenuItemID

Constructor Detail

RequestParameterManager

@Deprecated
 @UsedViaReflection
public RequestParameterManager()

Deprecated.

Method Detail

getInstance

@Nonnull
public static RequestParameterManager getInstance()

getParameterHandler

@Nonnull
public final IRequestParameterHandler getParameterHandler()

Specified by:

getParameterHandler in interface IRequestParameterManager

setParameterHandler

public final void setParameterHandler(@Nonnull
                                      IRequestParameterHandler aRequestParameterHdl)

Specified by:

setParameterHandler in interface IRequestParameterManager

onRequestBegin

public void onRequestBegin(@Nonnull
                           com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                           @Nonnull @Nonempty
                           String sApplicationID)

Description copied from interface: IRequestParameterManager

To be called upon the beginning of each request. Extracts the locale and menu item parameter from the request URL.

Specified by:

onRequestBegin in interface IRequestParameterManager

Parameters:

aRequestScope - The request scope that just begun. May not be null.

sApplicationID - The current application ID

getSessionMenuItem

@Nullable
public IMenuItemPage getSessionMenuItem()

Specified by:

getSessionMenuItem in interface IRequestParameterManager

Returns:

The ID of the last requested menu item, or null if the corresponding session parameter is not present.

getRequestMenuItem

@Nonnull
public IMenuItemPage getRequestMenuItem()

Description copied from interface: IRequestParameterManager

Resolve the request parameter for the menu item to an IMenuItem object. If no parameter is present, return the default menu item.

Specified by:

getRequestMenuItem in interface IRequestParameterManager

Returns:

The resolved menu item object from the request parameter. Never null.

getSessionDisplayLocale

@Nullable
public Locale getSessionDisplayLocale()

Description copied from interface: IRequestParameterManager

Get the locale stored in the session. If neither request nor session data is present, the default locale is returned.

Specified by:

getSessionDisplayLocale in interface IRequestParameterManager

Returns:

May be null if neither session locale nor default locale is present.

getRequestDisplayLocale

@Nonnull
public Locale getRequestDisplayLocale()

Description copied from interface: IRequestParameterManager

Get the locale to be used for this request. If no parameter is present, the one from the session is used. If neither request nor session data is present, the default locale is returned.

Specified by:

getRequestDisplayLocale in interface IRequestParameterManager

Returns:

The locale to be used for the current request. Never null.

getLinkToMenuItem

@Nonnull
public com.helger.commons.url.SimpleURL getLinkToMenuItem(@Nonnull @Nonempty
                                                                    String sApplicationID,
                                                                    @Nonnull
                                                                    com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                                                                    @Nonnull
                                                                    Locale aDisplayLocale,
                                                                    @Nonnull
                                                                    String sMenuItemID)

Specified by:

getLinkToMenuItem in interface IRequestParameterManager

getMenuItemFromURL

@Nullable
public String getMenuItemFromURL(@Nullable
                                            com.helger.commons.url.ISimpleURL aURL)

Specified by:

getMenuItemFromURL in interface IRequestParameterManager

getLocaleFromURL

@Nullable
public String getLocaleFromURL(@Nullable
                                          com.helger.commons.url.ISimpleURL aURL)

Specified by:

getLocaleFromURL in interface IRequestParameterManager

toString

public String toString()

Overrides:

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