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 fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.util.AppLogService;
38
39 /**
40 * Represents a runnable waiting to be launched by the {@link ThreadLauncherDaemon}
41 */
42 public class RunnableQueueItem implements Runnable
43 {
44 private Runnable _runnable;
45 private String _strKey;
46 private Plugin _plugin;
47
48 /**
49 * Creates a new {@link RunnableQueueItem}
50 *
51 * @param runnable
52 * The runnable waiting to bet launched
53 * @param strKey
54 * The key associated with the runnable. Runnables of a given plugin are ensured that they will not be executed at the same time if they have the
55 * same key.
56 * @param plugin
57 * The plugin associated with the runnable queue item
58 */
59 public RunnableQueueItem( Runnable runnable, String strKey, Plugin plugin )
60 {
61 this._runnable = runnable;
62 this._strKey = strKey;
63 this._plugin = plugin;
64 }
65
66 /**
67 * {@inheritDoc}
68 */
69 @Override
70 public void run( )
71 {
72 try
73 {
74 _runnable.run( );
75 }
76 catch( Exception e )
77 {
78 AppLogService.error( e.getMessage( ), e );
79 }
80 }
81
82 /**
83 * Get the runnable that is waiting for its execution
84 *
85 * @return The runnable
86 */
87 public Runnable getRunnable( )
88 {
89 return _runnable;
90 }
91
92 /**
93 * Get the key that identifies the runnable.
94 *
95 * @return the key of the runnable
96 */
97 public String getKey( )
98 {
99 return _strKey;
100 }
101
102 /**
103 * Get the plugin that created the runnable
104 *
105 * @return The plugin that created the runnable
106 */
107 public Plugin getPlugin( )
108 {
109 return _plugin;
110 }
111
112 /**
113 * Compute the key of the item from its plugin name and the declared key. The difference between the computed key and the defined key is that the computed
114 * key is unique, whereas the defined key is unique within a plugin.
115 *
116 * @return The computed key of this runnable item
117 */
118 protected String computeKey( )
119 {
120 if ( ( _strKey != null ) && ( _plugin != null ) )
121 {
122 return _plugin.getName( ) + _strKey;
123 }
124
125 return null;
126 }
127 }