Module org.apache.wicket.core
Package org.apache.wicket

Class UrlResourceReferenceMapper

java.lang.Object
org.apache.wicket.UrlResourceReferenceMapper
All Implemented Interfaces:
IRequestMapper
public class UrlResourceReferenceMapper extends Object implements IRequestMapper
A request mapper that is used to create Url out of UrlResourceReference. UrlResourceReference works with UrlResourceReference.CalculatedUrl and thus this mapper should not use SystemMapper.ParentFolderPlaceholderProvider

  • Constructor Details

  • Method Details

    • mapHandler

      public Url mapHandler(IRequestHandler requestHandler)
      Description copied from interface: IRequestMapper
      Returns the Url for given IRequestHandler or null if the request handler is not recognized.
      Specified by:
      mapHandler in interface IRequestMapper
      Returns:
      Url instance or null.

    • mapRequest

      public IRequestHandler mapRequest(Request request)
      Description copied from interface: IRequestMapper
      Returns IRequestHandler for the request or null if the Url is not recognized.
      Specified by:
      mapRequest in interface IRequestMapper
      Parameters:
      request - provides access to request data (i.e. Url and Parameters)
      Returns:
      RequestHandler instance or null

    • 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
      Returns:
      the compatibility score, e.g. count of matching segments