AbstractBaseJob.java

/**
 * Copyright (c) 2010-2017 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.eclipse.smarthome.binding.astro.internal.job;

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Baseclass for all jobs with common methods.
 *
 * @author Gerhard Riegler - Initial contribution
 */
public abstract class AbstractBaseJob implements Job {
    private final Logger logger = LoggerFactory.getLogger(AbstractBaseJob.class);
    public static final String KEY_THING_UID = "thingUid";
    public static final String KEY_CHANNEL_ID = "channelId";
    public static final String KEY_JOB_NAME = "jobName";
    public static final String KEY_PHASE_NAME = "phaseName";

    @Override
    public void execute(JobExecutionContext jobContext) throws JobExecutionException {
        JobDataMap jobDataMap = jobContext.getJobDetail().getJobDataMap();

        String thingUid = jobDataMap.getString(KEY_THING_UID);
        String jobName = jobDataMap.getString(KEY_JOB_NAME);
        if (logger.isDebugEnabled()) {
            logger.debug("Starting astro {} for thing {}", jobName, thingUid);
        }

        executeJob(thingUid, jobDataMap);
    }

    /**
     * Method to override by the different jobs to be executed.
     */
    protected abstract void executeJob(String thingUid, JobDataMap jobDataMap);

}