001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
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    /**
031     * @author Michael C. Han
032     */
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 void pause(String groupName, StorageType storageType)
215                    throws SchedulerException {
216    
217                    getSchedulerEngineHelper().pause(groupName, storageType);
218            }
219    
220            public static void pause(
221                            String jobName, String groupName, StorageType storageType)
222                    throws SchedulerException {
223    
224                    getSchedulerEngineHelper().pause(jobName, groupName, storageType);
225            }
226    
227            public static void register(
228                    MessageListener messageListener, SchedulerEntry schedulerEntry,
229                    String destinationName) {
230    
231                    getSchedulerEngineHelper().register(
232                            messageListener, schedulerEntry, destinationName);
233            }
234    
235            public static void resume(String groupName, StorageType storageType)
236                    throws SchedulerException {
237    
238                    getSchedulerEngineHelper().resume(groupName, storageType);
239            }
240    
241            public static void resume(
242                            String jobName, String groupName, StorageType storageType)
243                    throws SchedulerException {
244    
245                    getSchedulerEngineHelper().resume(jobName, groupName, storageType);
246            }
247    
248            public static void schedule(
249                            Trigger trigger, StorageType storageType, String description,
250                            String destinationName, Message message, int exceptionsMaxSize)
251                    throws SchedulerException {
252    
253                    getSchedulerEngineHelper().schedule(
254                            trigger, storageType, description, destinationName, message,
255                            exceptionsMaxSize);
256            }
257    
258            public static void schedule(
259                            Trigger trigger, StorageType storageType, String description,
260                            String destinationName, Object payload, int exceptionsMaxSize)
261                    throws SchedulerException {
262    
263                    getSchedulerEngineHelper().schedule(
264                            trigger, storageType, description, destinationName, payload,
265                            exceptionsMaxSize);
266            }
267    
268            public static void shutdown() throws SchedulerException {
269                    getSchedulerEngineHelper().shutdown();
270            }
271    
272            public static void start() throws SchedulerException {
273                    getSchedulerEngineHelper().start();
274            }
275    
276            public static void suppressError(
277                            String jobName, String groupName, StorageType storageType)
278                    throws SchedulerException {
279    
280                    getSchedulerEngineHelper().suppressError(
281                            jobName, groupName, storageType);
282            }
283    
284            public static void unregister(MessageListener messageListener) {
285                    getSchedulerEngineHelper().unregister(messageListener);
286            }
287    
288            public static void unschedule(
289                            SchedulerEntry schedulerEntry, StorageType storageType)
290                    throws SchedulerException {
291    
292                    getSchedulerEngineHelper().unschedule(schedulerEntry, storageType);
293            }
294    
295            public static void unschedule(String groupName, StorageType storageType)
296                    throws SchedulerException {
297    
298                    getSchedulerEngineHelper().unschedule(groupName, storageType);
299            }
300    
301            public static void unschedule(
302                            String jobName, String groupName, StorageType storageType)
303                    throws SchedulerException {
304    
305                    getSchedulerEngineHelper().unschedule(jobName, groupName, storageType);
306            }
307    
308            public static void update(
309                            String jobName, String groupName, StorageType storageType,
310                            String description, String language, String script,
311                            int exceptionsMaxSize)
312                    throws SchedulerException {
313    
314                    getSchedulerEngineHelper().update(
315                            jobName, groupName, storageType, description, language, script,
316                            exceptionsMaxSize);
317            }
318    
319            public static void update(Trigger trigger, StorageType storageType)
320                    throws SchedulerException {
321    
322                    getSchedulerEngineHelper().update(trigger, storageType);
323            }
324    
325            private static final SchedulerEngineHelper _instance =
326                    ProxyFactory.newServiceTrackedInstance(SchedulerEngineHelper.class);
327    
328    }