Top Description Fields Constructors Methods
org.eclipse.jetty.server.handler

public Class SecuredRedirectHandler

extends Wrapper
Class Inheritance
Imports
org.eclipse.jetty.http.HttpHeader, .HttpStatus, org.eclipse.jetty.server.Handler, .HttpConfiguration, .Request, .Response, org.eclipse.jetty.util.Callback, .URIUtil
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()

Field Summary

Modifier and TypeField and Description
private final int
_redirectCode

The redirect code to send in response.

Constructor Summary

AccessConstructor and Description
public
SecuredRedirectHandler()

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

public
SecuredRedirectHandler(int
the redirect code to use in the response
code)

Use supplied code as the redirect code.

public
SecuredRedirectHandler(Handler handler)

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

public
SecuredRedirectHandler(Handler
the handler to wrap
handler, int
the redirect code to use in the response
code)

Use supplied code as the redirect code.

Method Summary

Modifier and TypeMethod and Description
public boolean
handle(Request
the HTTP request to handle
request, Response
the HTTP response to handle
response, Callback
the callback to complete when the handling is complete
callback)

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

Implements org.eclipse.jetty.server.Request.Handler.handle.

Invoked to handle the passed HTTP request and response.

Inherited from org.eclipse.jetty.server.Handler.Wrapper:
getHandlergetInvocationTypesetHandler

Field Detail

_redirectCodeback to summary
private final int _redirectCode

The redirect code to send in response.

Constructor Detail

SecuredRedirectHandlerback to summary
public SecuredRedirectHandler()

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

SecuredRedirectHandlerback to summary
public SecuredRedirectHandler(int code)

Use supplied code as the redirect code.

Parameters
code:int

the redirect code to use in the response

Exceptions
IllegalArgumentException:
if parameter is an invalid redirect code
SecuredRedirectHandlerback to summary
public SecuredRedirectHandler(Handler handler)

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

SecuredRedirectHandlerback to summary
public SecuredRedirectHandler(Handler handler, int code)

Use supplied code as the redirect code.

Parameters
handler:Handler

the handler to wrap

code:int

the redirect code to use in the response

Exceptions
IllegalArgumentException:
if parameter is an invalid redirect code

Method Detail

handleback to summary
public boolean handle(Request request, Response response, Callback callback) throws Exception

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

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;
}
Parameters
request:Request

the HTTP request to handle

response:Response

the HTTP response to handle

callback:Callback

the callback to complete when the handling is complete

Returns:boolean

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.

Annotations
@Override
Exceptions
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.