*Back to [[Book|Administrator's Configuration File Reference#cfr]] [[Topic|Administrator's Configuration File Reference#chap7]]*
h2. {{Error}} {anchor:err}
If a SAF results in an error, the server stops executing all other directives and immediately starts executing the {{Error}} directives. For more information, see [{{Error}}|Flow of Control in obj.conf#error].
The following {{Error}}-class functions are described in detail in this section:
* [#{{error-j2ee}}]
* [#{{qos-error}}]
In addition, the following common SAFs are valid for the {{Error}} directive:
* [{{match-browser}}|Common SAFs across Multiple Directives#saf2]
* [{{query-handler}}|Common SAFs across Multiple Directives#saf3]
* [{{redirect}}|Common SAFs across Multiple Directives#saf4]
* [{{remove-filter}}|Common SAFs across Multiple Directives#saf5]
* [{{restart}}|Common SAFs across Multiple Directives#saf6]
* [{{send-error}}|Common SAFs across Multiple Directives#saf7]
* [{{set-variable}}|Common SAFs across Multiple Directives#saf8]
h3. {{error-j2ee}} {anchor:err1}
The {{error-j2ee}} function handles errors that occur during execution of web applications deployed to the Web Server individually or as part of full Java EE applications.
h4. Parameters
The following table describes the parameter for the {{error-j2ee}} function.
Table 7-107 {{error-j2ee}} Parameter
||Parameter ||Description ||
|{{bucket}} |(Optional) Common to all {{obj.conf}} functions. Adds a bucket to monitor performance. For more information, see [The {{bucket}} Parameter|The bucket Parameter]. |
h4. See Also
* [{{find-index-j2ee}}|PathCheck#path6]
* [{{ntrans-j2ee}}|NameTrans#name6]
* [{{service-j2ee}}|Service#serv21]
* [{{type-j2ee}}|ObjectType#obj37]
h3. {{qos-error}} {anchor:err2}
The {{qos-error}} function returns an error page stating the quality of service that caused the error, and the value of the QOS statistic.
h4. Parameters
The following table describes parameters for the {{qos-error}} function.
Table 7-108 {{qos-error}} Parameters
||Parameter ||Description ||
|{{code}} |(Optional) Three-digit number representing the HTTP response status code, such as {{401}} or {{407}}. The recommended value is {{503}}.This can be any HTTP response status code or reason phrase according to the HTTP specification. A list of common HTTP response status codes and reason strings is as follows:
* {{401 Unauthorized}}
* {{403 Forbidden}}
* {{404 Not Found}}
* {{500 Server Error}} |
|{{bucket}} |(Optional) Common to all {{obj.conf}} functions. Adds a bucket to monitor performance. For more information, see [The {{bucket}} Parameter|The bucket Parameter#b1]. |
h4. Example
{code}
Error fn="qos-error" code="503"
{code}
h4. See Also
[{{qos-handler}}|AuthTrans#auth4]
h2. {{Error}} {anchor:err}
If a SAF results in an error, the server stops executing all other directives and immediately starts executing the {{Error}} directives. For more information, see [{{Error}}|Flow of Control in obj.conf#error].
The following {{Error}}-class functions are described in detail in this section:
* [#{{error-j2ee}}]
* [#{{qos-error}}]
In addition, the following common SAFs are valid for the {{Error}} directive:
* [{{match-browser}}|Common SAFs across Multiple Directives#saf2]
* [{{query-handler}}|Common SAFs across Multiple Directives#saf3]
* [{{redirect}}|Common SAFs across Multiple Directives#saf4]
* [{{remove-filter}}|Common SAFs across Multiple Directives#saf5]
* [{{restart}}|Common SAFs across Multiple Directives#saf6]
* [{{send-error}}|Common SAFs across Multiple Directives#saf7]
* [{{set-variable}}|Common SAFs across Multiple Directives#saf8]
h3. {{error-j2ee}} {anchor:err1}
The {{error-j2ee}} function handles errors that occur during execution of web applications deployed to the Web Server individually or as part of full Java EE applications.
h4. Parameters
The following table describes the parameter for the {{error-j2ee}} function.
Table 7-107 {{error-j2ee}} Parameter
||Parameter ||Description ||
|{{bucket}} |(Optional) Common to all {{obj.conf}} functions. Adds a bucket to monitor performance. For more information, see [The {{bucket}} Parameter|The bucket Parameter]. |
h4. See Also
* [{{find-index-j2ee}}|PathCheck#path6]
* [{{ntrans-j2ee}}|NameTrans#name6]
* [{{service-j2ee}}|Service#serv21]
* [{{type-j2ee}}|ObjectType#obj37]
h3. {{qos-error}} {anchor:err2}
The {{qos-error}} function returns an error page stating the quality of service that caused the error, and the value of the QOS statistic.
h4. Parameters
The following table describes parameters for the {{qos-error}} function.
Table 7-108 {{qos-error}} Parameters
||Parameter ||Description ||
|{{code}} |(Optional) Three-digit number representing the HTTP response status code, such as {{401}} or {{407}}. The recommended value is {{503}}.This can be any HTTP response status code or reason phrase according to the HTTP specification. A list of common HTTP response status codes and reason strings is as follows:
* {{401 Unauthorized}}
* {{403 Forbidden}}
* {{404 Not Found}}
* {{500 Server Error}} |
|{{bucket}} |(Optional) Common to all {{obj.conf}} functions. Adds a bucket to monitor performance. For more information, see [The {{bucket}} Parameter|The bucket Parameter#b1]. |
h4. Example
{code}
Error fn="qos-error" code="503"
{code}
h4. See Also
[{{qos-handler}}|AuthTrans#auth4]