1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.util.descriptor.web;
import java.io.Serial;
import java.io.Serializable;
import java.util.Objects;
import org.apache.tomcat.util.buf.UDecoder;
/**
* Representation of an error page element for a web application, as represented in a <code><error-page></code>
* element in the deployment descriptor.
*/
public class ErrorPage extends XmlEncodingBase implements Serializable {
@Serial
private static final long serialVersionUID = 2L;
// ----------------------------------------------------- Instance Variables
/**
* The error (status) code for which this error page is active. Note that status code 0 is used for the default
* error page.
*/
private int errorCode = 0;
/**
* The exception type for which this error page is active.
*/
private String exceptionType = null;
/**
* The context-relative location to handle this error or exception.
*/
private String location = null;
// ------------------------------------------------------------- Properties
/**
* @return the error code.
*/
public int getErrorCode() {
return this.errorCode;
}
/**
* Set the error code.
*
* @param errorCode The new error code
*/
public void setErrorCode(int errorCode) {
this.errorCode = errorCode;
}
/**
* Set the error code (hack for default XmlMapper data type).
*
* @param errorCode The new error code
*/
public void setErrorCode(String errorCode) {
try {
this.errorCode = Integer.parseInt(errorCode);
} catch (NumberFormatException nfe) {
throw new IllegalArgumentException(nfe);
}
}
/**
* @return the exception type.
*/
public String getExceptionType() {
return this.exceptionType;
}
/**
* Set the exception type.
*
* @param exceptionType The new exception type
*/
public void setExceptionType(String exceptionType) {
this.exceptionType = exceptionType;
}
/**
* @return the location.
*/
public String getLocation() {
return this.location;
}
/**
* Set the location.
*
* @param location The new location
*/
public void setLocation(String location) {
this.location = UDecoder.URLDecode(location, getCharset());
}
// --------------------------------------------------------- Public Methods
/**
* Render a String representation of this object.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder("ErrorPage[");
if (exceptionType == null) {
sb.append("errorCode=");
sb.append(errorCode);
} else {
sb.append("exceptionType=");
sb.append(exceptionType);
}
sb.append(", location=");
sb.append(location);
sb.append(']');
return sb.toString();
}
public String getName() {
return Objects.requireNonNullElseGet(exceptionType, () -> Integer.toString(errorCode));
}
}
|