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;
019
020/**
021 * Component which:
022 * <ul>
023 *  <li>provides the {@link UserIdentity identity} of the current user.
024 *  <li>can logout the the current user.
025 * </ul>
026 */
027public interface CurrentUserProvider
028{
029    /** Avalon role. */
030    public static final String ROLE = CurrentUserProvider.class.getName();
031
032    /**
033     * Provides the current logged user.
034     * @return the current user or <code>null</code> if there is no logged user.
035     */
036    UserIdentity getUser();
037    
038    /**
039     * Logout the current user if he can be.
040     * @throws ProcessingException If an error occurred during the logout process
041     */
042    void logout() throws ProcessingException;
043}