org.jooby.whoops

Class Whoops

java.lang.Object

org.jooby.whoops.Whoops

All Implemented Interfaces:

Jooby.Module

public class Whoops
extends Object
implements Jooby.Module

whoops

Pretty error page that helps you debug your web application.

NOTE: This module is base on whoops and uses the same front end resources.

exports

• A pretty error page

usage

 {
   use(new Whoops());

   get("/", req -> {
     throw new IllegalStateException("Something broken!");
   });
 }
 

The pretty error page handler is available in development mode: application.env = dev

custom err pages

The pretty error page is implemented via Router#err(Handler). You might run into troubles if your application require custom error pages. On those cases you probably won't use this module or if apply one of the following options:

whoops as last err handler

This option is useful if you have custom error pages on some specific exceptions:

 {
   err(NotFoundException.class, (req, rsp, err) -> {
    // custom not found
   });

   err(AccessDeniedException.class, (req, rsp, err) -> {
    // custom access denied
   });

   // not handled it use whoops
   use(new Whoops());
 }
 

Here the custom error page for NotFoundException or AccessDeniedException will be render before the Whoops error handler.

whoops on dev

This options will active Whoops in dev and the custom err pages in prod-like environments:

 {
   on("dev", () -> {
     use(new Whoops());
   })
   .orElse(() -> {
     err((req, rsp, err) -> {
       // custom not found
     });
   });
 }
 

Since:

1.0.0.CR4

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Whoops() Creates a new Whoops module with max frame size of 8.
Whoops(int maxFrameSize) Creates a new Whoops module.

Method Summary

Modifier and Type	Method and Description
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Whoops

public Whoops(int maxFrameSize)

Creates a new Whoops module.

Parameters:

maxFrameSize - Max number of frame to show in the pretty error page.

Whoops

public Whoops()

Creates a new Whoops module with max frame size of 8.

Method Detail

configure

public void configure(Env env,
                      com.typesafe.config.Config conf,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module