com.helger.photon.basic.app.request

Interface IRequestManager

All Known Implementing Classes:

RequestManager

public interface IRequestManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE The default name of the parameter selecting the current display locale
static String	DEFAULT_REQUEST_PARAMETER_MENUITEM The default name of the parameter selecting the current menu item
static boolean	DEFAULT_USE_PATHS By default request parameters are used - for backwards compatibility
static char	SEPARATOR_CHAR The separator char to be used if path based handling is enabled, to separate name and value

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)
String	getMenuItemFromURL(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()
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 sRequestParamDisplayLocale)
void	setRequestParamNameMenuItem(String sRequestParamMenuItem)
void	setUsePaths(boolean bUsePaths)

Field Detail

DEFAULT_USE_PATHS

static final boolean DEFAULT_USE_PATHS

By default request parameters are used - for backwards compatibility

See Also:

Constant Field Values

DEFAULT_REQUEST_PARAMETER_MENUITEM

static final String DEFAULT_REQUEST_PARAMETER_MENUITEM

The default name of the parameter selecting the current menu item

See Also:

Constant Field Values

DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE

static final String DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE

The default name of the parameter selecting the current display locale

See Also:

Constant Field Values

SEPARATOR_CHAR

static final char SEPARATOR_CHAR

The separator char to be used if path based handling is enabled, to separate name and value

See Also:

Constant Field Values

Method Detail

isUsePaths

boolean isUsePaths()

setUsePaths

void setUsePaths(boolean bUsePaths)

getRequestParamNameMenuItem

@Nonnull
@Nonempty
String getRequestParamNameMenuItem()

setRequestParamNameMenuItem

void setRequestParamNameMenuItem(@Nonnull@Nonempty
                               String sRequestParamMenuItem)

getRequestParamNameLocale

@Nonnull
@Nonempty
String getRequestParamNameLocale()

setRequestParamNameLocale

void setRequestParamNameLocale(@Nonnull@Nonempty
                             String sRequestParamDisplayLocale)

onRequestBegin

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

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.

Parameters:

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

getSessionMenuItem

@Nullable
IMenuItemPage getSessionMenuItem()

Returns:

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

getRequestMenuItem

@Nonnull
IMenuItemPage getRequestMenuItem()

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

Returns:

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

getRequestMenuItemID

@Nonnull
String getRequestMenuItemID()

Returns:

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

getRequestDisplayLocale

@Nonnull
Locale getRequestDisplayLocale()

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.

Returns:

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

getRequestDisplayCountry

@Nonnull
Locale getRequestDisplayCountry()

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.

Returns:

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

See Also:

getRequestDisplayLocale()

getRequestDisplayLanguage

@Nonnull
String getRequestDisplayLanguage()

Returns:

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

See Also:

getRequestDisplayLocale()

getLinkToMenuItem

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

getMenuItemFromURL

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

getLocaleFromURL

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