1 /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.springframework.security.ui;
17
18 import org.springframework.security.AccessDeniedException;
19
20 import java.io.IOException;
21
22 import javax.servlet.ServletException;
23 import javax.servlet.ServletRequest;
24 import javax.servlet.ServletResponse;
25
26
27 /**
28 * Used by {@link ExceptionTranslationFilter} to handle an
29 * <code>AccessDeniedException</code>.
30 *
31 * @author Ben Alex
32 * @version $Id: AccessDeniedHandler.java 2142 2007-09-21 18:18:21Z luke_t $
33 */
34 public interface AccessDeniedHandler {
35 //~ Methods ========================================================================================================
36
37 /**
38 * Handles an access denied failure.
39 *
40 * @param request that resulted in an <code>AccessDeniedException</code>
41 * @param response so that the user agent can be advised of the failure
42 * @param accessDeniedException that caused the invocation
43 *
44 * @throws IOException in the event of an IOException
45 * @throws ServletException in the event of a ServletException
46 */
47 void handle(ServletRequest request, ServletResponse response, AccessDeniedException accessDeniedException)
48 throws IOException, ServletException;
49 }