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.plugins.contentio.synchronize;
017
018import org.apache.avalon.framework.service.ServiceException;
019import org.apache.avalon.framework.service.ServiceManager;
020import org.quartz.JobDataMap;
021import org.quartz.JobExecutionContext;
022
023import org.ametys.core.schedule.progression.ContainerProgressionTracker;
024import org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable;
025import org.ametys.plugins.core.schedule.Scheduler;
026
027/**
028 * Abstract schedulable for SCC.
029 */
030public abstract class AbstractCollectionSchedulable extends AbstractStaticSchedulable
031{
032    /** The key for the collection to synchronize */
033    public static final String JOBDATAMAP_COLLECTION_KEY = "collectionId";
034    
035    private SynchronizableContentsCollectionDAO _synchronizableContentsCollectionDAO;
036    
037    @Override
038    public void service(ServiceManager manager) throws ServiceException
039    {
040        super.service(manager);
041        _synchronizableContentsCollectionDAO = (SynchronizableContentsCollectionDAO) manager.lookup(SynchronizableContentsCollectionDAO.ROLE);
042    }
043    
044    @Override
045    public void execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker) throws Exception
046    {
047        JobDataMap jobDataMap = context.getJobDetail().getJobDataMap();
048        String collectionId = (String) jobDataMap.get(Scheduler.PARAM_VALUES_PREFIX + JOBDATAMAP_COLLECTION_KEY);
049        
050        SynchronizableContentsCollection collection = _synchronizableContentsCollectionDAO.getSynchronizableContentsCollection(collectionId);
051        _process(collection, progressionTracker);
052    }
053    
054    /**
055     * Process on the given collection.
056     * @param collection The SCC
057     * @param progressionTracker A progression tracker
058     * @throws Exception if an exception occurs
059     */
060    protected abstract void _process(SynchronizableContentsCollection collection, ContainerProgressionTracker progressionTracker) throws Exception;
061}