org.mmbase.framework.basic

Class ChainedUrlConverter

java.lang.Object

org.mmbase.framework.basic.ChainedUrlConverter

All Implemented Interfaces:

Serializable, UrlConverter

public class ChainedUrlConverter
extends Object
implements UrlConverter

Keeps track of several UrlConverters and chains them one after another. If the outcome of an UrlConverter is not null its result is returned. The question remains whether we want UrlConverters to be realy chained so that the outcome of a converter can be added to the outcome of its preceder.

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen, André van Toly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	URLCONVERTER
static Parameter<Class>	URLCONVERTER_PARAM

Constructor Summary

Constructors

Constructor and Description
ChainedUrlConverter()

Method Summary

Modifier and Type	Method and Description
void	add(UrlConverter u) Adds the UrlConverters to the list.
boolean	contains(UrlConverter u)
int	getDefaultWeight() The default weight of the UrlConverters.
Url	getInternalUrl(String path, Map<String,?> params, Parameters frameworkParameters) The 'technical' url.
Parameter<?>[]	getParameterDefinition() An URLConverter can add parameters to it's parent Framework.
Url	getProcessUrl(String path, Map<String,?> params, Parameters frameworkParameters, boolean escapeAmps) Basically the same as getUrl(java.lang.String, java.util.Map<java.lang.String, ?>, org.mmbase.util.functions.Parameters, boolean) but for a Processor url.
protected Url	getProposal(Url u, Parameters frameworkParameters) Upon examining the user request an 'nice' URL is proposed by an UrlConverter to resolve the request.
Url	getUrl(String path, Map<String,?> params, Parameters frameworkParameters, boolean escapeAmps) The URL to be printed in a page, the 'nice' url.
boolean	isFilteredMode(Parameters frameworkParameters) The state of rendering will be determined (request.getRequestUri) and we will return if the current URL is managed by this UrlConverter
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

URLCONVERTER_PARAM

public static Parameter<Class> URLCONVERTER_PARAM

URLCONVERTER

public static String URLCONVERTER

Constructor Detail

ChainedUrlConverter

public ChainedUrlConverter()

Method Detail

add

public void add(UrlConverter u)

Adds the UrlConverters to the list.

contains

public boolean contains(UrlConverter u)

getParameterDefinition

public Parameter<?>[] getParameterDefinition()

Description copied from interface: UrlConverter

An URLConverter can add parameters to it's parent Framework. If the parameter is already defined in the Framework, the framework will of course ignore the one requested to be defined by this UrlConverter.

Specified by:

getParameterDefinition in interface UrlConverter

getDefaultWeight

public int getDefaultWeight()

The default weight of the UrlConverters. An Url proposal by an UrlConverter receives a weight upon which is decided which one should resolve the request.

Specified by:

getDefaultWeight in interface UrlConverter

isFilteredMode

public boolean isFilteredMode(Parameters frameworkParameters)
                       throws FrameworkException

Description copied from interface: UrlConverter

The state of rendering will be determined (request.getRequestUri) and we will return if the current URL is managed by this UrlConverter

Specified by:

isFilteredMode in interface UrlConverter

Throws:

FrameworkException

getProposal

protected Url getProposal(Url u,
                          Parameters frameworkParameters)

Upon examining the user request an 'nice' URL is proposed by an UrlConverter to resolve the request. The proposed url receives a weight.

getUrl

public Url getUrl(String path,
                  Map<String,?> params,
                  Parameters frameworkParameters,
                  boolean escapeAmps)
           throws FrameworkException

The URL to be printed in a page, the 'nice' url. This method requests an url proposal from getProposal(org.mmbase.framework.basic.Url, org.mmbase.util.functions.Parameters) and decides upon their weight which one prevails.

Specified by:

getUrl in interface UrlConverter

Parameters:

path - The path (generally a relative URL) to create an URL for.

params - Parameters The parameters to be passed to the page, as specified e.g. with mm:param -tags

frameworkParameters - The parameters that are required by the framework

escapeAmps - true if parameters should be added with an escaped & (&). You should escape & when a URL is exposed (i.e. in HTML), but not if the url is for some reason called directly.

Returns:

An URL relative to the root of this web application (i.e. without a context path). Url.NOT if not determinable.

Throws:

FrameworkException - thrown when something goes wrong in the Framework

getProcessUrl

public Url getProcessUrl(String path,
                         Map<String,?> params,
                         Parameters frameworkParameters,
                         boolean escapeAmps)
                  throws FrameworkException

Basically the same as getUrl(java.lang.String, java.util.Map<java.lang.String, ?>, org.mmbase.util.functions.Parameters, boolean) but for a Processor url.

Specified by:

getProcessUrl in interface UrlConverter

Returns:

An URL relative to the root of this web application (i.e. without a context path). Never null

Throws:

FrameworkException

getInternalUrl

public Url getInternalUrl(String path,
                          Map<String,?> params,
                          Parameters frameworkParameters)
                   throws FrameworkException

The 'technical' url. The 'nice' urls received by FrameworkFilter resolve to these. This method decides upon their weight which of the proposed technical url's by the UrlConverters matches the 'nice' url.

Specified by:

getInternalUrl in interface UrlConverter

Parameters:

path - The page (e.g. image/css) provided by the component to create an URL for

params - Extra parameters for that path

frameworkParameters - The parameters that are required by the framework, such as the 'request' and 'cloud' objects

Returns:

A valid internal URL, or Url.NOT if nothing framework specific could be determined (this would make it possible to 'chain' frameworks).

Throws:

FrameworkException - thrown when something goes wrong in the Framework

toString

public String toString()

Overrides:

toString in class Object