01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * 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.acegisecurity.ui.logout;
17:
18: import org.acegisecurity.Authentication;
19:
20: import javax.servlet.http.HttpServletRequest;
21: import javax.servlet.http.HttpServletResponse;
22:
23: /**
24: * Indicates a class that is able to participate in logout handling.
25: *
26: * <p>
27: * Called by {@link LogoutFilter}.
28: *
29: * @author Ben Alex
30: * @version $Id: LogoutHandler.java 1784 2007-02-24 21:00:24Z luke_t $
31: */
32: public interface LogoutHandler {
33: //~ Methods ========================================================================================================
34:
35: /**
36: * Causes a logout to be completed. The method must complete successfully.
37: *
38: * @param request the HTTP request
39: * @param response the HTTP resonse
40: * @param authentication the current principal details
41: */
42: void logout(HttpServletRequest request,
43: HttpServletResponse response, Authentication authentication);
44: }
|