Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Jetty/Howto/Custom Error Pages"
Line 30: | Line 30: | ||
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd"> | <!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd"> | ||
− | <Configure class="org. | + | <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
<Set name="contextPath">/test</Set> | <Set name="contextPath">/test</Set> | ||
<Set name="war"> | <Set name="war"> | ||
Line 95: | Line 95: | ||
{code} | {code} | ||
− | + | ==Server level 404 error== | |
One may 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, will give a listing of all contexts running on the server. | One may 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, will give 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. | |
− | One of the quickest ways to avoid this behavior is to create a catch all context. Create a "root" web app mapped to the "/" | + | | category = [[category:Jetty Howto]] |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | | category = [[ | + | |
}} | }} |
Revision as of 09:13, 10 February 2010
Introduction
There are three ways to create custom error pages that are described below.
Define error pages in web.xml
The standard webapp configuration file located in <webapp>/WEB-INF/web.xml can be used 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 - integer value
- exception-type - fully qualified class name of a Java Exception type
- location - location of the resource in webapp relative to the root of the web application. Value should start with "/".
Error code example:
<error-page> <error-code>404</error-code> <location>/jspsnoop/ERROR/404</location> </error-page>
Exception example:
<error-page> <exception-type>java.io.IOException</exception-type> <location>/jspsnoop/IOException</location> </error-page>
Context file configuration
Context files are normally located in <jetty.home>/contexts/ (see Jetty/Feature/ContextDeployer for more details). Context files can be used to configure the default error handler provided for a context with more flexibility than is available with web.xml, specifically with the support of error code ranges:
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd"> <Configure class="org.eclipse.jetty.webapp.WebAppContext"> <Set name="contextPath">/test</Set> <Set name="war"> <SystemProperty name="jetty.home" default="."/>/webapps/test </Set> <!-- by Code --> <Get name="errorHandler"> <Call name="addErrorPage"> <Arg type="int">404</Arg> <Arg type="String">/jspsnoop/ERROR/404</Arg> </Call> </Get> <!-- by Exception --> <Get name="errorHandler"> <Call name="addErrorPage"> <Arg type="java.lang.Class">java.io.IOException</Arg> <Arg type="String">/jspsnoop/IOException</Arg> </Call> </Get> <!-- by Code Range --> <Get name="errorHandler"> <Call name="addErrorPage"> <Arg type="int">500</Arg> <Arg type="int">599</Arg> <Arg type="String">/dump/errorCodeRangeMapping</Arg> </Call> </Get> </Configure>
h2. 3. Custom error handle class.
A context may be configured with a custom error handler class that extends [ErrorHandler