org.apache.wicket.protocol.https
Class HttpsMapper

java.lang.Object
  org.apache.wicket.protocol.https.HttpsMapper

All Implemented Interfaces:

IRequestMapper

public class HttpsMapper
extends java.lang.Object
implements IRequestMapper

A IRequestMapper that will issue a redirect to secured communication (over https) if the page resolved by delegate is annotated with @RequireHttps

To setup it:

 public class MyApplication extends WebApplication
 {
        public void init()
        {
                super.init();
 
                getRootRequestMapperAsCompound().add(new MountedMapper("secured", HttpsPage.class));
                mountPage(SomeOtherPage.class);
 
                // notice that in most cases this should be done as the
                // last mounting-related operation because it replaces the root mapper
                setRootRequestMapper(new HttpsMapper(getRootRequestMapper(), new HttpsConfig(80, 443)));
        }
 }
 

any request to http://hostname:httpPort/secured will be redirected to https://hostname:httpsPort/secured

Constructor Summary

HttpsMapper(IRequestMapper delegate, HttpsConfig httpsConfig)
Construct.

Method Summary

int	getCompatibilityScore(Request request) Returns the score representing how compatible this request mapper is to processing the given request.
Url	mapHandler(IRequestHandler requestHandler) Returns the Url for given IRequestHandler or null if the request handler is not recognized.
IRequestHandler	mapRequest(Request request) Returns IRequestHandler for the request or null if the Url is not recognized.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsMapper

public HttpsMapper(IRequestMapper delegate,
                   HttpsConfig httpsConfig)

Construct.

Parameters:

delegate -

httpsConfig -

Method Detail

mapRequest

public IRequestHandler mapRequest(Request request)

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)

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

mapHandler

public Url mapHandler(IRequestHandler requestHandler)

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.