001
014
015 package com.liferay.portal.kernel.scheduler;
016
017 import com.liferay.portal.kernel.messaging.Message;
018 import com.liferay.portal.kernel.messaging.MessageListener;
019 import com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse;
020 import com.liferay.portal.kernel.security.pacl.permission.PortalRuntimePermission;
021 import com.liferay.portal.kernel.util.ObjectValuePair;
022 import com.liferay.portal.kernel.util.ProxyFactory;
023
024 import java.util.Calendar;
025 import java.util.Date;
026 import java.util.List;
027
028 import javax.portlet.PortletRequest;
029
030
033 public class SchedulerEngineHelperUtil {
034
035 public static void addScriptingJob(
036 Trigger trigger, StorageType storageType, String description,
037 String language, String script, int exceptionsMaxSize)
038 throws SchedulerException {
039
040 getSchedulerEngineHelper().addScriptingJob(
041 trigger, storageType, description, language, script,
042 exceptionsMaxSize);
043 }
044
045 public static void auditSchedulerJobs(
046 Message message, TriggerState triggerState)
047 throws SchedulerException {
048
049 getSchedulerEngineHelper().auditSchedulerJobs(message, triggerState);
050 }
051
052 public static void delete(
053 SchedulerEntry schedulerEntry, StorageType storageType)
054 throws SchedulerException {
055
056 getSchedulerEngineHelper().delete(schedulerEntry, storageType);
057 }
058
059 public static void delete(String groupName, StorageType storageType)
060 throws SchedulerException {
061
062 getSchedulerEngineHelper().delete(groupName, storageType);
063 }
064
065 public static void delete(
066 String jobName, String groupName, StorageType storageType)
067 throws SchedulerException {
068
069 getSchedulerEngineHelper().delete(jobName, groupName, storageType);
070 }
071
072 public static String getCronText(
073 Calendar calendar, boolean timeZoneSensitive) {
074
075 return getSchedulerEngineHelper().getCronText(
076 calendar, timeZoneSensitive);
077 }
078
079 public static String getCronText(
080 PortletRequest portletRequest, Calendar calendar,
081 boolean timeZoneSensitive, int recurrenceType) {
082
083 return getSchedulerEngineHelper().getCronText(
084 portletRequest, calendar, timeZoneSensitive, recurrenceType);
085 }
086
087 public static Date getEndTime(SchedulerResponse schedulerResponse) {
088 return getSchedulerEngineHelper().getEndTime(schedulerResponse);
089 }
090
091 public static Date getEndTime(
092 String jobName, String groupName, StorageType storageType)
093 throws SchedulerException {
094
095 return getSchedulerEngineHelper().getEndTime(
096 jobName, groupName, storageType);
097 }
098
099 public static Date getFinalFireTime(SchedulerResponse schedulerResponse) {
100 return getSchedulerEngineHelper().getFinalFireTime(schedulerResponse);
101 }
102
103 public static Date getFinalFireTime(
104 String jobName, String groupName, StorageType storageType)
105 throws SchedulerException {
106
107 return getSchedulerEngineHelper().getFinalFireTime(
108 jobName, groupName, storageType);
109 }
110
111 public static ObjectValuePair<Exception, Date>[] getJobExceptions(
112 SchedulerResponse schedulerResponse) {
113
114 return getSchedulerEngineHelper().getJobExceptions(schedulerResponse);
115 }
116
117 public static ObjectValuePair<Exception, Date>[] getJobExceptions(
118 String jobName, String groupName, StorageType storageType)
119 throws SchedulerException {
120
121 return getSchedulerEngineHelper().getJobExceptions(
122 jobName, groupName, storageType);
123 }
124
125 public static TriggerState getJobState(
126 SchedulerResponse schedulerResponse) {
127
128 return getSchedulerEngineHelper().getJobState(schedulerResponse);
129 }
130
131 public static TriggerState getJobState(
132 String jobName, String groupName, StorageType storageType)
133 throws SchedulerException {
134
135 return getSchedulerEngineHelper().getJobState(
136 jobName, groupName, storageType);
137 }
138
139 public static Date getNextFireTime(SchedulerResponse schedulerResponse) {
140 return getSchedulerEngineHelper().getNextFireTime(schedulerResponse);
141 }
142
143 public static Date getNextFireTime(
144 String jobName, String groupName, StorageType storageType)
145 throws SchedulerException {
146
147 return getSchedulerEngineHelper().getNextFireTime(
148 jobName, groupName, storageType);
149 }
150
151 public static Date getPreviousFireTime(
152 SchedulerResponse schedulerResponse) {
153
154 return getSchedulerEngineHelper().getPreviousFireTime(
155 schedulerResponse);
156 }
157
158 public static Date getPreviousFireTime(
159 String jobName, String groupName, StorageType storageType)
160 throws SchedulerException {
161
162 return getSchedulerEngineHelper().getPreviousFireTime(
163 jobName, groupName, storageType);
164 }
165
166 public static SchedulerResponse getScheduledJob(
167 String jobName, String groupName, StorageType storageType)
168 throws SchedulerException {
169
170 return getSchedulerEngineHelper().getScheduledJob(
171 jobName, groupName, storageType);
172 }
173
174 public static List<SchedulerResponse> getScheduledJobs()
175 throws SchedulerException {
176
177 return getSchedulerEngineHelper().getScheduledJobs();
178 }
179
180 public static List<SchedulerResponse> getScheduledJobs(
181 StorageType storageType)
182 throws SchedulerException {
183
184 return getSchedulerEngineHelper().getScheduledJobs(storageType);
185 }
186
187 public static List<SchedulerResponse> getScheduledJobs(
188 String groupName, StorageType storageType)
189 throws SchedulerException {
190
191 return getSchedulerEngineHelper().getScheduledJobs(
192 groupName, storageType);
193 }
194
195 public static SchedulerEngineHelper getSchedulerEngineHelper() {
196 PortalRuntimePermission.checkGetBeanProperty(
197 SchedulerEngineHelperUtil.class);
198
199 return _instance;
200 }
201
202 public static Date getStartTime(SchedulerResponse schedulerResponse) {
203 return getSchedulerEngineHelper().getStartTime(schedulerResponse);
204 }
205
206 public static Date getStartTime(
207 String jobName, String groupName, StorageType storageType)
208 throws SchedulerException {
209
210 return getSchedulerEngineHelper().getStartTime(
211 jobName, groupName, storageType);
212 }
213
214 public static boolean isClusteredSchedulerEngine() {
215 return getSchedulerEngineHelper().isClusteredSchedulerEngine();
216 }
217
218 public static void pause(String groupName, StorageType storageType)
219 throws SchedulerException {
220
221 getSchedulerEngineHelper().pause(groupName, storageType);
222 }
223
224 public static void pause(
225 String jobName, String groupName, StorageType storageType)
226 throws SchedulerException {
227
228 getSchedulerEngineHelper().pause(jobName, groupName, storageType);
229 }
230
231 public static void register(
232 MessageListener messageListener, SchedulerEntry schedulerEntry,
233 String destinationName) {
234
235 getSchedulerEngineHelper().register(
236 messageListener, schedulerEntry, destinationName);
237 }
238
239 public static void resume(String groupName, StorageType storageType)
240 throws SchedulerException {
241
242 getSchedulerEngineHelper().resume(groupName, storageType);
243 }
244
245 public static void resume(
246 String jobName, String groupName, StorageType storageType)
247 throws SchedulerException {
248
249 getSchedulerEngineHelper().resume(jobName, groupName, storageType);
250 }
251
252 public static void schedule(
253 Trigger trigger, StorageType storageType, String description,
254 String destinationName, Message message, int exceptionsMaxSize)
255 throws SchedulerException {
256
257 getSchedulerEngineHelper().schedule(
258 trigger, storageType, description, destinationName, message,
259 exceptionsMaxSize);
260 }
261
262 public static void schedule(
263 Trigger trigger, StorageType storageType, String description,
264 String destinationName, Object payload, int exceptionsMaxSize)
265 throws SchedulerException {
266
267 getSchedulerEngineHelper().schedule(
268 trigger, storageType, description, destinationName, payload,
269 exceptionsMaxSize);
270 }
271
272 public static void shutdown() throws SchedulerException {
273 getSchedulerEngineHelper().shutdown();
274 }
275
276 public static void start() throws SchedulerException {
277 getSchedulerEngineHelper().start();
278 }
279
280 public static void suppressError(
281 String jobName, String groupName, StorageType storageType)
282 throws SchedulerException {
283
284 getSchedulerEngineHelper().suppressError(
285 jobName, groupName, storageType);
286 }
287
288 public static void unregister(MessageListener messageListener) {
289 getSchedulerEngineHelper().unregister(messageListener);
290 }
291
292 public static void unschedule(
293 SchedulerEntry schedulerEntry, StorageType storageType)
294 throws SchedulerException {
295
296 getSchedulerEngineHelper().unschedule(schedulerEntry, storageType);
297 }
298
299 public static void unschedule(String groupName, StorageType storageType)
300 throws SchedulerException {
301
302 getSchedulerEngineHelper().unschedule(groupName, storageType);
303 }
304
305 public static void unschedule(
306 String jobName, String groupName, StorageType storageType)
307 throws SchedulerException {
308
309 getSchedulerEngineHelper().unschedule(jobName, groupName, storageType);
310 }
311
312 public static void update(
313 String jobName, String groupName, StorageType storageType,
314 String description, String language, String script,
315 int exceptionsMaxSize)
316 throws SchedulerException {
317
318 getSchedulerEngineHelper().update(
319 jobName, groupName, storageType, description, language, script,
320 exceptionsMaxSize);
321 }
322
323 public static void update(Trigger trigger, StorageType storageType)
324 throws SchedulerException {
325
326 getSchedulerEngineHelper().update(trigger, storageType);
327 }
328
329 private static final SchedulerEngineHelper _instance =
330 ProxyFactory.newServiceTrackedInstance(SchedulerEngineHelper.class);
331
332 }