Module org.apache.wicket.core

Package org.apache.wicket.core.request.mapper

Class PackageMapper

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

All Implemented Interfaces:

IRequestMapper

public class PackageMapper
extends AbstractBookmarkableMapper

A request mapper that mounts all bookmarkable pages in a given package.

To mount this mapper onto a path use the WebApplication.mountPackage(String, Class), ex:

 MyApp#init() {

   super.init();
   mountPackage("/my/path", MyPage.class);
 }
 

will result in urls like /my/path/MyPage

  Page Class - Render (BookmarkablePageRequestHandler)
  /MyPage
  (will redirect to hybrid alternative if page is not stateless)

  Page Instance - Render Hybrid (RenderPageRequestHandler for pages that were created using bookmarkable URLs)
  /MyPage?2

  Page Instance - Bookmarkable Listener (BookmarkableListenerRequestHandler)
  /MyPage?2-click-foo-bar-baz
  /MyPage?2-click.1-foo-bar-baz (1 is behavior index)
  (these will redirect to hybrid if page is not stateless)
 

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	Description
PackageMapper(String mountPath, PackageName packageName)	Constructor.
PackageMapper(String mountPath, PackageName packageName, IPageParametersEncoder pageParametersEncoder)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Url	buildUrl(AbstractBookmarkableMapper.UrlInfo info)	Builds URL for the given AbstractBookmarkableMapper.UrlInfo instance.
protected boolean	checkPageClass(Class<? extends IRequestablePage> pageClass)
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 String	transformForUrl(String className)	Gives a chance to specializations of this mapper to transform the real class name to an alias which is prettier to represent in the Url
protected String	transformFromUrl(String classNameAlias)	Gives a chance to specializations of this mapper to transform the alias of the class name to the real class name

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

checkPageInstance, extractPageParameters, getCompatibilityScore, 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 Details

PackageMapper

public PackageMapper(String mountPath,
 PackageName packageName)

Constructor.

Parameters:

packageName -

PackageMapper

public PackageMapper(String mountPath,
 PackageName packageName,
 IPageParametersEncoder pageParametersEncoder)

Constructor.

Parameters:

packageName -

pageParametersEncoder -

Method Details

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

transformFromUrl

protected String transformFromUrl(String classNameAlias)

Gives a chance to specializations of this mapper to transform the alias of the class name to the real class name

Parameters:

classNameAlias - the alias for the class name

Returns:

the real class name

transformForUrl

protected String transformForUrl(String className)

Gives a chance to specializations of this mapper to transform the real class name to an alias which is prettier to represent in the Url

Parameters:

className - the real class name

Returns:

the class name alias

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.

checkPageClass

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

Overrides:

checkPageClass in class AbstractBookmarkableMapper