forked from actframework/actframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOnSysEvent.java
More file actions
61 lines (54 loc) · 1.93 KB
/
OnSysEvent.java
File metadata and controls
61 lines (54 loc) · 1.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package act.job;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* 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.
* #L%
*/
import act.app.event.SysEventId;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Mark a method to be a job that must be run upon a certain {@link SysEventId system event}
* occurred
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface OnSysEvent {
/**
* Specify the {@link SysEventId app event id} the job should start with
* @return the event ID
*/
SysEventId value();
/**
* <p>Indicate if the job should be run synchronously with application
* or asynchronously.</p>
* <p>Running job synchronously means the application
* will not start servicing incoming requests until the job is finished.</p>
* <p>Running job asynchronously means the job will start in a separate thread
* and will not block the app from servicing incoming requests</p>
* @return {@code true} if the annotated method shall be executed asynchronously
* or {@code false} if the method all be executed synchronously
*/
boolean async() default false;
/**
* Specify the ID of the scheduled job. Default value: empty string
* @return the job id
*/
String id() default "";
}