CustomErrorPagePolicy

CustomErrorPagePolicy

This type is a class for model objects.

* No description is available *
Package: proxy

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  ProxySettings.errorPagePolicy
  ProxyVirtualHostSettings.customErrorPagePolicy

Attributes Summary

errorPageAppURI : EString The URI for the custom error page generation application. The proxy will use this application to generate the custom error pages. The application should be a servlet, jsp, html or some web element that is installed and deployed in a content server (group) accessible to the proxy server from the routing rules. There should be a associated proxy or local route action associated with this rule. If not present, the proxy will send the error responses with the status code (and no response body) to the client.

forwardHeaders : EString A list of headers from the original request (if present) to be forwarded to the Error page application as query parameters. The header names are used as the names of the query parameters

statusCodes : EString The list of status codes in a response that should first be directed to the Application URI specified in the policy. For instance the list : 303,403,404,5XX would cause the proxy server to route any responses with 303, 403, 404, and ALL of the status codes in the 500's.

handleRemoteErrors : EBoolean This parameter (if enabled) specifies if the proxy server should route error responses from remote servers to the error page generator application. If disabled the proxy server will only route locally generated error response to the application.

handleLocalErrors : EBoolean @since 7.0.0 Enables the proxy server to serve custom error pages for error codes generated by the proxy server during request or response processing.

Attribute Details

errorPageAppURI  -  The URI for the custom error page generation application. The proxy will use this application to generate the custom error pages. The application should be a servlet, jsp, html or some web element that is installed and deployed in a content server (group) accessible to the proxy server from the routing rules. There should be a associated proxy or local route action associated with this rule. If not present, the proxy will send the error responses with the status code (and no response body) to the client.
    Data Type: EString
    Default value:
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

forwardHeaders  -  A list of headers from the original request (if present) to be forwarded to the Error page application as query parameters. The header names are used as the names of the query parameters
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

statusCodes  -  The list of status codes in a response that should first be directed to the Application URI specified in the policy. For instance the list : 303,403,404,5XX would cause the proxy server to route any responses with 303, 403, 404, and ALL of the status codes in the 500's.
    Data Type: EString
    Default value:  5XX
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

handleRemoteErrors  -  This parameter (if enabled) specifies if the proxy server should route error responses from remote servers to the error page generator application. If disabled the proxy server will only route locally generated error response to the application.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

handleLocalErrors  -  @since 7.0.0 Enables the proxy server to serve custom error pages for error codes generated by the proxy server during request or response processing.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
errorPageAppURI : EString	The URI for the custom error page generation application. The proxy will use this application to generate the custom error pages. The application should be a servlet, jsp, html or some web element that is installed and deployed in a content server (group) accessible to the proxy server from the routing rules. There should be a associated proxy or local route action associated with this rule. If not present, the proxy will send the error responses with the status code (and no response body) to the client.
forwardHeaders : EString	A list of headers from the original request (if present) to be forwarded to the Error page application as query parameters. The header names are used as the names of the query parameters
statusCodes : EString	The list of status codes in a response that should first be directed to the Application URI specified in the policy. For instance the list : 303,403,404,5XX would cause the proxy server to route any responses with 303, 403, 404, and ALL of the status codes in the 500's.
handleRemoteErrors : EBoolean	This parameter (if enabled) specifies if the proxy server should route error responses from remote servers to the error page generator application. If disabled the proxy server will only route locally generated error response to the application.
handleLocalErrors : EBoolean	@since 7.0.0 Enables the proxy server to serve custom error pages for error codes generated by the proxy server during request or response processing.