Jetty Logo
Version: 9.2.2-SNAPSHOT
Contact the core Jetty developers at www.webtide.com

private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery

Creating Custom Error Pages

Defining error pages in web.xml
Configuring error pages context files
Custom ErrorHandler class
Server level 404 error

The following sections describe several ways to create custom error pages in Jetty.

Defining error pages in web.xml

You can use the standard webapp configuration file located in webapp/WEB-INF/web.xml to map errors to specific URLs with the error-page element. This element creates a mapping between the error-code or exception-type to the location of a resource in the web application.

  • error-code - an integer value

  • exception-type - a fully qualified class name of a Java Exception type

  • location - location of the resource in the webapp relative to the root of the web application. Value should start with "/".

Error code example:

Exception example:

The error page mappings created with the error-page element will redirect to a normal URL within the web application and will be handled as a normal request to that location and thus may be static content, a JSP or a filter and/or servlet. When handling a request generated by an error redirection, the following request attributes are set and are available to generate dynamic content:

javax.servlet.error.exception

The exception instance that caused the error (or null)

javax.servlet.error.exception_type

The class name of the exception instance that caused the error (or null)

javax.servlet.error.message

The error message.

javax.servlet.error.request_uri

The URI of the errored request.

javax.servlet.error.servlet_name

The Servlet name of the servlet that the errored request was dispatched to/

javax.servlet.error.status_code

The status code of the error (e.g. 404, 500 etc.)

Configuring error pages context files

You can use context IoC XML files to configure the default error page mappings with more flexibility than is available with web.xml, specifically with the support of error code ranges. Context files are normally located in ${jetty.home}/webapps/ (see DeployerManager for more details) and an example of more flexible error page mapping is below:

Custom ErrorHandler class

If no error page mapping is defined, or if the error page resource itself has an error, then the error page will be generated by an instance of ErrorHandler configured either the Context or the Server. An ErrorHandler may extend the ErrorHandler class and may totally replace the handle method to generate an error page, or it can implement some or all of the following methods to partially modify the error pages:

An ErrorHandler instance may be set on a Context by calling the ContextHandler.setErrorHandler method. This can be done by embedded code or via context IoC XML. For example:

An ErrorHandler instance may be set on the entire server by setting it as a dependent bean on the Server instance. This can be done by calling Server.addBean(Object) via embedded code or in jetty.xml IoC XML like:

Server level 404 error

You might get a 'page not found' when a request is made to the server for a resource that is outside of any registered contexts. As an example, you have a domain name pointing to your public server IP, yet no context is registered with jetty to serve pages for that domain. As a consequence, the server, by default, gives a listing of all contexts running on the server.

One of the quickest ways to avoid this behavior is to create a catch all context. Create a "root" web app mapped to the "/" URI. Have the index.html redirect to whatever place with a header directive.

See an error or something missing? Contribute to this documentation at Github!(Generated: 2014-07-25T01:00:36-07:00)