/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-2015 The eXist Project
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.scheduler;

import java.util.Map;
import org.exist.storage.BrokerPool;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

/**
 * Class to represent a User's Java Job.
 *
 * <p>Should be extended by all classes wishing to schedule as a Job that perform user defined functionality</p>
 *
 * @author  Adam Retter <adam.retter@devon.gov.uk>
 */
public abstract class UserJavaJob extends UserJob {
    /**
     * The execute method as called by the Quartz Scheduler.
     *
     * @param   jec  The execution context of the executing job
     *
     * @throws  JobExecutionException  if there was a problem with the job, this also describes to Quartz how to cleanup the job
     */
    @Override
    public final void execute(final JobExecutionContext jec) throws JobExecutionException {
        final JobDataMap jobDataMap = jec.getJobDetail().getJobDataMap();

        //get the brokerpool from the data map
        final BrokerPool pool = (BrokerPool)jobDataMap.get(DATABASE);

        //get any parameters from the data map
        final Map params = (Map)jobDataMap.get(PARAMS);

        try {
            //execute the job
            execute(pool, params);
        } catch(final JobException je ) {
            //cleanup the job
            je.cleanupJob();
        }
    }

    /**
     * Function that is executed by the Scheduler.
     *
     * @param   brokerpool  The BrokerPool for the Scheduler of this job
     * @param   params      Any parameters passed to the job or null otherwise
     *
     * @throws  JobException  if there is a problem with the job. cleanupJob() should then be called, which will adjust the jobs scheduling
     *                        appropriately
     */
    public abstract void execute(BrokerPool brokerpool, Map<String, ?> params) throws JobException;
}