Class ErrorHandler

java.lang.Object
io.vertx.mutiny.ext.web.handler.ErrorHandler
All Implemented Interfaces:
MutinyDelegate, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>

public class ErrorHandler extends Object implements io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>, MutinyDelegate
A pretty error handler for rendering error pages. When working in development mode exception details will be returned in the server responses, otherwise or when manually specified no exception details are returned in the HTTP response. The reason the display of the exception details is by default dependent of the mode is to follow the security best practices: https://www.owasp.org/index.php/Improper_Error_Handling

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Tim Fox, Paulo Lopes
See Also:
  • ErrorHandler
  • Field Details

    • DEFAULT_ERROR_HANDLER_TEMPLATE

      public static final String DEFAULT_ERROR_HANDLER_TEMPLATE
      The default template to use for rendering
      See Also:
    • __TYPE_ARG

      public static final TypeArg<ErrorHandler> __TYPE_ARG
  • Constructor Details

    • ErrorHandler

      public ErrorHandler(io.vertx.ext.web.handler.ErrorHandler delegate)
      Create a new instance of ErrorHandler delegating to the given (non-null) instance of ErrorHandler.
    • ErrorHandler

      public ErrorHandler(Object delegate)
  • Method Details

    • accept

      public void accept(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      accept in interface Consumer<RoutingContext>
    • handle

      public void handle(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      handle in interface io.vertx.core.Handler<RoutingContext>
    • getDelegate

      public io.vertx.ext.web.handler.ErrorHandler getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance
    • create

      public static ErrorHandler create(Vertx vertx)
      Create an error handler using defaults
      Returns:
      the handler
    • create

      public static ErrorHandler create(Vertx vertx, String errorTemplateName, boolean displayExceptionDetails)
      Create an error handler
      Parameters:
      errorTemplateName - the error template name - will be looked up from the classpath
      displayExceptionDetails - true if exception details should be displayed
      Returns:
      the handler
    • create

      public static ErrorHandler create(Vertx vertx, boolean displayExceptionDetails)
      Create an error handler
      Parameters:
      displayExceptionDetails - true if exception details should be displayed
      Returns:
      the handler
    • create

      public static ErrorHandler create(Vertx vertx, String errorTemplateName)
      Create an error handler
      Parameters:
      errorTemplateName - the error template name - will be looked up from the classpath
      Returns:
      the handler
    • newInstance

      public static ErrorHandler newInstance(io.vertx.ext.web.handler.ErrorHandler delegate)
      Creates a new instance of the ErrorHandler.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object