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