Apache Struts API Documentation: Class ExceptionHandler

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.action Class ExceptionHandler

java.lang.Object
  |
  +--org.apache.struts.action.ExceptionHandler

public class ExceptionHandler
extends java.lang.Object

An ExceptionHandler is configured in the Struts configuration file to handle a specific type of exception thrown by an Action.execute method.

Since:: Struts 1.1

Field Summary
`private static org.apache.commons.logging.Log`	`log` Commons logging instance.
`private static MessageResources`	`messages` The message resources for this package.

Constructor Summary
`ExceptionHandler()`

Method Summary
`ActionForward`	`execute(java.lang.Exception ex, ExceptionConfig ae, ActionMapping mapping, ActionForm formInstance, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Handle the `Exception`.
`protected void`	`logException(java.lang.Exception e)` Logs the `Exception` using commons-logging.
`protected void`	`storeException(javax.servlet.http.HttpServletRequest request, java.lang.String property, ActionError error, ActionForward forward, java.lang.String scope)` Deprecated. Use storeException(HttpServletRequest, String, ActionMessage, ActionForward, String) instead. This will be removed after Struts 1.2.
`protected void`	`storeException(javax.servlet.http.HttpServletRequest request, java.lang.String property, ActionMessage error, ActionForward forward, java.lang.String scope)` Default implementation for handling an `ActionMessage` generated from an `Exception` during `Action` delegation.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

log

private static final org.apache.commons.logging.Log log

Commons logging instance.

messages

private static MessageResources messages

The message resources for this package.

Constructor Detail

ExceptionHandler

public ExceptionHandler()

Method Detail

execute

public ActionForward execute(java.lang.Exception ex,
                             ExceptionConfig ae,
                             ActionMapping mapping,
                             ActionForm formInstance,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws javax.servlet.ServletException

Handle the Exception. Return the ActionForward instance (if any) returned by the called ExceptionHandler.

Parameters:: ex - The exception to handle; ae - The ExceptionConfig corresponding to the exception; mapping - The ActionMapping we are processing; formInstance - The ActionForm we are processing; request - The servlet request we are processing; response - The servlet response we are creating
Throws:: javax.servlet.ServletException - if a servlet exception occurs
Since:: Struts 1.1

logException

protected void logException(java.lang.Exception e)

Logs the Exception using commons-logging.

Parameters:: e - The Exception to log.
Since:: Struts 1.2

storeException

protected void storeException(javax.servlet.http.HttpServletRequest request,
                              java.lang.String property,
                              ActionError error,
                              ActionForward forward,
                              java.lang.String scope)

Deprecated. Use storeException(HttpServletRequest, String, ActionMessage, ActionForward, String) instead. This will be removed after Struts 1.2.

Default implementation for handling an ActionError generated from an Exception during Action delegation. The default implementation is to set an attribute of the request or session, as defined by the scope provided (the scope from the exception mapping). An ActionErrors instance is created, the error is added to the collection and the collection is set under the Globals.ERROR_KEY.

Parameters:: request - The request we are handling; property - The property name to use for this error; error - The error generated from the exception mapping; forward - The forward generated from the input path (from the form or exception mapping); scope - The scope of the exception mapping.