001/*
002 *  Copyright 2018 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.cache;
017
018import java.util.Collections;
019import java.util.List;
020
021import org.apache.avalon.framework.service.ServiceException;
022import org.apache.avalon.framework.service.ServiceManager;
023
024import org.ametys.core.ObservationConstants;
025import org.ametys.core.observation.Event;
026import org.ametys.core.observation.ObservationManager;
027import org.ametys.core.ui.Callable;
028import org.ametys.core.ui.StaticClientSideElement;
029
030/**
031 * Client side element for the cache buttons
032 */
033public class CacheClientSideElement extends StaticClientSideElement
034{
035    private AbstractCacheManager _cacheManager;
036    private org.apache.cocoon.caching.Cache _cocoonCache;
037    private ObservationManager _observationManager;
038
039    @Override
040    public void service(ServiceManager smanager) throws ServiceException
041    {
042        super.service(smanager);
043        _cacheManager = (AbstractCacheManager) smanager.lookup(AbstractCacheManager.ROLE);
044        _cocoonCache = (org.apache.cocoon.caching.Cache) smanager.lookup(org.apache.cocoon.caching.Cache.ROLE);
045        if (smanager.hasService(ObservationManager.ROLE))
046        {
047            _observationManager = (ObservationManager) smanager.lookup(ObservationManager.ROLE);
048        }
049    }
050
051    /**
052     * clear the cache related to given id
053     * @param ids the list of all caches ids
054     */
055    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
056    public void clearCaches(List<String> ids)
057    {
058        List<String> cleanedCaches = _cacheManager.resetCaches(ids);
059        for (String cacheId : cleanedCaches)
060        {
061            if (_observationManager != null)
062            {
063                _observationManager.notify(new Event(ObservationConstants.EVENT_CACHE_RESET, 
064                        _currentUserProvider.getUser(), 
065                        Collections.singletonMap(ObservationConstants.ARGS_CACHE_ID, cacheId)));
066            }
067        }
068    }
069
070    /**
071     * clear all the memory caches
072     * @return the list of all cleaned caches
073     */
074    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
075    public List<String> clearAllCaches()
076    {
077        List<String> cleanedCaches = _cacheManager.resetAllMemoryCaches();
078        for (String cacheId : cleanedCaches)
079        {
080            if (_observationManager != null)
081            {
082                _observationManager.notify(new Event(ObservationConstants.EVENT_CACHE_RESET, 
083                        _currentUserProvider.getUser(), 
084                        Collections.singletonMap(ObservationConstants.ARGS_CACHE_ID, cacheId)));
085            }
086        }
087        return cleanedCaches;
088    }
089
090    /**
091     * Empty the cocoon cache
092     */
093    @Callable(rights = "Runtime_Rights_Admin_Access", context = "/admin")
094    public void emptyCocoonCache()
095    {
096        _cocoonCache.clear();
097    }    
098}