org.apache.wicket.core.request.mapper

Class BookmarkableMapper

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.BookmarkableMapper

All Implemented Interfaces:

IRequestMapper

public class BookmarkableMapper
extends AbstractBookmarkableMapper

Decodes and encodes the following URLs:

  Page Class - Render (BookmarkablePageRequestHandler)
  /wicket/bookmarkable/org.apache.wicket.MyPage
  (will redirect to hybrid alternative if page is not stateless)
 
  Page Instance - Render Hybrid (RenderPageRequestHandler for pages that were created using bookmarkable URLs)
  /wicket/bookmarkable/org.apache.wicket.MyPage?2
 
  Page Instance - Bookmarkable Listener (BookmarkableListenerRequestHandler)
  /wicket/bookmarkable/org.apache.wicket.MyPage?2-click-foo-bar-baz
  /wicket/bookmarkable/org.apache.wicket.MyPage?2-click.1-foo-bar-baz (1 is behavior index)
  (these will redirect to hybrid if page is not stateless)
 

Author:

Matej Knopp

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

mountSegments, pageParametersEncoder, pathSegments

Constructor Summary

Constructors

Constructor and Description
BookmarkableMapper() Construct.
BookmarkableMapper(IPageParametersEncoder pageParametersEncoder) Construct.

Method Summary

Modifier and Type	Method and Description
protected Url	buildUrl(AbstractBookmarkableMapper.UrlInfo info) Builds URL for the given AbstractBookmarkableMapper.UrlInfo instance.
int	getCompatibilityScore(Request request) Returns the score representing how compatible this request mapper is to processing the given request.
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 boolean	urlStartsWithAndHasPageClass(Url url, String... segments) Checks whether the url starts with the given segments and additionally checks whether the following segment is non-empty

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

checkPageClass, checkPageInstance, extractPageParameters, getMatchedSegmentSizes, getPageInfo, getPathSegments, isCaseSensitiveMatch, isFixedSegment, mapHandler, mapRequest, 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

BookmarkableMapper

public BookmarkableMapper()

Construct.

BookmarkableMapper

public BookmarkableMapper(IPageParametersEncoder pageParametersEncoder)

Construct.

Parameters:

pageParametersEncoder -

Method Detail

buildUrl

protected 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

parseRequest

protected 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

pageMustHaveBeenCreatedBookmarkable

protected 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

urlStartsWithAndHasPageClass

protected boolean urlStartsWithAndHasPageClass(Url url,
                                               String... segments)

Checks whether the url starts with the given segments and additionally checks whether the following segment is non-empty

Parameters:

url - The url to be checked

segments - The expected leading segments

Returns:

true if the url starts with the given segments and there is non-empty segment after them