com.helger.photon.basic.app.request

Class RequestParameterHandlerURLPathNamed

java.lang.Object

com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

All Implemented Interfaces:

IRequestParameterHandler, Serializable

@Immutable
public class RequestParameterHandlerURLPathNamed
extends AbstractRequestParameterHandlerNamed

An implementation of IRequestParameterHandler that takes the request parameters from the URL path. It build URLs in the form basePath[/paramNameseparatorparamValue]*

Since:

7.0.2

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_SEPARATOR_CHAR The separator char to be used if path based handling is enabled, to separate name and value

Fields inherited from class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE, DEFAULT_REQUEST_PARAMETER_MENUITEM

Constructor Summary

Constructors

Constructor and Description
RequestParameterHandlerURLPathNamed() Default constructor using DEFAULT_SEPARATOR_CHAR as the separator.
RequestParameterHandlerURLPathNamed(String sSeparator) Constructor with a custom separator.

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)
PhotonRequestParameters	getParametersFromRequest(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope) Get all request parameters from the provided request.
PhotonRequestParameters	getParametersFromURL(com.helger.commons.url.ISimpleURL aURL) Get all request parameters from the provided URL.
String	getSeparator()
boolean	isValidParameterName(String sParamName) Check if the passed parameter name is valid according to the rules of this parameter handler.
String	toString()

Methods inherited from class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

getRequestParamNameLocale, getRequestParamNameMenuItem, setRequestParamNameLocale, setRequestParamNameMenuItem

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR_CHAR

public static final char DEFAULT_SEPARATOR_CHAR

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

See Also:

Constant Field Values

Constructor Detail

RequestParameterHandlerURLPathNamed

public RequestParameterHandlerURLPathNamed()

Default constructor using DEFAULT_SEPARATOR_CHAR as the separator.

RequestParameterHandlerURLPathNamed

public RequestParameterHandlerURLPathNamed(@Nonnull @Nonempty
                                           String sSeparator)

Constructor with a custom separator.

Parameters:

sSeparator - The separator to use. May neither be null nor empty. May not contain the "/" character!

Method Detail

getSeparator

@Nonnull
 @Nonempty
public String getSeparator()

Returns:

The separator as passed in the constructor. Neither null nor empty.

getParametersFromPath

@Nonnull
protected PhotonRequestParameters getParametersFromPath(@Nonnull
                                                                  String sPath)

getParametersFromRequest

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

Description copied from interface: IRequestParameterHandler

Get all request parameters from the provided request.

Parameters:

aRequestScope - The current request scope. 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)

Description copied from interface: IRequestParameterHandler

Get all request parameters from the provided URL.

Parameters:

aURL - The URL to extract the parameters from. 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.

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.

isValidParameterName

public boolean isValidParameterName(@Nonnull
                                    String sParamName)

Description copied from class: AbstractRequestParameterHandlerNamed

Check if the passed parameter name is valid according to the rules of this parameter handler.

Specified by:

isValidParameterName in class AbstractRequestParameterHandlerNamed

Parameters:

sParamName - The parameter name to check. May not be null.

Returns:

true if the parameter is valid, false otherwise.

toString

public String toString()

Overrides:

toString in class AbstractRequestParameterHandlerNamed