play.http

Class DefaultHttpErrorHandler

java.lang.Object

play.http.DefaultHttpErrorHandler

All Implemented Interfaces:

HttpErrorHandler

public class DefaultHttpErrorHandler
extends java.lang.Object
implements HttpErrorHandler

Default implementation of the http error handler. This class is intended to be extended to allow reusing Play's default error handling functionality.

Constructor Summary

Constructors

Constructor and Description
DefaultHttpErrorHandler(Configuration configuration, Environment environment, play.api.OptionalSourceMapper sourceMapper, javax.inject.Provider<play.api.routing.Router> routes)

Method Summary

Modifier and Type	Method and Description
protected void	logServerError(Http.RequestHeader request, play.api.UsefulException usefulException) Responsible for logging server errors.
protected F.Promise<Result>	onBadRequest(Http.RequestHeader request, java.lang.String message) Invoked when a client makes a bad request.
F.Promise<Result>	onClientError(Http.RequestHeader request, int statusCode, java.lang.String message) Invoked when a client error occurs, that is, an error in the 4xx series.
protected F.Promise<Result>	onDevServerError(Http.RequestHeader request, play.api.UsefulException exception) Invoked in dev mode when a server error occurs.
protected F.Promise<Result>	onForbidden(Http.RequestHeader request, java.lang.String message) Invoked when a client makes a request that was forbidden.
protected F.Promise<Result>	onNotFound(Http.RequestHeader request, java.lang.String message) Invoked when a handler or resource is not found.
protected F.Promise<Result>	onProdServerError(Http.RequestHeader request, play.api.UsefulException exception) Invoked in prod mode when a server error occurs.
F.Promise<Result>	onServerError(Http.RequestHeader request, java.lang.Throwable exception) Invoked when a server error occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttpErrorHandler

@Inject
public DefaultHttpErrorHandler(Configuration configuration,
                                       Environment environment,
                                       play.api.OptionalSourceMapper sourceMapper,
                                       javax.inject.Provider<play.api.routing.Router> routes)

Method Detail

onClientError

public F.Promise<Result> onClientError(Http.RequestHeader request,
                                       int statusCode,
                                       java.lang.String message)

Invoked when a client error occurs, that is, an error in the 4xx series.

Specified by:

onClientError in interface HttpErrorHandler

Parameters:

request - The request that caused the client error.

statusCode - The error status code. Must be greater or equal to 400, and less than 500.

message - The error message.

onBadRequest

protected F.Promise<Result> onBadRequest(Http.RequestHeader request,
                                         java.lang.String message)

Invoked when a client makes a bad request.

Parameters:

request - The request that was bad.

message - The error message.

onForbidden

protected F.Promise<Result> onForbidden(Http.RequestHeader request,
                                        java.lang.String message)

Invoked when a client makes a request that was forbidden.

Parameters:

request - The forbidden request.

message - The error message.

onNotFound

protected F.Promise<Result> onNotFound(Http.RequestHeader request,
                                       java.lang.String message)

Invoked when a handler or resource is not found.

Parameters:

request - The request that no handler was found to handle.

message - A message.

onServerError

public F.Promise<Result> onServerError(Http.RequestHeader request,
                                       java.lang.Throwable exception)

Invoked when a server error occurs. By default, the implementation of this method delegates to [[onProdServerError()]] when in prod mode, and [[onDevServerError()]] in dev mode. It is recommended, if you want Play's debug info on the error page in dev mode, that you override [[onProdServerError()]] instead of this method.

Specified by:

onServerError in interface HttpErrorHandler

Parameters:

request - The request that triggered the server error.

exception - The server error.

logServerError

protected void logServerError(Http.RequestHeader request,
                              play.api.UsefulException usefulException)

Responsible for logging server errors. This can be overridden to add additional logging information, eg. the id of the authenticated user.

Parameters:

request - The request that triggered the server error.

usefulException - The server error.

onDevServerError

protected F.Promise<Result> onDevServerError(Http.RequestHeader request,
                                             play.api.UsefulException exception)

Invoked in dev mode when a server error occurs.

Parameters:

request - The request that triggered the error.

exception - The exception.

onProdServerError

protected F.Promise<Result> onProdServerError(Http.RequestHeader request,
                                              play.api.UsefulException exception)

Invoked in prod mode when a server error occurs. Override this rather than [[onServerError()]] if you don't want to change Play's debug output when logging errors in dev mode.

Parameters:

request - The request that triggered the error.

exception - The exception.