001/* 002 * (C) Copyright 2006-2008 Nuxeo SAS (http://nuxeo.com/) and contributors. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * Contributors: 015 * arussel 016 */ 017package org.nuxeo.ecm.platform.web.common.exceptionhandling.service; 018 019import java.io.IOException; 020 021import javax.servlet.ServletException; 022import javax.servlet.http.HttpServletRequest; 023import javax.servlet.http.HttpServletResponse; 024 025/** 026 * Listener performing operations when dealing with an error. Order of methods called: 027 * <ul> 028 * <li>1. startHandling</li> 029 * <li>2. beforeSetErrorPageAttribute</li> 030 * <li>3. beforeForwardToErrorPage</li> 031 * <li>4. afterDispatch</li> 032 * </ul> 033 * 034 * @author arussel 035 */ 036public interface ExceptionHandlingListener { 037 038 /** 039 * Error has happened, things to do before error is dealt with. 040 */ 041 void startHandling(Throwable t, HttpServletRequest request, HttpServletResponse response) throws IOException, 042 ServletException; 043 044 void beforeSetErrorPageAttribute(Throwable t, HttpServletRequest request, HttpServletResponse response) 045 throws IOException, ServletException; 046 047 void beforeForwardToErrorPage(Throwable t, HttpServletRequest request, HttpServletResponse response) 048 throws IOException, ServletException; 049 050 void afterDispatch(Throwable t, HttpServletRequest request, HttpServletResponse response) throws IOException, 051 ServletException; 052}