001/*
002 *  Copyright 2021 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 org.apache.avalon.framework.service.ServiceException;
019import org.apache.avalon.framework.service.ServiceManager;
020import org.apache.commons.lang3.StringUtils;
021import org.quartz.JobDataMap;
022import org.quartz.JobExecutionContext;
023import org.quartz.JobExecutionException;
024
025import org.ametys.core.schedule.Schedulable;
026import org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable;
027import org.ametys.plugins.core.schedule.Scheduler;
028
029/**
030 * A {@link Schedulable} job to clean a cache.
031 */
032public class CleanCacheSchedulable extends AbstractStaticSchedulable
033{
034    /** The key for the source catalog */
035    public static final String JOBDATAMAP_CACHE_ID = "cacheId";
036    
037    /** The cache manager */
038    protected AbstractCacheManager _cacheManager;
039    
040    @Override
041    public void service(ServiceManager manager) throws ServiceException
042    {
043        _cacheManager = (AbstractCacheManager) manager.lookup(AbstractCacheManager.ROLE);
044        super.service(manager);
045    }
046    
047    @Override
048    public void execute(JobExecutionContext context) throws Exception
049    {
050        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
051        
052        String cacheId = jobDataMap.getString(Scheduler.PARAM_VALUES_PREFIX + JOBDATAMAP_CACHE_ID);
053        if (StringUtils.isEmpty(cacheId))
054        {
055            throw new JobExecutionException("The cache ID to remove cannot be empty.");
056        }
057        
058        try
059        {
060            _cacheManager.get(cacheId).resetCache();
061        }
062        catch (CacheException e)
063        {
064            getLogger().warn("An error occured on the cache identified by '{}'", cacheId, e);
065        }
066    }
067}