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.util.cocoon;
017
018import org.apache.avalon.framework.service.ServiceException;
019import org.apache.avalon.framework.service.ServiceManager;
020import org.apache.cocoon.generation.ServiceableGenerator;
021
022import org.ametys.core.user.CurrentUserProvider;
023import org.ametys.core.user.UserIdentity;
024
025/**
026 * {@link ServiceableGenerator} which provides the current user if necessary.
027 */
028public abstract class AbstractCurrentUserProviderServiceableGenerator extends ServiceableGenerator
029{
030    /** The current user provider. */
031    protected CurrentUserProvider _currentUserProvider;
032    
033    @Override
034    public void service(ServiceManager serviceManager) throws ServiceException
035    {
036        super.service(serviceManager);
037        _currentUserProvider = (CurrentUserProvider) serviceManager.lookup(CurrentUserProvider.ROLE);
038    }
039    
040    /**
041     * Provides the the current user.
042     * @return the user which cannot be <code>null</code>.
043     */
044    protected UserIdentity _getCurrentUser()
045    {
046        return _currentUserProvider.getUser();
047    }
048}