| /* |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
| * |
| * Copyright (c) 2006-2010 Oracle and/or its affiliates. All rights reserved. |
| * |
| * The contents of this file are subject to the terms of either the GNU |
| * General Public License Version 2 only ("GPL") or the Common Development |
| * and Distribution License("CDDL") (collectively, the "License"). You |
| * may not use this file except in compliance with the License. You can |
| * obtain a copy of the License at |
| * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html |
| * or packager/legal/LICENSE.txt. See the License for the specific |
| * language governing permissions and limitations under the License. |
| * |
| * When distributing the software, include this License Header Notice in each |
| * file and include the License file at packager/legal/LICENSE.txt. |
| * |
| * GPL Classpath Exception: |
| * Oracle designates this particular file as subject to the "Classpath" |
| * exception as provided by Oracle in the GPL Version 2 section of the License |
| * file that accompanied this code. |
| * |
| * Modifications: |
| * If applicable, add the following below the License Header, with the fields |
| * enclosed by brackets [] replaced by your own identifying information: |
| * "Portions Copyright [year] [name of copyright owner]" |
| * |
| * Contributor(s): |
| * If you wish your version of this file to be governed by only the CDDL or |
| * only the GPL Version 2, indicate your decision by adding "[Contributor] |
| * elects to include this software in this distribution under the [CDDL or GPL |
| * Version 2] license." If you don't indicate a single choice of license, a |
| * recipient has the option to distribute your version of this file under |
| * either the CDDL, the GPL Version 2 or to extend the choice of license to |
| * its licensees as provided above. However, if you add GPL Version 2 code |
| * and therefore, elected the GPL Version 2 license, then the option applies |
| * only if the new code is made subject to such option by the copyright |
| * holder. |
| */ |
| |
| package javax.ejb; |
| |
| import java.lang.annotation.Target; |
| import static java.lang.annotation.ElementType.*; |
| import java.lang.annotation.Retention; |
| import static java.lang.annotation.RetentionPolicy.*; |
| |
| /** |
| * Schedule a timer for automatic creation with a timeout schedule based |
| * on a cron-like time expression. The annotated method is |
| * used as the timeout callback method. |
| * <p> |
| * All elements of this annotation are optional. If none are specified |
| * a persistent timer will be created with callbacks occuring every day |
| * at midnight in the default time zone associated with the container in |
| * which the application is executing. |
| * <p> |
| * There are seven elements that constitute a schedule specification which are |
| * listed below. In addition, the <code>timezone</code> element may be used |
| * to specify a non-default time zone in whose context the schedule |
| * specification is to be evaluated; the <code>persistent</code> element |
| * may be used to specify a non-persistent timer, and the <code>info</code> |
| * element may be used to specify additional information that may be retrieved |
| * when the timer callback occurs. |
| * <p> |
| * The elements that specify the calendar-based schedule itself are as |
| * follows: |
| * <p> |
| * <ul> |
| * <li> second : one or more seconds within a minute |
| * <p> Allowable values: [0,59] |
| * <p> |
| * <li> minute : one or more minutes within an hour |
| * <p> Allowable values : [0,59] |
| * <p> |
| * <li> hour : one or more hours within a day |
| * <p> Allowable values : [0,23] |
| * <p> |
| * <li> dayOfMonth : one or more days within a month |
| * <p> Allowable values: |
| * <ul> |
| * <li> [1,31] |
| * <li> [-7, -1] |
| * <li> "Last" |
| * <li> {"1st", "2nd", "3rd", "4th", "5th", "Last"} {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"} |
| * </ul> |
| * <p> "Last" means the last day of the month |
| * <p> -x (where x is in the range [-7, -1]) means x day(s) before the last day of the month |
| * <p> "1st","2nd", etc. applied to a day of the week identifies a single occurrence of that day within the month. |
| * <p> |
| * <li> month : one or more months within a year |
| * <p> Allowable values : |
| * <p> |
| * <ul> |
| * <li> [1,12] |
| * <li> {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", Dec"} |
| * </ul> |
| * <p> |
| * <li> dayOfWeek : one or more days within a week |
| * <p> Allowable values : |
| * <p> |
| * <ul> |
| * <li> [0,7] |
| * <li> {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"} |
| * </ul> |
| * <p> "0" and "7" both refer to Sunday |
| * <p> |
| * <li> year : a particular calendar year |
| * <p> Allowable values : a four-digit calendar year |
| * |
| * <p> |
| * </ul> |
| * <p> |
| * |
| * Each element supports values expressed in one of the following forms |
| * <p> |
| * <ul> |
| * <li> Single Value. This constrains the attribute to only one of |
| * its possible values. |
| * <pre> |
| * Example: second = "10" |
| * Example: month = "Sep"</pre> |
| * <p> |
| * <li> Wild Card. "*" represents all allowable values for a given attribute. |
| * <pre> |
| * Example: second = "*" |
| * Example: dayOfWeek = "*"</pre> |
| * |
| * <li> List. This constrains the attribute to two or more allowable values |
| * or ranges, with a comma used as a separator character within the string. |
| * Each item in the list must be a single value or range. List items cannot |
| * be lists, wild cards, or increments. Duplicate values are ignored. |
| * <pre> |
| * Example: second = "10,20,30" |
| * Example: dayOfWeek = "Mon,Wed,Fri" |
| * Example: minute = "0-10,30,40"</pre> |
| * |
| * <li> Range. This constrains the attribute to an inclusive range of values, |
| * with a dash separating both ends of the range. Each side of the range |
| * must be a single attribute value. Members of a range cannot be lists, |
| * wild cards, ranges, or increments. If <code>x</code> is larger than |
| * <code>y</code> in a range <code>"x-y"</code>, the range is equivalent |
| * to <code>"x-max, min-y"</code>, where <code>max</code> is the largest |
| * value of the corresponding attribute and <code>min</code> is the smallest. |
| * The range <code>"x-x"</code>, where both range values are the same, |
| * evaluates to the single value <code>x</code>. The day of the week range |
| * <code>"0-7"</code> is equivalent to <code>"*"</code>. |
| * <p> |
| * <pre> |
| * Example: second = "1-10" |
| * Example: dayOfWeek = "Fri-Mon" |
| * Example: dayOfMonth = "27-3" (Equivalent to "27-Last , 1-3")</pre> |
| * |
| * <li> Increments. The forward slash constrains an attribute based on a |
| * starting point and an interval, and is used to specify every <code>N</code> |
| * seconds, minutes, or hours within the minute, hour, or day, respectively. |
| * For the expression <code>x/y</code>, the attribute is constrained to |
| * every <code>y</code>th value within the set of allowable values beginning |
| * at time <code>x</code>. The <code>x</code> value is inclusive. The |
| * wild card character (<code>*</code>) can be used in the <code>x</code> |
| * position, and is equivalent to <code>0</code>. The use of increments |
| * is only supported within the <code>second</code>, <code>minute</code>, |
| * and <code>hour</code> elements. For the <code>second</code> and |
| * <code>minute</code> elements, <code>x</code> and <code>y</code> must |
| * each be in the range <code>[0,59]</code>. For the <code>hour</code> |
| * element, <code>x</code> and <code>y</code> must each be in the range |
| * <code>[0,23]</code>. |
| * <p> |
| * <pre> |
| * Example: minute = "∗/5" (Every five minutes within the hour)</pre> |
| * This is equivalent to: |
| * <code>minute = "0,5,10,15,20,25,30,35,40,45,50,55"</code> |
| * <p> |
| * <pre> |
| * Example: second = "30/10" (Every 10 seconds within the minute, starting at second 30) </pre> |
| * This is equivalent to: <code>second = "30,40,50"</code> |
| * <p> Note that the set of matching increment values stops once the maximum |
| * value for that attribute is exceeded. It does not "roll over" past the |
| * boundary. |
| * <p> |
| * <pre> |
| * Example : ( minute = "∗/14", hour="1,2")</pre> |
| * <p> This is equivalent to: <code>(minute = "0,14,28,42,56", hour = "1,2")</code> |
| * (Every 14 minutes within the hour, for the hours of 1 and 2 a.m.) |
| * </ul> |
| * |
| * <p> |
| * The following additional rules apply to the schedule specification elements: |
| * <ul> |
| * <li> If the <code>dayOfMonth</code> element has a non-wildcard value and |
| * the <code>dayOfWeek</code> element has a non-wildcard value, then any |
| * day matching either the <code>dayOfMonth</code> value or the |
| * <code>dayOfWeek</code> value will be considered to apply. |
| * <li> Whitespace is ignored, except for string constants and numeric values. |
| * <li> All string constants (e.g., <code>"Sun"</code>, <code>"Jan"</code>, |
| * <code>"1st"</code>, etc.) are case insensitive. |
| * </ul> |
| * <p> |
| * Schedule-based timer times are evaluated in the context of the default |
| * time zone associated with the container in which the application is |
| * executing. A schedule-based timer may optionally override this default |
| * and associate itself with a specific time zone. If the schedule-based |
| * timer is associated with a specific time zone, all its times are |
| * evaluated in the context of that time zone, regardless of the default |
| * time zone in which the container is executing. |
| * <p> |
| * The timeout callback method to which the <code>Schedule</code> annotation is applied |
| * must have one of the following signatures, where <code><METHOD></code> |
| * designates the method name: |
| * <p> |
| * <pre> |
| * void <METHOD>() |
| * void <METHOD>(Timer timer) |
| * </pre> |
| * |
| * A timeout callback method can have public, private, protected, or |
| * package level access. A timeout callback method must not be declared as |
| * final or static. Timeout callback methods must not throw application exceptions. |
| * |
| * @since EJB 3.1 |
| */ |
| @Target(METHOD) |
| @Retention(RUNTIME) |
| public @interface Schedule { |
| |
| /** |
| * Specifies one or more seconds with in a minute. |
| */ |
| String second() default "0"; |
| |
| /** |
| * Specifies one or more minutes with an hour. |
| */ |
| String minute() default "0"; |
| |
| /** |
| * Specifies one or more hours within a day. |
| */ |
| String hour() default "0"; |
| |
| /** |
| * Specifies one or more days within a month. |
| */ |
| String dayOfMonth() default "*"; |
| |
| /** |
| * Specifies one or more months within a year. |
| */ |
| String month() default "*"; |
| |
| /** |
| * Specifies one or more days within a week. |
| */ |
| String dayOfWeek() default "*"; |
| |
| /** |
| * Specifies one or more years. |
| */ |
| String year() default "*"; |
| |
| /** |
| * Specifies the time zone within which the schedule is evaluated. |
| * Time zones are specified as an ID string. The set of required |
| * time zone IDs is defined by the Zone Name(TZ) column of the public |
| * domain zoneinfo database. |
| * <p> |
| * If a timezone is not specified, the schedule is evaluated in the context |
| * of the default timezone associated with the contianer in which the |
| * application is executing. |
| */ |
| String timezone() default ""; |
| |
| /** |
| * Specifies an information string that is associated with the timer |
| */ |
| String info() default ""; |
| |
| /** |
| * Specifies whether the timer that is created is persistent. |
| */ |
| boolean persistent() default true; |
| } |