2 // ========================================================================
3 // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
19 package org.eclipse.jetty.server.handler;
21 import java.io.IOException;
22 import java.io.PrintWriter;
23 import java.io.StringWriter;
24 import java.io.Writer;
25 import java.nio.ByteBuffer;
27 import javax.servlet.ServletException;
28 import javax.servlet.http.HttpServletRequest;
29 import javax.servlet.http.HttpServletResponse;
31 import org.eclipse.jetty.http.HttpFields;
32 import org.eclipse.jetty.http.HttpHeader;
33 import org.eclipse.jetty.http.HttpMethod;
34 import org.eclipse.jetty.http.HttpStatus;
35 import org.eclipse.jetty.http.MimeTypes;
36 import org.eclipse.jetty.server.Dispatcher;
37 import org.eclipse.jetty.server.Request;
38 import org.eclipse.jetty.server.Response;
39 import org.eclipse.jetty.server.Server;
40 import org.eclipse.jetty.util.BufferUtil;
41 import org.eclipse.jetty.util.ByteArrayISO8859Writer;
42 import org.eclipse.jetty.util.log.Log;
43 import org.eclipse.jetty.util.log.Logger;
45 /* ------------------------------------------------------------ */
46 /** Handler for Error pages
47 * An ErrorHandler is registered with {@link ContextHandler#setErrorHandler(ErrorHandler)} or
48 * {@link org.eclipse.jetty.server.Server#addBean(Object)}.
49 * It is called by the HttpResponse.sendError method to write a error page via {@link #handle(String, Request, HttpServletRequest, HttpServletResponse)}
50 * or via {@link #badMessageError(int, String, HttpFields)} for bad requests for which a dispatch cannot be done.
53 public class ErrorHandler extends AbstractHandler
55 private static final Logger LOG = Log.getLogger(ErrorHandler.class);
56 public final static String ERROR_PAGE="org.eclipse.jetty.server.error_page";
58 boolean _showStacks=true;
59 boolean _showMessageInTitle=true;
60 String _cacheControl="must-revalidate,no-cache,no-store";
62 /* ------------------------------------------------------------ */
64 * @see org.eclipse.jetty.server.server.Handler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)
67 public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException
69 String method = request.getMethod();
70 if (!HttpMethod.GET.is(method) && !HttpMethod.POST.is(method) && !HttpMethod.HEAD.is(method))
72 baseRequest.setHandled(true);
76 if (this instanceof ErrorPageMapper)
78 String error_page=((ErrorPageMapper)this).getErrorPage(request);
79 if (error_page!=null && request.getServletContext()!=null)
81 String old_error_page=(String)request.getAttribute(ERROR_PAGE);
82 if (old_error_page==null || !old_error_page.equals(error_page))
84 request.setAttribute(ERROR_PAGE, error_page);
86 Dispatcher dispatcher = (Dispatcher) request.getServletContext().getRequestDispatcher(error_page);
91 dispatcher.error(request, response);
94 LOG.warn("No error page "+error_page);
96 catch (ServletException e)
98 LOG.warn(Log.EXCEPTION, e);
105 baseRequest.setHandled(true);
106 response.setContentType(MimeTypes.Type.TEXT_HTML_8859_1.asString());
107 if (_cacheControl!=null)
108 response.setHeader(HttpHeader.CACHE_CONTROL.asString(), _cacheControl);
109 ByteArrayISO8859Writer writer= new ByteArrayISO8859Writer(4096);
110 String reason=(response instanceof Response)?((Response)response).getReason():null;
111 handleErrorPage(request, writer, response.getStatus(), reason);
113 response.setContentLength(writer.size());
114 writer.writeTo(response.getOutputStream());
118 /* ------------------------------------------------------------ */
119 protected void handleErrorPage(HttpServletRequest request, Writer writer, int code, String message)
122 writeErrorPage(request, writer, code, message, _showStacks);
125 /* ------------------------------------------------------------ */
126 protected void writeErrorPage(HttpServletRequest request, Writer writer, int code, String message, boolean showStacks)
130 message=HttpStatus.getMessage(code);
132 writer.write("<html>\n<head>\n");
133 writeErrorPageHead(request,writer,code,message);
134 writer.write("</head>\n<body>");
135 writeErrorPageBody(request,writer,code,message,showStacks);
136 writer.write("\n</body>\n</html>\n");
139 /* ------------------------------------------------------------ */
140 protected void writeErrorPageHead(HttpServletRequest request, Writer writer, int code, String message)
143 writer.write("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/>\n");
144 writer.write("<title>Error ");
145 writer.write(Integer.toString(code));
147 if (_showMessageInTitle)
150 write(writer,message);
152 writer.write("</title>\n");
155 /* ------------------------------------------------------------ */
156 protected void writeErrorPageBody(HttpServletRequest request, Writer writer, int code, String message, boolean showStacks)
159 String uri= request.getRequestURI();
161 writeErrorPageMessage(request,writer,code,message,uri);
163 writeErrorPageStacks(request,writer);
164 writer.write("<hr><i><small>Powered by Jetty://</small></i><hr/>\n");
167 /* ------------------------------------------------------------ */
168 protected void writeErrorPageMessage(HttpServletRequest request, Writer writer, int code, String message,String uri)
171 writer.write("<h2>HTTP ERROR ");
172 writer.write(Integer.toString(code));
173 writer.write("</h2>\n<p>Problem accessing ");
175 writer.write(". Reason:\n<pre> ");
176 write(writer,message);
177 writer.write("</pre></p>");
180 /* ------------------------------------------------------------ */
181 protected void writeErrorPageStacks(HttpServletRequest request, Writer writer)
184 Throwable th = (Throwable)request.getAttribute("javax.servlet.error.exception");
187 writer.write("<h3>Caused by:</h3><pre>");
188 StringWriter sw = new StringWriter();
189 PrintWriter pw = new PrintWriter(sw);
190 th.printStackTrace(pw);
192 write(writer,sw.getBuffer().toString());
193 writer.write("</pre>\n");
199 /* ------------------------------------------------------------ */
200 /** Bad Message Error body
201 * <p>Generate a error response body to be sent for a bad message.
202 * In this case there is something wrong with the request, so either
203 * a request cannot be built, or it is not safe to build a request.
204 * This method allows for a simple error page body to be returned
205 * and some response headers to be set.
206 * @param status The error code that will be sent
207 * @param reason The reason for the error code (may be null)
208 * @param fields The header fields that will be sent with the response.
209 * @return The content as a ByteBuffer, or null for no body.
211 public ByteBuffer badMessageError(int status, String reason, HttpFields fields)
214 reason=HttpStatus.getMessage(status);
215 fields.put(HttpHeader.CONTENT_TYPE,MimeTypes.Type.TEXT_HTML_8859_1.asString());
216 return BufferUtil.toBuffer("<h1>Bad Message " + status + "</h1><pre>reason: " + reason + "</pre>");
219 /* ------------------------------------------------------------ */
220 /** Get the cacheControl.
221 * @return the cacheControl header to set on error responses.
223 public String getCacheControl()
225 return _cacheControl;
228 /* ------------------------------------------------------------ */
229 /** Set the cacheControl.
230 * @param cacheControl the cacheControl header to set on error responses.
232 public void setCacheControl(String cacheControl)
234 _cacheControl = cacheControl;
237 /* ------------------------------------------------------------ */
239 * @return True if stack traces are shown in the error pages
241 public boolean isShowStacks()
246 /* ------------------------------------------------------------ */
248 * @param showStacks True if stack traces are shown in the error pages
250 public void setShowStacks(boolean showStacks)
252 _showStacks = showStacks;
255 /* ------------------------------------------------------------ */
257 * @param showMessageInTitle if true, the error message appears in page title
259 public void setShowMessageInTitle(boolean showMessageInTitle)
261 _showMessageInTitle = showMessageInTitle;
265 /* ------------------------------------------------------------ */
266 public boolean getShowMessageInTitle()
268 return _showMessageInTitle;
271 /* ------------------------------------------------------------ */
272 protected void write(Writer writer,String string)
278 for (int i=0;i<string.length();i++)
280 char c=string.charAt(i);
285 writer.write("&");
288 writer.write("<");
291 writer.write(">");
295 if (Character.isISOControl(c) && !Character.isWhitespace(c))
303 /* ------------------------------------------------------------ */
304 public interface ErrorPageMapper
306 String getErrorPage(HttpServletRequest request);
309 /* ------------------------------------------------------------ */
310 public static ErrorHandler getErrorHandler(Server server, ContextHandler context)
312 ErrorHandler error_handler=null;
314 error_handler=context.getErrorHandler();
315 if (error_handler==null && server!=null)
316 error_handler = server.getBean(ErrorHandler.class);
317 return error_handler;