001/*
002 * (C) Copyright 2006-2007 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 *     Nuxeo - initial API and implementation
018 */
019
020package org.nuxeo.ecm.platform.ui.web.auth.interfaces;
021
022import javax.servlet.http.HttpServletRequest;
023import javax.servlet.http.HttpServletResponse;
024
025public interface NuxeoAuthenticationPluginLogoutExtension {
026
027    /**
028     * Handles logout operation.
029     * <p>
030     * Generic logout (killing session and Seam objects) is done by LogoutActionBean This interface must be implemented
031     * by auth plugin when the target auth system needs a specific logout procedure.
032     *
033     * @return true if caller must stop execution (ie: logout generated a redirect), false otherwise
034     */
035    Boolean handleLogout(HttpServletRequest httpRequest, HttpServletResponse httpResponse);
036
037}