Source Code Cross Referenced for ErrorStatusServlet.java in  » EJB-Server-resin-3.1.5 » resin » com » caucho » servlets » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:         * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03:         *
04:         * This file is part of Resin(R) Open Source
05:         *
06:         * Each copy or derived work must preserve the copyright notice and this
07:         * notice unmodified.
08:         *
09:         * Resin Open Source is free software; you can redistribute it and/or modify
10:         * it under the terms of the GNU General Public License as published by
11:         * the Free Software Foundation; either version 2 of the License, or
12:         * (at your option) any later version.
13:         *
14:         * Resin Open Source is distributed in the hope that it will be useful,
15:         * but WITHOUT ANY WARRANTY; without even the implied warranty of
16:         * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17:         * of NON-INFRINGEMENT.  See the GNU General Public License for more
18:         * details.
19:         *
20:         * You should have received a copy of the GNU General Public License
21:         * along with Resin Open Source; if not, write to the
22:         *   Free SoftwareFoundation, Inc.
23:         *   59 Temple Place, Suite 330
24:         *   Boston, MA 02111-1307  USA
25:         *
26:         * @author Scott Ferguson
27:         */
28:
29:        package com.caucho.servlets;
30:
31:        import javax.servlet.GenericServlet;
32:        import javax.servlet.ServletException;
33:        import javax.servlet.ServletRequest;
34:        import javax.servlet.ServletResponse;
35:        import javax.servlet.http.HttpServletResponse;
36:        import java.io.IOException;
37:
38:        /**
39:         * Use ServletResponse.sendError() to send an error to the client.
40:         *
41:         * <pre>
42:         * &lt;servlet&gt;
43:         *   &lt;servlet-name&gt;forbidden&lt;/servlet-name&gt;
44:         *   &lt;servlet-class&gt;com.caucho.servlets.ErrorStatusServlet&lt;/servlet-class&gt;
45:         *   &lt;init&gt;
46:         *     &lt;status-code&gt;403&lt;/status-code&gt;
47:         *     &lt;message&gt;You cannot look at that.&lt;/message&gt;
48:         *   &lt;/init&gt;
49:         * &lt;/servlet&gt;
50:         *
51:         * &lt;servlet-mapping url-pattern="*.properties" servlet-name="forbidden"/&gt;
52:         * &lt;servlet-mapping url-pattern="/config/*" servlet-name="forbidden"/&gt;
53:         * </pre>
54:         */
55:        public class ErrorStatusServlet extends GenericServlet {
56:            private int _statusCode = 404;
57:            private String _message;
58:
59:            /**
60:             * The status code to send, default 404 (Not Found).
61:             */
62:            public void setStatusCode(int code) {
63:                _statusCode = code;
64:            }
65:
66:            /**
67:             * The message to send, default is to send no message.
68:             */
69:            public void setMessage(String message) {
70:                _message = message;
71:            }
72:
73:            public void service(ServletRequest request, ServletResponse response)
74:                    throws ServletException, IOException {
75:                HttpServletResponse res = (HttpServletResponse) response;
76:
77:                if (_message != null)
78:                    res.sendError(_statusCode, _message);
79:                else
80:                    res.sendError(_statusCode);
81:            }
82:        }