DefaultHttpErrorHandler

Companion object DefaultHttpErrorHandler

class DefaultHttpErrorHandler extends HttpErrorHandler

The default HTTP error handler.

This class is intended to be extended, allowing users to reuse some of the functionality provided here.

Annotations: @Singleton()
Source: HttpErrorHandler.scala

Linear Supertypes

HttpErrorHandler, AnyRef, Any

Known Subclasses

DefaultHttpErrorHandler, DevHttpErrorHandler

Ordering

Alphabetic
By Inheritance

Inherited

DefaultHttpErrorHandler
HttpErrorHandler
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new DefaultHttpErrorHandler(environment: Environment, configuration: Configuration, sourceMapper: OptionalSourceMapper, router: Provider[Router])
Annotations
@Inject()
new DefaultHttpErrorHandler(environment: Environment, configuration: Configuration, sourceMapper: Option[SourceMapper], router: => Option[Router])
environment
The environment
router
An optional router. If provided, in dev mode, will be used to display more debug information when a handler can't be found. This is a lazy parameter, to avoid circular dependency issues, since the router may well depend on this.
new DefaultHttpErrorHandler(config: HttpErrorConfig = HttpErrorConfig(), sourceMapper: Option[SourceMapper] = None, router: => Option[Router] = None)
router
An optional router. If provided, in dev mode, will be used to display more debug information when a handler can't be found. This is a lazy parameter, to avoid circular dependency issues, since the router may well depend on this.

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def fatalErrorMessage(request: RequestHeader, exception: Throwable): String
Invoked when handling a server error with this error handler failed.
Invoked when handling a server error with this error handler failed.
As a last resort this method allows you to return a (simple) error message that will be send along with a "500 Internal Server Error" response. It's highly recommended to just return a simple string, without doing any fancy processing inside the method (like accessing files,...) that could throw exceptions. This is your last chance to send a meaningful error message when everything else failed.
request
The request that triggered the server error.
exception
The server error.
returns
An error message which will be send as last resort in case handling a server error with this error handler failed.
Attributes
protected
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def logServerError(request: RequestHeader, usefulException: UsefulException): Unit
Responsible for logging server errors.
Responsible for logging server errors.
This can be overridden to add additional logging information, eg. the id of the authenticated user.
request
The request that triggered the server error.
usefulException
The server error.
Attributes
protected
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
def onBadRequest(request: RequestHeader, message: String): Future[Result]
Invoked when a client makes a bad request.
Invoked when a client makes a bad request.
request
The request that was bad.
message
The error message.
Attributes
protected
def onClientError(request: RequestHeader, statusCode: Int, message: String): Future[Result]
Invoked when a client error occurs, that is, an error in the 4xx series.
Invoked when a client error occurs, that is, an error in the 4xx series.
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.
Definition Classes
DefaultHttpErrorHandler → HttpErrorHandler
def onDevServerError(request: RequestHeader, exception: UsefulException): Future[Result]
Invoked in dev mode when a server error occurs.
Invoked in dev mode when a server error occurs.
request
The request that triggered the error.
exception
The exception.
Attributes
protected
def onForbidden(request: RequestHeader, message: String): Future[Result]
Invoked when a client makes a request that was forbidden.
Invoked when a client makes a request that was forbidden.
request
The forbidden request.
message
The error message.
Attributes
protected
def onNotFound(request: RequestHeader, message: String): Future[Result]
Invoked when a handler or resource is not found.
Invoked when a handler or resource is not found.
request
The request that no handler was found to handle.
message
A message.
Attributes
protected
def onOtherClientError(request: RequestHeader, statusCode: Int, message: String): Future[Result]
Invoked when a client error occurs, that is, an error in the 4xx series, which is not handled by any of the other methods in this class already.
Invoked when a client error occurs, that is, an error in the 4xx series, which is not handled by any of the other methods in this class already.
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.
Attributes
protected
def onProdServerError(request: RequestHeader, exception: UsefulException): Future[Result]
Invoked in prod mode when a server error occurs.
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.
request
The request that triggered the error.
exception
The exception.
Attributes
protected
def onServerError(request: RequestHeader, exception: Throwable): Future[Result]
Invoked when a server error occurs.
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.
request
The request that triggered the server error.
exception
The server error.
Definition Classes
DefaultHttpErrorHandler → HttpErrorHandler
def setPlayEditor(editor: String): Unit
Sets the play editor to the given string after initialization.
Sets the play editor to the given string after initialization. Used for tests, or cases where the existing configuration isn't sufficient.
editor
the play editor string.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def fatalErrorMessage(request: RequestHeader, exception: Throwable): String
Invoked when handling a server error with this error handler failed.
Invoked when handling a server error with this error handler failed.
As a last resort this method allows you to return a (simple) error message that will be send along with a "500 Internal Server Error" response. It's highly recommended to just return a simple string, without doing any fancy processing inside the method (like accessing files,...) that could throw exceptions. This is your last chance to send a meaningful error message when everything else failed.
request
The request that triggered the server error.
exception
The server error.
returns
An error message which will be send as last resort in case handling a server error with this error handler failed.
Attributes
protected
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def logServerError(request: RequestHeader, usefulException: UsefulException): Unit
Responsible for logging server errors.
Responsible for logging server errors.
This can be overridden to add additional logging information, eg. the id of the authenticated user.
request
The request that triggered the server error.
usefulException
The server error.
Attributes
protected
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
def onBadRequest(request: RequestHeader, message: String): Future[Result]
Invoked when a client makes a bad request.
Invoked when a client makes a bad request.
request
The request that was bad.
message
The error message.
Attributes
protected
def onClientError(request: RequestHeader, statusCode: Int, message: String): Future[Result]
Invoked when a client error occurs, that is, an error in the 4xx series.
Invoked when a client error occurs, that is, an error in the 4xx series.
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.
Definition Classes
DefaultHttpErrorHandler → HttpErrorHandler
def onDevServerError(request: RequestHeader, exception: UsefulException): Future[Result]
Invoked in dev mode when a server error occurs.
Invoked in dev mode when a server error occurs.
request
The request that triggered the error.
exception
The exception.
Attributes
protected
def onForbidden(request: RequestHeader, message: String): Future[Result]
Invoked when a client makes a request that was forbidden.
Invoked when a client makes a request that was forbidden.
request
The forbidden request.
message
The error message.
Attributes
protected
def onNotFound(request: RequestHeader, message: String): Future[Result]
Invoked when a handler or resource is not found.
Invoked when a handler or resource is not found.
request
The request that no handler was found to handle.
message
A message.
Attributes
protected
def onOtherClientError(request: RequestHeader, statusCode: Int, message: String): Future[Result]
Invoked when a client error occurs, that is, an error in the 4xx series, which is not handled by any of the other methods in this class already.
Invoked when a client error occurs, that is, an error in the 4xx series, which is not handled by any of the other methods in this class already.
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.
Attributes
protected
def onProdServerError(request: RequestHeader, exception: UsefulException): Future[Result]
Invoked in prod mode when a server error occurs.
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.
request
The request that triggered the error.
exception
The exception.
Attributes
protected
def onServerError(request: RequestHeader, exception: Throwable): Future[Result]
Invoked when a server error occurs.
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.
request
The request that triggered the server error.
exception
The server error.
Definition Classes
DefaultHttpErrorHandler → HttpErrorHandler
def setPlayEditor(editor: String): Unit
Sets the play editor to the given string after initialization.
Sets the play editor to the given string after initialization. Used for tests, or cases where the existing configuration isn't sufficient.
editor
the play editor string.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

DefaultHttpErrorHandler

Companion object DefaultHttpErrorHandler

class DefaultHttpErrorHandler extends HttpErrorHandler

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

DefaultHttpErrorHandler

Companion object DefaultHttpErrorHandler

class DefaultHttpErrorHandler extends HttpErrorHandler

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

DefaultHttpErrorHandler