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