Class

play.api.http

JsonHttpErrorHandler

Related Doc: package http

Permalink

class JsonHttpErrorHandler extends HttpErrorHandler

An alternative default HTTP error handler which will render errors as JSON messages instead of HTML pages.

In Dev mode, exceptions thrown by the server code will be rendered in JSON messages. In Prod mode, they will not be rendered.

You could override how exceptions are rendered in Dev mode by extending this class and overriding the formatDevServerErrorException method.

Source
HttpErrorHandler.scala
Linear Supertypes
HttpErrorHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonHttpErrorHandler
  2. HttpErrorHandler
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JsonHttpErrorHandler(environment: Environment, optionalSourceMapper: OptionalSourceMapper)

    Permalink
    Annotations
    @Inject()

  2. new JsonHttpErrorHandler(environment: Environment, sourceMapper: Option[SourceMapper] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def devServerError(request: RequestHeader, exception: UsefulException): JsValue

    Permalink
    Attributes
    protected

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. def formatDevServerErrorException(exception: Throwable): JsValue

    Permalink

    Format a Throwable as a JSON value.

    Format a Throwable as a JSON value.

    Override this method if you want to change how exceptions are rendered in Dev mode.

    Attributes
    protected

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. def logServerError(request: RequestHeader, usefulException: UsefulException): Unit

    Permalink

    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

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def onClientError(request: RequestHeader, statusCode: Int, message: String): Future[Result]

    Permalink

    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
    JsonHttpErrorHandler → HttpErrorHandler

  19. def onServerError(request: RequestHeader, exception: Throwable): Future[Result]

    Permalink

    Invoked when a server error occurs.

    Invoked when a server error occurs.

    request

    The request that triggered the server error.

    exception

    The server error.

    Definition Classes
    JsonHttpErrorHandler → HttpErrorHandler

  20. def prodServerError(request: RequestHeader, exception: UsefulException): JsValue

    Permalink
    Attributes
    protected

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HttpErrorHandler

Inherited from AnyRef

Inherited from Any

Ungrouped