com.helger.photon.basic.app.request

Class RequestManager

java.lang.Object

com.helger.photon.basic.app.request.RequestManager

All Implemented Interfaces:

IRequestManager

public class RequestManager
extends Object
implements IRequestManager

This class holds the per-request configuration settings.

• Menu item to show
• Display locale

Author:

Philip Helger

Field Summary

Fields inherited from interface com.helger.photon.basic.app.request.IRequestManager

DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE, DEFAULT_REQUEST_PARAMETER_MENUITEM, DEFAULT_USE_PATHS, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
RequestManager()

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.commons.url.SimpleURL	getLinkToMenuItem(com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope, String sMenuItemID)
String	getLocaleFromURL(com.helger.commons.url.ISimpleURL aURL)
protected ILocaleManager	getLocaleManager()
String	getMenuItemFromURL(com.helger.commons.url.ISimpleURL aURL)
protected IMenuTree	getMenuTree()
protected Map<String,Object>	getParametersFromRequest(com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope)
protected Map<String,?>	getParametersFromURL(com.helger.commons.url.ISimpleURL aURL)
Locale	getRequestDisplayCountry() Get the country to be used for this request.
String	getRequestDisplayLanguage()
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.
String	getRequestMenuItemID()
String	getRequestParamNameLocale()
String	getRequestParamNameMenuItem()
protected String	getSessionAttrLocale()
protected String	getSessionAttrMenuItem()
IMenuItemPage	getSessionMenuItem()
boolean	isUsePaths()
void	onRequestBegin(com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope) To be called upon the beginning of each request.
void	setRequestParamNameLocale(String sRequestParamNameLocale)
void	setRequestParamNameMenuItem(String sRequestParamNameMenuItem)
void	setUsePaths(boolean bUsePaths)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestManager

public RequestManager()

Method Detail

isUsePaths

public boolean isUsePaths()

Specified by:

isUsePaths in interface IRequestManager

setUsePaths

public void setUsePaths(boolean bUsePaths)

Specified by:

setUsePaths in interface IRequestManager

getRequestParamNameMenuItem

@Nonnull
@Nonempty
public final String getRequestParamNameMenuItem()

Specified by:

getRequestParamNameMenuItem in interface IRequestManager

setRequestParamNameMenuItem

public final void setRequestParamNameMenuItem(@Nonnull@Nonempty
                               String sRequestParamNameMenuItem)

Specified by:

setRequestParamNameMenuItem in interface IRequestManager

getRequestParamNameLocale

@Nonnull
@Nonempty
public final String getRequestParamNameLocale()

Specified by:

getRequestParamNameLocale in interface IRequestManager

setRequestParamNameLocale

public final void setRequestParamNameLocale(@Nonnull@Nonempty
                             String sRequestParamNameLocale)

Specified by:

setRequestParamNameLocale in interface IRequestManager

getMenuTree

@Nonnull
protected final IMenuTree getMenuTree()

getLocaleManager

@Nonnull
protected final ILocaleManager getLocaleManager()

getSessionAttrMenuItem

@Nonnull
@Nonempty
protected String getSessionAttrMenuItem()

getSessionAttrLocale

@Nonnull
@Nonempty
protected String getSessionAttrLocale()

getParametersFromRequest

@Nonnull
protected Map<String,Object> getParametersFromRequest(@Nonnull
                                                  com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope)

onRequestBegin

public void onRequestBegin(@Nonnull
                  com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope)

Description copied from interface: IRequestManager

To be called upon the beginning of each request. Checks for the content of the request parameter "menuitem" to determine the selected menu item. Checks for the content of the request parameter "locale" to determine any changes in the display locale.

Specified by:

onRequestBegin in interface IRequestManager

Parameters:

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

getSessionMenuItem

@Nullable
public IMenuItemPage getSessionMenuItem()

Specified by:

getSessionMenuItem in interface IRequestManager

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: IRequestManager

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 IRequestManager

Returns:

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

getRequestMenuItemID

@Nonnull
public String getRequestMenuItemID()

Specified by:

getRequestMenuItemID in interface IRequestManager

Returns:

The ID of the current request menu item. May not be null.

getRequestDisplayLocale

@Nonnull
public Locale getRequestDisplayLocale()

Description copied from interface: IRequestManager

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 IRequestManager

Returns:

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

getRequestDisplayCountry

@Nonnull
public Locale getRequestDisplayCountry()

Description copied from interface: IRequestManager

Get the country 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 country of the default locale is returned.

Specified by:

getRequestDisplayCountry in interface IRequestManager

Returns:

The country-Locale of the request display locale. Never null.

See Also:

IRequestManager.getRequestDisplayLocale()

getRequestDisplayLanguage

@Nonnull
public String getRequestDisplayLanguage()

Specified by:

getRequestDisplayLanguage in interface IRequestManager

Returns:

The language name from the current request display locale. Never null.

See Also:

IRequestManager.getRequestDisplayLocale()

getLinkToMenuItem

@Nonnull
public com.helger.commons.url.SimpleURL getLinkToMenuItem(@Nonnull
                                                         com.helger.web.scopes.domain.IRequestWebScopeWithoutResponse aRequestScope,
                                                         @Nonnull
                                                         String sMenuItemID)

Specified by:

getLinkToMenuItem in interface IRequestManager

getParametersFromURL

@Nonnull
protected Map<String,?> getParametersFromURL(@Nonnull
                                         com.helger.commons.url.ISimpleURL aURL)

getMenuItemFromURL

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

Specified by:

getMenuItemFromURL in interface IRequestManager

getLocaleFromURL

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

Specified by:

getLocaleFromURL in interface IRequestManager

toString

public String toString()

Overrides:

toString in class Object