com.helger.photon.basic.app.request

Class RequestParameterHandlerURLPathOrdered

java.lang.Object

com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

All Implemented Interfaces:

IRequestParameterHandler, Serializable

@Immutable
public class RequestParameterHandlerURLPathOrdered
extends Object
implements IRequestParameterHandler

An implementation of IRequestParameterHandler that takes the request parameters from the URL path in the fixed order locale than menu item. It build URLs in the form basePath/locale/menuItem

Since:

7.0.2

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequestParameterHandlerURLPathOrdered() Default constructor

Method Summary

Modifier and Type	Method and Description
com.helger.commons.url.SimpleURL	buildURL(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, String sBasePath, Locale aDisplayLocale, String sMenuItemID) Build a URL based on the passed base path and an optional list of parameters.
protected PhotonRequestParameters	getParametersFromPath(String sPath, IMenuTree aMenuTree)
PhotonRequestParameters	getParametersFromRequest(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, IMenuTree aMenuTree) Get all request parameters from the provided request.
PhotonRequestParameters	getParametersFromURL(com.helger.commons.url.ISimpleURL aURL, IMenuTree aMenuTree) Get all request parameters from the provided URL.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParameterHandlerURLPathOrdered

public RequestParameterHandlerURLPathOrdered()

Default constructor

Method Detail

getParametersFromPath

@Nonnull
protected PhotonRequestParameters getParametersFromPath(@Nonnull
                                                                  String sPath,
                                                                  @Nonnull
                                                                  IMenuTree aMenuTree)

getParametersFromRequest

@Nonnull
 @ReturnsMutableCopy
public PhotonRequestParameters getParametersFromRequest(@Nonnull
                                                                                        com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                                                                                        @Nonnull
                                                                                        IMenuTree aMenuTree)

Description copied from interface: IRequestParameterHandler

Get all request parameters from the provided request.

Specified by:

getParametersFromRequest in interface IRequestParameterHandler

Parameters:

aRequestScope - The current request scope. May not be null.

aMenuTree - Relevant menu tree. May not be null.

Returns:

A non-null list of all parameters.

getParametersFromURL

@Nonnull
 @ReturnsMutableCopy
public PhotonRequestParameters getParametersFromURL(@Nonnull
                                                                                    com.helger.commons.url.ISimpleURL aURL,
                                                                                    @Nonnull
                                                                                    IMenuTree aMenuTree)

Description copied from interface: IRequestParameterHandler

Get all request parameters from the provided URL.

Specified by:

getParametersFromURL in interface IRequestParameterHandler

Parameters:

aURL - The URL to extract the parameters from. May not be null.

aMenuTree - Relevant menu tree. May not be null.

Returns:

A non-null list of all parameters.

buildURL

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

Description copied from interface: IRequestParameterHandler

Build a URL based on the passed base path and an optional list of parameters.

Specified by:

buildURL in interface IRequestParameterHandler

Parameters:

aRequestScope - Current request scope. May be null.

sBasePath - The base path to use. May not be null and must NOT end with a "/".

aDisplayLocale - The display locale to use. May be null.

sMenuItemID - The menu item ID to use. May be null.

Returns:

The URL to use.

toString

public String toString()

Overrides:

toString in class Object