001/*
002 *  Copyright 2016 Anyware Services
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 */
016package org.ametys.core.authentication;
017
018import org.apache.cocoon.ProcessingException;
019import org.apache.cocoon.environment.Redirector;
020
021/**
022 * Defines a logout capable authentication mode of users.
023 */
024public interface LogoutCapable
025{
026    /**
027     * Logout a particular user.
028     * @param redirector the redirector to use if a redirection needs to be perform for the logout. can be null when called during admin operation
029     * @throws ProcessingException If an error occurred
030     */
031    public void logout(Redirector redirector) throws ProcessingException;
032}