001/* 002 * (C) Copyright 2006-2008 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * arussel 018 */ 019package org.nuxeo.ecm.platform.web.common.exceptionhandling.service; 020 021import java.io.IOException; 022 023import javax.servlet.ServletException; 024import javax.servlet.http.HttpServletRequest; 025import javax.servlet.http.HttpServletResponse; 026 027/** 028 * Listener performing operations when dealing with an error. Order of methods called: 029 * <ul> 030 * <li>1. startHandling</li> 031 * <li>2. beforeSetErrorPageAttribute</li> 032 * <li>3. beforeForwardToErrorPage</li> 033 * <li>4. afterDispatch</li> 034 * </ul> 035 * 036 * @author arussel 037 */ 038public interface ExceptionHandlingListener { 039 040 /** 041 * Error has happened, things to do before error is dealt with. 042 */ 043 void startHandling(Throwable t, HttpServletRequest request, HttpServletResponse response) throws IOException, 044 ServletException; 045 046 void beforeSetErrorPageAttribute(Throwable t, HttpServletRequest request, HttpServletResponse response) 047 throws IOException, ServletException; 048 049 void beforeForwardToErrorPage(Throwable t, HttpServletRequest request, HttpServletResponse response) 050 throws IOException, ServletException; 051 052 void afterDispatch(Throwable t, HttpServletRequest request, HttpServletResponse response) throws IOException, 053 ServletException; 054 055 void responseComplete(); 056 057}