org.apache.wicket.request.target.coding
Interface IRequestTargetUrlCodingStrategy

All Known Subinterfaces:

IMountableRequestTargetUrlCodingStrategy

All Known Implementing Classes:

AbstractRequestTargetUrlCodingStrategy, BookmarkablePageRequestTargetUrlCodingStrategy, HybridUrlCodingStrategy, IndexedHybridUrlCodingStrategy, IndexedParamUrlCodingStrategy, IndexedSharedResourceCodingStrategy, MixedParamUrlCodingStrategy, PackageRequestTargetUrlCodingStrategy, QueryStringUrlCodingStrategy, SharedResourceRequestTargetUrlCodingStrategy, URIRequestTargetUrlCodingStrategy

public interface IRequestTargetUrlCodingStrategy

Implementations of this interface know how to encode and decode request targets to/from a URL.

Author:

Eelco Hillenius

Method Summary

IRequestTarget	decode(RequestParameters requestParameters) Gets the decoded request target.
java.lang.CharSequence	encode(IRequestTarget requestTarget) Gets the encoded url for the provided request target.
java.lang.String	getMountPath() Returns the path of the url where this request target is mounted on.
boolean	matches(IRequestTarget requestTarget) Gets whether this mounter is applicable for the provided request target.
boolean	matches(java.lang.String path, boolean caseSensitive) Returns true if this mounter is applicable for the URL path

Method Detail

getMountPath

java.lang.String getMountPath()

Returns the path of the url where this request target is mounted on. This should not have a leading slash.

Returns:

String The path of the url

encode

java.lang.CharSequence encode(IRequestTarget requestTarget)

Gets the encoded url for the provided request target. Typically, the result will be prepended with a protocol specific prefix. In a servlet environment, the prefix typically is the context-path + servlet path, eg mywebapp/myservletname.

Parameters:

requestTarget - the request target to encode

Returns:

the encoded url

decode

IRequestTarget decode(RequestParameters requestParameters)

Gets the decoded request target.

Parameters:

requestParameters - the request parameters

Returns:

the decoded request target

matches

boolean matches(IRequestTarget requestTarget)

Gets whether this mounter is applicable for the provided request target.

Parameters:

requestTarget - the request target

Returns:

whether this mounter is applicable for the provided request target

matches

boolean matches(java.lang.String path,
                boolean caseSensitive)

Returns true if this mounter is applicable for the URL path

Parameters:

path -

caseSensitive - whether the strategy should treat path argument with case sensitivity or not

Returns:

true if this strategy matches the path