001/*
002 *  Copyright 2012 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.user;
017
018import org.apache.cocoon.ProcessingException;
019import org.apache.cocoon.environment.Redirector;
020
021/**
022 * Component which:
023 * <ul>
024 *  <li>provides the {@link UserIdentity identity} of the current user.
025 *  <li>can logout the the current user.
026 * </ul>
027 */
028public interface CurrentUserProvider
029{
030    /** Avalon role. */
031    public static final String ROLE = CurrentUserProvider.class.getName();
032
033    /**
034     * Provides the current logged user.
035     * @return the current user or <code>null</code> if there is no logged user.
036     */
037    UserIdentity getUser();
038    
039    /**
040     * Logout the current user if he can be.
041     * @param redirector the redirector to use if a redirection needs to be perform for the logout. can be null when called during admin operation
042     * @throws ProcessingException If an error occurred during the logout process
043     */
044    void logout(Redirector redirector) throws ProcessingException;
045}