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.daemon;
35
36 import java.util.concurrent.TimeUnit;
37
38 /**
39 * Daemon scheduler. Responsible for ensuring on demand or timely daemon execution.
40 */
41 public interface IDaemonScheduler
42 {
43
44 /** The bean name */
45 String BEAN_NAME = "daemonScheduler";
46
47 /**
48 * Enqueue a daemon for execution in the immediate future
49 *
50 * @param entry
51 * the daemon entry
52 * @param unit
53 * the delay before execution
54 * @param nDelay
55 * the unit of <code>nDelay</code> argument
56 * @return <code>true</code> if the daemon was successfully queued, <code>false</code> otherwise, for instance if the underlying queue is over capacity
57 */
58 boolean enqueue( DaemonEntry entry, long nDelay, TimeUnit unit );
59
60 /**
61 * Schedule a daemon execution.
62 *
63 * @see DaemonEntry#getInterval()
64 * @param entry
65 * the daemon entry
66 * @param nInitialDelay
67 * the initial delay before the first execution
68 * @param unit
69 * the unit of <code>nInitialDelay</code> argument
70 */
71 void schedule( DaemonEntry entry, long nInitialDelay, TimeUnit unit );
72
73 /**
74 * Unschedule a daemon
75 *
76 * @param entry
77 * the daemon entry
78 */
79 void unSchedule( DaemonEntry daemonEntry );
80
81 /**
82 * Perform an orderly shutdown, stopping daemon execution
83 */
84 void shutdown( );
85
86 }