org.apache.wicket.request.mapper
Class AbstractBookmarkableMapper

java.lang.Object
  org.apache.wicket.request.mapper.AbstractMapper
      org.apache.wicket.request.mapper.AbstractComponentMapper
          org.apache.wicket.request.mapper.AbstractBookmarkableMapper

All Implemented Interfaces:

IRequestMapper

Direct Known Subclasses:

BookmarkableMapper, MountedMapper, PackageMapper

public abstract class AbstractBookmarkableMapper
extends AbstractComponentMapper

Abstract encoder for Bookmarkable, Hybrid and BookmarkableListenerInterface URLs.

Author:

Matej Knopp

Nested Class Summary

protected static class

AbstractBookmarkableMapper.UrlInfo Represents information stored in URL.

Constructor Summary

AbstractBookmarkableMapper()
Construct.

Method Summary

protected abstract Url	buildUrl(AbstractBookmarkableMapper.UrlInfo info) Builds URL for the given AbstractBookmarkableMapper.UrlInfo instance.
protected boolean	checkPageClass(Class<? extends IRequestablePage> pageClass)
protected boolean	checkPageInstance(IRequestablePage page)
abstract int	getCompatibilityScore(Request request)
Url	mapHandler(IRequestHandler requestHandler)
IRequestHandler	mapRequest(Request request)
protected abstract boolean	pageMustHaveBeenCreatedBookmarkable() Indicates whether hybrid RenderPageRequestHandler URL for page will be generated only if page has been created with bookmarkable URL.
protected abstract AbstractBookmarkableMapper.UrlInfo	parseRequest(Request request) Parse the given request to an AbstractBookmarkableMapper.UrlInfo instance.
protected IRequestHandler	processBookmarkable(Class<? extends IRequestablePage> pageClass, PageParameters pageParameters) Creates a IRequestHandler that processes a bookmarkable request.
protected IRequestHandler	processHybrid(PageInfo pageInfo, Class<? extends IRequestablePage> pageClass, PageParameters pageParameters, Integer renderCount) Creates a IRequestHandler that processes a hybrid request.
protected IRequestHandler	processListener(PageComponentInfo pageComponentInfo, Class<? extends IRequestablePage> pageClass, PageParameters pageParameters) Creates a IRequestHandler that processes a listener request.

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

encodePageComponentInfo, getContext, getPageClass, getPageComponentInfo, removeMetaParameter, requestListenerInterfaceFromString, requestListenerInterfaceToString

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBookmarkableMapper

public AbstractBookmarkableMapper()

Construct.

Method Detail

parseRequest

protected abstract AbstractBookmarkableMapper.UrlInfo parseRequest(Request request)

Parse the given request to an AbstractBookmarkableMapper.UrlInfo instance.

Parameters:

request -

Returns:

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

buildUrl

protected abstract Url buildUrl(AbstractBookmarkableMapper.UrlInfo info)

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

Parameters:

info -

Returns:

Url result URL

pageMustHaveBeenCreatedBookmarkable

protected abstract boolean pageMustHaveBeenCreatedBookmarkable()

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

Returns:

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

getCompatibilityScore

public abstract int getCompatibilityScore(Request request)

See Also:

IRequestMapper.getCompatibilityScore(Request)

processBookmarkable

protected IRequestHandler processBookmarkable(Class<? extends IRequestablePage> pageClass,
                                              PageParameters pageParameters)

Creates a IRequestHandler that processes a bookmarkable request.

Parameters:

pageClass -

pageParameters -

Returns:

a IRequestHandler capable of processing the bookmarkable request.

processHybrid

protected IRequestHandler processHybrid(PageInfo pageInfo,
                                        Class<? extends IRequestablePage> pageClass,
                                        PageParameters pageParameters,
                                        Integer renderCount)

Creates a IRequestHandler that processes a hybrid request. When the page identified by pageInfo was not available, the request should be treated as a bookmarkable request.

Parameters:

pageInfo -

pageClass -

pageParameters -

renderCount -

Returns:

a IRequestHandler capable of processing the hybrid request.

processListener

protected IRequestHandler processListener(PageComponentInfo pageComponentInfo,
                                          Class<? extends IRequestablePage> pageClass,
                                          PageParameters pageParameters)

Creates a IRequestHandler that processes a listener request.

Parameters:

pageComponentInfo -

pageClass -

pageParameters -

Returns:

a IRequestHandler that invokes the listener interface

mapRequest

public IRequestHandler mapRequest(Request request)

See Also:

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

checkPageInstance

protected boolean checkPageInstance(IRequestablePage page)

checkPageClass

protected boolean checkPageClass(Class<? extends IRequestablePage> pageClass)

mapHandler

public Url mapHandler(IRequestHandler requestHandler)