Scheduled.java

/**
 * JBoss, Home of Professional Open Source
 * Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the
 * distribution for a full listing of individual contributors.
 *
 * 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 org.jboss.seam.scheduling.qualifier;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.inject.Qualifier;

/**
 * A binding annotation for use observing the Event.class event.
 * <p>
 * The value can either be a schedule in Cron format, or a 'named schedule', whereby
 * the cron-formatted schedule appears in the /scheduler.properties file on the classpath
 * as the value of the property with the given name.
 * <p>
 * Example scheduled event observer:
 * <code>public void doSomething(@Observes @Scheduled("0 * * ? * *") Event e) { ... }</code>
 * <p>
 * Example named, scheduled event observer:
 * <code>public void doSomething(@Observes @Scheduled("after.hours") Event e) { ... }</code>
 * <p>
 * Where the 'after.hours' schedule would be specified in /scheduler.properties like so:
 * <code>after.hours=0 0 * ? * *
 * <p>
 * Scheduled bindings may be made typesafe using the following pattern:
 * <code>
 * @Scheduled("after.hours")
 * @BindingType
 * @Retention(RetentionPolicy.RUNTIME)
 * public @interface AfterHours { .. }
 * </code>
 * The schedule can then be observed like so:
 * <code>public void doSomething(@Observes @AfterHours Event e) { ... }</code>
 *
 * @author Peter Royle
 * @author <a href="mailto:jordanorc@gmail.com>Jordano Celestrini</a>
 */
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
public @interface Scheduled {

    /*
     * The job name
     * @return the job name
     */
    String jobName() default "";

    /**
     * The job group
     * @return the job group
     */
    String jobGroup() default "";

    /**
     * Indicates if job automatically
     * @return true or false
     */
    boolean autoStart() default true;

    /**
     * <p>
     * Indicates the second to construct cron expression
     * </p>
     *
     * @return seconds
     */
    String second() default "0";

    /**
     * <p>
     * Indicates the minute to construct cron expression
     * </p>
     *
     * @return
     */
    String minute() default "0";

    /**
     * <p>
     * Indicates the hour to construct cron expression
     * </p>
     *
     * @return
     */
    String hour() default "0";

    /**
     * <p>
     * Indicates the day of month to construct cron expression
     * </p>
     * 
     * @return
     */
    String dayOfMonth() default "*";

    /**
     * <p>
     * Indicates the month to construct cron expression
     * </p>
     *
     * @return
     */
    String month() default "*";

    /**
     * <p>
     * Indicates the day of week to construct cron expression
     * </p>
     *
     * @return
     */
    String dayOfWeek() default "*";

    /**
     * <p>
     * Indicates the year to construct cron expression
     * </p>
     *
     * @return
     */
    String year() default "*";

    /**
     * <p>
     * The schedule specification (in cron format) or name.
     * </p>
     *
     * @return the value.
     */
    String expression() default "";
}