org.apache.wicket.request.mapper.mount
Class MountMapper

java.lang.Object
  org.apache.wicket.request.mapper.AbstractMapper
      org.apache.wicket.request.mapper.mount.MountMapper

All Implemented Interfaces:

IRequestMapper

public class MountMapper
extends AbstractMapper

IRequestMapper that can mount requests onto urls. TODO docs and unit test

Author:

igor.vaynberg

Constructor Summary

MountMapper(java.lang.String mountPath, IMountedRequestMapper mapper)
Construct.

MountMapper(java.lang.String mountPath, IRequestHandler handler)
Construct.

MountMapper(java.lang.String mountPath, IRequestMapper mapper)
Construct.

Method Summary

int	getCompatibilityScore(Request request) Returns the score representing how compatible this request mapper is to processing the given request.
Url	mapHandler(IRequestHandler handler) 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.

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

encodePageParameters, extractPageParameters, getMountSegments, getOptionalPlaceholder, getPlaceholder, getPlaceholder, removeMetaParameter, urlStartsWith

Methods inherited from class java.lang.Object

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

Constructor Detail

MountMapper

public MountMapper(java.lang.String mountPath,
                   IMountedRequestMapper mapper)

Construct.

Parameters:

mountPath -

mapper -

MountMapper

public MountMapper(java.lang.String mountPath,
                   IRequestMapper mapper)

Construct.

Parameters:

mountPath -

mapper -

MountMapper

public MountMapper(java.lang.String mountPath,
                   IRequestHandler handler)

Construct.

Parameters:

mountPath -

handler -

Method Detail

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.

Returns:

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

See Also:

IRequestMapper.getCompatibilityScore(org.apache.wicket.request.Request)

mapRequest

public final IRequestHandler mapRequest(Request request)

Description copied from interface: IRequestMapper

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

Parameters:

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

Returns:

RequestHandler instance or null

See Also:

IRequestMapper.mapRequest(org.apache.wicket.request.Request)

mapHandler

public Url mapHandler(IRequestHandler handler)

Description copied from interface: IRequestMapper

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

Returns:

Url instance or null.

See Also:

org.apache.wicket.request.IRequestMapper#mapHandler(org.apache.org.apache.wicket.request.IRequestHandler)