org.apache.wicket.request
Interface IRequestTargetMounter

All Known Subinterfaces:

IRequestCodingStrategy, IRequestTargetMountsInfo

All Known Implementing Classes:

CryptedUrlWebRequestCodingStrategy, UrlCompressingWebCodingStrategy, WebRequestCodingStrategy

public interface IRequestTargetMounter

Defines the contract for mounting request targets to paths.

Author:

Eelco Hillenius

Method Summary

void	addIgnoreMountPath(String path) Partly unmounts/ignores a path that normally would map to another mount path.
void	mount(IRequestTargetUrlCodingStrategy urlCodingStrategy) Mounts a request target with the given path.
CharSequence	pathForTarget(IRequestTarget requestTarget) Gets the url that the provided request target conforms to.
IRequestTarget	targetForRequest(RequestParameters requestParameters) Gets the request target that conforms to the given request parameters.
void	unmount(String path) Unmounts a request target.
IRequestTargetUrlCodingStrategy	urlCodingStrategyForPath(String path) Gets the encoder that was mounted on the provided path if any.

Method Detail

mount

void mount(IRequestTargetUrlCodingStrategy urlCodingStrategy)

Mounts a request target with the given path.

Parameters:

urlCodingStrategy - The strategy to use for encoding and decoding urls

addIgnoreMountPath

void addIgnoreMountPath(String path)

Partly unmounts/ignores a path that normally would map to another mount path. Like mount("/mypage", MyPage.class); and then "/mypage/arealdir" should be ignored. This can be done by calling unMount("/mypage/arealdir");

Parameters:

path - the path that should be ignored.

pathForTarget

CharSequence pathForTarget(IRequestTarget requestTarget)

Gets the url that the provided request target conforms to.

Parameters:

requestTarget - the request target

Returns:

The url that the provided request target conforms to

targetForRequest

IRequestTarget targetForRequest(RequestParameters requestParameters)

Gets the request target that conforms to the given request parameters.

Parameters:

requestParameters - the request parameters

Returns:

the request target or null if nothing was mounted with the given request parameters

unmount

void unmount(String path)

Unmounts a request target.

Parameters:

path - the path to unmount

urlCodingStrategyForPath

IRequestTargetUrlCodingStrategy urlCodingStrategyForPath(String path)

Gets the encoder that was mounted on the provided path if any.

Parameters:

path - the path

Returns:

The encoder/decoder that was mounted on the provided path, if any