Class SecuredRedirectHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.Handler.Abstract
org.eclipse.jetty.server.Handler.AbstractContainer
org.eclipse.jetty.server.Handler.Wrapper
org.eclipse.jetty.server.handler.SecuredRedirectHandler
All Implemented Interfaces:
Handler, Handler.Container, Handler.Singleton, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
public class SecuredRedirectHandler extends Handler.Wrapper
Forces a redirect to the secure form of the resource before allowed to access the resource.

SecuredRedirectHandler enforces that all requests passing through it must have Request.isSecure() set to true.

SecuredRedirectHandler will send a Redirect HTTP Response (default to 302: Moved Temporarily) with the information present in the HttpConfiguration for the connector that the response is being processed on. The Location response header will be built from HttpConfiguration.getSecureScheme() and HttpConfiguration.getSecurePort()

  • Constructor Details

    • SecuredRedirectHandler

      public SecuredRedirectHandler()
      Uses moved temporarily code (302) as the redirect code.

    • SecuredRedirectHandler

      public SecuredRedirectHandler(int code)
      Use supplied code as the redirect code.
      Parameters:
      code - the redirect code to use in the response
      Throws:
      IllegalArgumentException - if parameter is an invalid redirect code

    • SecuredRedirectHandler

      public SecuredRedirectHandler(Handler handler)
      Uses moved temporarily code (302) as the redirect code.

    • SecuredRedirectHandler

      public SecuredRedirectHandler(Handler handler, int code)
      Use supplied code as the redirect code.
      Parameters:
      handler - the handler to wrap
      code - the redirect code to use in the response
      Throws:
      IllegalArgumentException - if parameter is an invalid redirect code

  • Method Details

    • handle

      public boolean handle(Request request, Response response, Callback callback) throws Exception
      Description copied from interface: Request.Handler

      Invoked to handle the passed HTTP request and response.

      The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

      Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

      The simplest implementation is:

      public boolean handle(Request request, Response response, Callback callback)
{
    callback.succeeded();
    return true;
}

      A HelloWorld implementation is:

      public boolean handle(Request request, Response response, Callback callback)
{
    response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
    return true;
}
      Specified by:
      handle in interface Request.Handler
      Overrides:
      handle in class Handler.Wrapper
      Parameters:
      request - the HTTP request to handle
      response - the HTTP response to handle
      callback - the callback to complete when the handling is complete
      Returns:
      True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
      Throws:
      Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.
      See Also: