| java.lang.Object
 com.opensymphony.xwork.interceptor.ExceptionMappingInterceptor
| ExceptionMappingInterceptor | | public class ExceptionMappingInterceptor implements Interceptor(Code) | |
This interceptor forms the core functionality of the exception handling feature. Exception handling allows you to map
an exception to a result code, just as if the action returned a result code instead of throwing an unexpected
exception. When an exception is encountered, it is wrapped with an
ExceptionHolder and pushed on the stack,
providing easy access to the exception from within your result.
Note: While you can configure exception mapping in your configuration file at any point, the configuration
will not have any effect if this interceptor is not in the interceptor stack for your actions. It is recommended that
you make this interceptor the first interceptor on the stack, ensuring that it has full access to catch any
exception, even those caused by other interceptors.
Interceptor parameters:
- logEnabled (optional) - Should exceptions also be logged? (boolean true|false)
- logLevel (optional) - what log level should we use (
trace, debug, info, warn, error, fatal)? - defaut is debug
- logCategory (optional) - If provided we would use this category (eg.
com.mycompany.app).
Default is to use com.opensymphony.xwork.interceptor.ExceptionMappingInterceptor.
The parameters above enables us to log all thrown exceptions with stacktace in our own logfile,
and present a friendly webpage (with no stacktrace) to the end user.
Extending the interceptor:
If you want to add custom handling for publishing the Exception, you may override
ExceptionMappingInterceptor.publishException(com.opensymphony.xwork.ActionInvocation,ExceptionHolder) . The default implementation
pushes the given ExceptionHolder on value stack. A custom implementation could add additional logging etc.
Example code:
<xwork>
<include file="webwork-default.xml"/>
<package name="default" extends="webwork-default">
<global-results>
<result name="error" type="freemarker">error.ftl</result>
</global-results>
<global-exception-mappings>
<exception-mapping exception="java.lang.Exception" result="error"/>
</global-exception-mappings>
<action name="test">
<interceptor-ref name="exception"/>
<interceptor-ref name="basicStack"/>
<exception-mapping exception="com.acme.CustomException" result="custom_error"/>
<result name="custom_error">custom_error.ftl</result>
<result name="success" type="freemarker">test.ftl</result>
</action>
</package>
</xwork>
This second example will also log the exceptions using our own category
com.mycompany.app.unhandled at WARN level.
<xwork>
<include file="webwork-default.xml"/>
<package name="something" extends="webwork-default">
<interceptors>
<interceptor-stack name="exceptionmapping-stack">
<interceptor-ref name="exception">
<param name="logEnabled">true</param>
<param name="logCategory">com.mycompany.app.unhandled</param>
<param name="logLevel">WARN</param>
</interceptor-ref>
<interceptor-ref name="i18n"/>
<interceptor-ref name="static-params"/>
<interceptor-ref name="params"/>
<interceptor-ref name="validation">
<param name="excludeMethods">input,back,cancel,browse</param>
</interceptor-ref>
</interceptor-stack>
</interceptors>
<default-interceptor-ref name="exceptionmapping-stack"/>
<global-results>
<result name="unhandledException">/unhandled-exception.jsp</result>
</global-results>
<global-exception-mappings>
<exception-mapping exception="java.lang.Exception" result="unhandledException"/>
</global-exception-mappings>
<action name="exceptionDemo" class="com.opensymphony.webwork.showcase.exceptionmapping.ExceptionMappingAction">
<exception-mapping exception="com.opensymphony.webwork.showcase.exceptionmapping.ExceptionMappingException"
result="damm"/>
<result name="input">index.jsp</result>
<result name="success">success.jsp</result>
<result name="damm">damm.jsp</result>
</action>
</package>
</xwork>
author:
Matthew E. Porter (matthew dot porter at metissian dot com)
author:
Claus Ibsen |
| categoryLogger | | protected Log categoryLogger(Code) | | |
| log | | final protected static Log log(Code) | | |
| logEnabled | | protected boolean logEnabled(Code) | | |
| destroy | | public void destroy()(Code) | | |
| doLog | | protected void doLog(Log logger, Exception e)(Code) | | Performs the actual logging.
Parameters:
logger - the provided logger to use.
Parameters:
e - the exception to log. |
| getDepth | | public int getDepth(String exceptionMapping, Throwable t)(Code) | | Return the depth to the superclass matching. 0 means ex matches exactly. Returns -1 if there's no match.
Otherwise, returns depth. Lowest depth wins.
Parameters:
exceptionMapping - the mapping classname
Parameters:
t - the cause the depth, if not found -1 is returned. |
| handleLogging | | protected void handleLogging(Exception e)(Code) | | Handles the logging of the exception.
Parameters:
e - the exception to log. |
| isLogEnabled | | public boolean isLogEnabled()(Code) | | |
| publishException | | protected void publishException(ActionInvocation invocation, ExceptionHolder exceptionHolder)(Code) | | Default implementation to handle ExceptionHolder publishing. Pushes given ExceptionHolder on the stack.
Subclasses may override this to customize publishing.
Parameters:
invocation - The invocation to publish Exception for.
Parameters:
exceptionHolder - The exceptionHolder wrapping the Exception to publish. |
| setLogCategory | | public void setLogCategory(String logCatgory)(Code) | | |
| setLogEnabled | | public void setLogEnabled(boolean logEnabled)(Code) | | |
|
|