1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.scheduler;
35
36 import fr.paris.lutece.portal.service.util.AppLogService;
37
38 import org.quartz.CronTrigger;
39 import org.quartz.JobDetail;
40 import org.quartz.Scheduler;
41 import org.quartz.SchedulerException;
42 import org.quartz.SchedulerFactory;
43
44 import org.quartz.impl.StdSchedulerFactory;
45
46 import java.util.Date;
47
48 /**
49 * JobSchedulerService
50 */
51 public final class JobSchedulerService
52 {
53 private static JobSchedulerService _singleton;
54 private static Scheduler _scheduler;
55
56 /** Creates a new instance of JobSchedulerService */
57 private JobSchedulerService( )
58 {
59 init( );
60 }
61
62 /**
63 * Gets the unique instance of the service
64 *
65 * @return The service's instance
66 */
67 public static synchronized JobSchedulerService getInstance( )
68 {
69 if ( _singleton == null )
70 {
71 _singleton = new JobSchedulerService( );
72 }
73
74 return _singleton;
75 }
76
77 /**
78 * Initialize the service.
79 */
80 private void init( )
81 {
82 SchedulerFactory factory = new StdSchedulerFactory( );
83
84 try
85 {
86 _scheduler = factory.getScheduler( );
87 _scheduler.start( );
88 AppLogService.info( "Lutece job scheduler started." );
89 }
90 catch( SchedulerException e )
91 {
92 AppLogService.error( "Error starting the Lutece job scheduler ", e );
93 }
94 }
95
96 /**
97 * Schedule a job according cron information
98 *
99 * @param job
100 * The Job to schedule
101 * @param trigger
102 * The Cron trigger
103 * @return Date
104 */
105 public Date scheduleJob( JobDetail job, CronTrigger trigger )
106 {
107 Date date = null;
108
109 if ( _scheduler != null )
110 {
111 try
112 {
113 date = _scheduler.scheduleJob( job, trigger );
114 AppLogService.info( "New job scheduled : {}", job.getKey( ).getName( ) );
115 }
116 catch( SchedulerException e )
117 {
118 AppLogService.error( "Error scheduling job {}", job.getKey( ).getName( ), e );
119 }
120 }
121
122 return date;
123 }
124
125 /**
126 * Shutdown the service (Called by the core while the webapp is destroyed)
127 */
128 public static void shutdown( )
129 {
130 if ( _scheduler != null )
131 {
132 try
133 {
134 _scheduler.shutdown( );
135 AppLogService.info( "Lutece job scheduler stopped." );
136 }
137 catch( SchedulerException e )
138 {
139 AppLogService.error( "Error shuting down the Lutece job scheduler ", e );
140 }
141 }
142 }
143 }