Package org.apache.wicket.core.request.mapper

Class ResourceMapper

java.lang.Object

org.apache.wicket.request.mapper.AbstractMapper

org.apache.wicket.core.request.mapper.AbstractComponentMapper

org.apache.wicket.core.request.mapper.AbstractBookmarkableMapper

org.apache.wicket.core.request.mapper.ResourceMapper

All Implemented Interfaces:

IRequestMapper

public class ResourceMapper
extends AbstractBookmarkableMapper

A IRequestMapper to mount resources to a custom mount path

• maps indexed parameters to path segments
• maps named parameters to query string arguments or placeholder path segments

Sample structure of url

    /myresources/${category}/images/[indexed-param-0]/[indexed-param-1]?[named-param-1=value]&[named-param-2=value2]
 

Sample usage

in your wicket application's init() method use a statement like this

 mountResource("/images", new ImagesResourceReference()));
 

Note: Mounted this way the resource reference has application scope, i.e. it is shared between all users of the application. It is recommended to not keep any state in it.

Author:

Peter Ertl

See Also:

WebApplication.mountResource(String, org.apache.wicket.request.resource.ResourceReference)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.core.request.mapper.AbstractBookmarkableMapper

AbstractBookmarkableMapper.MountPathSegment, AbstractBookmarkableMapper.UrlInfo

Field Summary

Fields inherited from class org.apache.wicket.core.request.mapper.AbstractBookmarkableMapper

pageParametersEncoder, pathSegments

Constructor Summary

Constructors

Constructor	Description
ResourceMapper(String path, ResourceReference resourceReference)	create a resource mapper for a resource
ResourceMapper(String path, ResourceReference resourceReference, IPageParametersEncoder encoder)	create a resource mapper for a resource

Method Summary

Modifier and Type	Method	Description
protected void	addCachingDecoration(Url url, PageParameters parameters)
protected Url	buildUrl(AbstractBookmarkableMapper.UrlInfo info)	Builds URL for the given AbstractBookmarkableMapper.UrlInfo instance.
protected IResourceCachingStrategy	getCachingStrategy()
int	getCompatibilityScore(Request request)	Returns the score representing how compatible this request mapper is to processing the given request.
Url	mapHandler(IRequestHandler requestHandler)	Returns the Url for given IRequestHandler or null if the request handler is not recognized.
IRequestHandler	mapRequest(Request request)	Returns IRequestHandler for the request or null if the Url is not recognized.
protected boolean	pageMustHaveBeenCreatedBookmarkable()	Indicates whether hybrid RenderPageRequestHandler URL for page will be generated only if page has been created with bookmarkable URL.
protected AbstractBookmarkableMapper.UrlInfo	parseRequest(Request request)	Parse the given request to an AbstractBookmarkableMapper.UrlInfo instance.
protected void	removeCachingDecoration(Url url, PageParameters parameters)

Methods inherited from class org.apache.wicket.core.request.mapper.AbstractBookmarkableMapper

checkPageClass, checkPageInstance, extractPageParameters, getMatchedSegmentSizes, getPageInfo, getPathSegments, isCaseSensitiveMatch, isFixedSegment, newPageParameters, processBookmarkable, processHybrid, processListener, resolveUserLocale, segmentsMatch, setCaseSensitiveMatch, setPlaceholders, urlStartsWithMountedSegments

Methods inherited from class org.apache.wicket.core.request.mapper.AbstractComponentMapper

cleanClassName, encodePageComponentInfo, getContext, getPageClass, getPageComponentInfo, removeMetaParameter

Methods inherited from class org.apache.wicket.request.mapper.AbstractMapper

encodePageParameters, extractPageParameters, getMountSegments, getOptionalPlaceholder, getPlaceholder, getPlaceholder, resolveLocale, safeSegmentGetter, urlStartsWith

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMapper

public ResourceMapper(String path,
                      ResourceReference resourceReference)

create a resource mapper for a resource

Parameters:

path - mount path for the resource

resourceReference - resource reference that should be linked to the mount path

See Also:

ResourceMapper(String, org.apache.wicket.request.resource.ResourceReference, org.apache.wicket.request.mapper.parameter.IPageParametersEncoder)

ResourceMapper

public ResourceMapper(String path,
                      ResourceReference resourceReference,
                      IPageParametersEncoder encoder)

create a resource mapper for a resource

Parameters:

path - mount path for the resource

resourceReference - resource reference that should be linked to the mount path

encoder - encoder for url parameters

Method Detail

mapRequest

public IRequestHandler mapRequest(Request request)

Description copied from interface: IRequestMapper

Returns IRequestHandler for the request or null if the Url is not recognized.

Specified by:

mapRequest in interface IRequestMapper

Overrides:

mapRequest in class AbstractBookmarkableMapper

Parameters:

request - provides access to request data (i.e. Url and Parameters)

Returns:

RequestHandler instance or null

parseRequest

protected final AbstractBookmarkableMapper.UrlInfo parseRequest(Request request)

Description copied from class: AbstractBookmarkableMapper

Parse the given request to an AbstractBookmarkableMapper.UrlInfo instance.

Specified by:

parseRequest in class AbstractBookmarkableMapper

Returns:

UrlInfo instance or null if this encoder can not handle the request

buildUrl

protected final Url buildUrl(AbstractBookmarkableMapper.UrlInfo info)

Description copied from class: AbstractBookmarkableMapper

Builds URL for the given AbstractBookmarkableMapper.UrlInfo instance. The URL this method produces must be parseable by the AbstractBookmarkableMapper.parseRequest(Request) method.

Specified by:

buildUrl in class AbstractBookmarkableMapper

Returns:

Url result URL

pageMustHaveBeenCreatedBookmarkable

protected final boolean pageMustHaveBeenCreatedBookmarkable()

Description copied from class: AbstractBookmarkableMapper

Indicates whether hybrid RenderPageRequestHandler URL for page will be generated only if page has been created with bookmarkable URL.

For generic bookmarkable encoders this method should return true. For explicit (mounted) encoders this method should return false

Specified by:

pageMustHaveBeenCreatedBookmarkable in class AbstractBookmarkableMapper

Returns:

true if hybrid URL requires page created bookmarkable, false otherwise.

getCompatibilityScore

public int getCompatibilityScore(Request request)

Description copied from interface: IRequestMapper

Returns the score representing how compatible this request mapper is to processing the given request. When a request comes in all mappers are scored and are tried in order from highest score to lowest.

A good criteria for calculating the score is the number of matched url segments. For example when there are two mappers for a mounted page, one mapped to /foo another to /foo/bar and the incoming request URL is /foo/bar/baz, the mapping to /foo/bar should probably handle the request first as it has matching segments count of 2 while the first one has only matching segments count of 1.

Note that the method can return value greater then zero even if the mapper does not recognize the request.

Specified by:

getCompatibilityScore in interface IRequestMapper

Overrides:

getCompatibilityScore in class AbstractBookmarkableMapper

Returns:

the compatibility score, e.g. count of matching segments

mapHandler

public Url mapHandler(IRequestHandler requestHandler)

Description copied from interface: IRequestMapper

Returns the Url for given IRequestHandler or null if the request handler is not recognized.

Specified by:

mapHandler in interface IRequestMapper

Overrides:

mapHandler in class AbstractBookmarkableMapper

Returns:

Url instance or null.

getCachingStrategy

protected IResourceCachingStrategy getCachingStrategy()

addCachingDecoration

protected void addCachingDecoration(Url url,
                                    PageParameters parameters)

removeCachingDecoration

protected void removeCachingDecoration(Url url,
                                       PageParameters parameters)