org.seedstack.scheduler.Scheduled Maven / Gradle / Ivy
/*
* Copyright © 2013-2018, The SeedStack authors
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package org.seedstack.scheduler;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* {@code Scheduled} annotates {@link Task} to specified scheduling information.
*
*
* {@literal @}Scheduled("0/2 * * * * ?")
* public class MyTask implements Task<Integer> {
* ...
* }
*
*/
@Inherited
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Scheduled {
String DEFAULT = "DEFAULT";
// Task
/**
* The {@code Task} name, must be unique within the group.
*
* @return {@code Task} name
*/
String taskName() default DEFAULT;
/**
* @return Define whether or not the {@code Task} should be re-executed upon execution failure.
*/
boolean requestRecovery() default false;
/**
* @return whether or not the {@code Task} should remain stored after it is orphaned (no trigger points to it).
*/
boolean storeDurably() default false;
// Trigger
/**
* Defines the behavior when exception occurs during the task exception.
*
* @return {@code ExceptionPolicy}
*/
ExceptionPolicy exceptionPolicy() default ExceptionPolicy.NONE;
/**
* @return the Trigger name, must be unique within the group.
*/
String triggerName() default DEFAULT;
/**
* @return the cron expression to base the schedule on.
*/
String value() default "";
/**
* @return the time zone for which the cron expression of this trigger will be resolved.
*/
String timeZoneId() default DEFAULT;
/**
* @return the trigger's priority. When more than one trigger have the same fire time, the scheduler will fire
* the one with the highest priority first.
*/
int priority() default 0;
}