com.jensfendler.ninjaquartz.job.NinjaQuartzTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ninja-quartz Show documentation

Quartz Scheduler Integration for the Ninja Web Framework

There is a newer version: 0.0.7

/*
 * Copyright 2016 Fendler Consulting cc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.jensfendler.ninjaquartz.job;

import java.lang.reflect.InvocationTargetException;

import org.quartz.JobExecutionContext;

import com.jensfendler.ninjaquartz.annotations.QuartzSchedule;

/**
 * A {@link NinjaQuartzTask} wraps the invocation of a scheduled method (i.e. a
 * method annotated with {@link QuartzSchedule}).
 * 
 * @author Jens Fendler
 *
 */
public interface NinjaQuartzTask {

    /**
     * Execute a scheduled method.
     * 
     * @param context
     *            the Quartz job's execution context (passed to the scheduled
     *            method if it provides a single {@link JobExecutionContext}
     *            parameter)
     * @throws IllegalAccessException
     *             if the scheduled method cannot be called due to access
     *             restrictions
     * @throws IllegalArgumentException
     *             if the scheduled method cannot be called due to invalid
     *             arguments (i.e. anything other than either no arguments, or a
     *             single {@link JobExecutionContext} argument)
     * @throws InvocationTargetException
     *             if the scheduled method could not be invoked.
     */
    public void execute(JobExecutionContext context)
            throws IllegalAccessException, IllegalArgumentException, InvocationTargetException;

    /**
     * Get the name of the task.
     * 
     * @return the name of the wrapped task
     */
    public String getTaskName();

}