001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/deploy/ErrorPage.java,v 1.4 2001/07/22 20:25:10 pier Exp $
003: * $Revision: 1.4 $
004: * $Date: 2001/07/22 20:25:10 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.deploy;
065:
066: import org.apache.catalina.util.RequestUtil;
067:
068: /**
069: * Representation of an error page element for a web application,
070: * as represented in a <code><error-page></code> element in the
071: * deployment descriptor.
072: *
073: * @author Craig R. McClanahan
074: * @version $Revision: 1.4 $ $Date: 2001/07/22 20:25:10 $
075: */
076:
077: public final class ErrorPage {
078:
079: // ----------------------------------------------------- Instance Variables
080:
081: /**
082: * The error (status) code for which this error page is active.
083: */
084: private int errorCode = 0;
085:
086: /**
087: * The exception type for which this error page is active.
088: */
089: private String exceptionType = null;
090:
091: /**
092: * The context-relative location to handle this error or exception.
093: */
094: private String location = null;
095:
096: // ------------------------------------------------------------- Properties
097:
098: /**
099: * Return the error code.
100: */
101: public int getErrorCode() {
102:
103: return (this .errorCode);
104:
105: }
106:
107: /**
108: * Set the error code.
109: *
110: * @param errorCode The new error code
111: */
112: public void setErrorCode(int errorCode) {
113:
114: this .errorCode = errorCode;
115:
116: }
117:
118: /**
119: * Set the error code (hack for default XmlMapper data type).
120: *
121: * @param errorCode The new error code
122: */
123: public void setErrorCode(String errorCode) {
124:
125: try {
126: this .errorCode = Integer.parseInt(errorCode);
127: } catch (Throwable t) {
128: this .errorCode = 0;
129: }
130:
131: }
132:
133: /**
134: * Return the exception type.
135: */
136: public String getExceptionType() {
137:
138: return (this .exceptionType);
139:
140: }
141:
142: /**
143: * Set the exception type.
144: *
145: * @param exceptionType The new exception type
146: */
147: public void setExceptionType(String exceptionType) {
148:
149: this .exceptionType = exceptionType;
150:
151: }
152:
153: /**
154: * Return the location.
155: */
156: public String getLocation() {
157:
158: return (this .location);
159:
160: }
161:
162: /**
163: * Set the location.
164: *
165: * @param location The new location
166: */
167: public void setLocation(String location) {
168:
169: // if ((location == null) || !location.startsWith("/"))
170: // throw new IllegalArgumentException
171: // ("Error Page Location must start with a '/'");
172: this .location = RequestUtil.URLDecode(location);
173:
174: }
175:
176: // --------------------------------------------------------- Public Methods
177:
178: /**
179: * Render a String representation of this object.
180: */
181: public String toString() {
182:
183: StringBuffer sb = new StringBuffer("ErrorPage[");
184: if (exceptionType == null) {
185: sb.append("errorCode=");
186: sb.append(errorCode);
187: } else {
188: sb.append("exceptionType=");
189: sb.append(exceptionType);
190: }
191: sb.append(", location=");
192: sb.append(location);
193: sb.append("]");
194: return (sb.toString());
195:
196: }
197:
198: }
|