org.apache.wicket.protocol.https

Class HttpsMapper

java.lang.Object

org.apache.wicket.protocol.https.HttpsMapper

All Implemented Interfaces:

IRequestMapper, IRequestMapperDelegate

public class HttpsMapper
extends Object
implements IRequestMapperDelegate

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

Author:

igor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpsMapper.RedirectHandler Handler that takes care of redirecting

Constructor Summary

Constructors

Constructor and Description
HttpsMapper(IRequestMapper delegate, HttpsConfig config) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected IRequestHandler	createRedirectHandler(String url) Creates the IRequestHandler that will be responsible for the redirect
protected String	createRedirectUrl(IRequestHandler handler, Request request, Scheme scheme) Constructs a redirect url that should switch the user to the specified scheme
int	getCompatibilityScore(Request request)
HttpsConfig	getConfig()
IRequestMapper	getDelegateMapper()
protected Scheme	getDesiredSchemeFor(Class<? extends IRequestablePage> pageClass) Determines which Scheme should be used to access the page
protected Scheme	getDesiredSchemeFor(IRequestHandler handler) Figures out which Scheme should be used to access the request handler
protected Scheme	getSchemeOf(Request request) Determines the Scheme of the request
Url	mapHandler(IRequestHandler handler)
IRequestHandler	mapRequest(Request request)

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 config)

Constructor

Parameters:

delegate -

config -

Method Detail

getDelegateMapper

public IRequestMapper getDelegateMapper()

Specified by:

getDelegateMapper in interface IRequestMapperDelegate

getCompatibilityScore

public final int getCompatibilityScore(Request request)

Specified by:

getCompatibilityScore in interface IRequestMapper

mapRequest

public final IRequestHandler mapRequest(Request request)

Specified by:

mapRequest in interface IRequestMapper

mapHandler

public final Url mapHandler(IRequestHandler handler)

Specified by:

mapHandler in interface IRequestMapper

createRedirectHandler

protected IRequestHandler createRedirectHandler(String url)

Creates the IRequestHandler that will be responsible for the redirect

Parameters:

url -

Returns:

request handler

createRedirectUrl

protected String createRedirectUrl(IRequestHandler handler,
                       Request request,
                       Scheme scheme)

Constructs a redirect url that should switch the user to the specified scheme

Parameters:

handler - request handler being accessed

request - current request

scheme - desired scheme for the redirect url

Returns:

url

getDesiredSchemeFor

protected Scheme getDesiredSchemeFor(IRequestHandler handler)

Figures out which Scheme should be used to access the request handler

Parameters:

handler - request handler

Returns:

Scheme

getSchemeOf

protected Scheme getSchemeOf(Request request)

Determines the Scheme of the request

Parameters:

request -

Returns:

Scheme.HTTPS or Scheme.HTTP

getDesiredSchemeFor

protected Scheme getDesiredSchemeFor(Class<? extends IRequestablePage> pageClass)

Determines which Scheme should be used to access the page

Parameters:

pageClass - type of page

Returns:

Scheme

getConfig

public final HttpsConfig getConfig()

Returns:

config with which this mapper was created