01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001-2002 Janne Jalkanen (Janne.Jalkanen@iki.fi)
05:
06: This program is free software; you can redistribute it and/or modify
07: it under the terms of the GNU Lesser General Public License as published by
08: the Free Software Foundation; either version 2.1 of the License, or
09: (at your option) any later version.
10:
11: This program is distributed in the hope that it will be useful,
12: but WITHOUT ANY WARRANTY; without even the implied warranty of
13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: GNU Lesser General Public License for more details.
15:
16: You should have received a copy of the GNU Lesser General Public License
17: along with this program; if not, write to the Free Software
18: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20: package com.ecyrd.jspwiki.util;
21:
22: /**
23: * A watchdog needs something to watch. If you wish to be watched,
24: * implement this interface.
25: *
26: * @author jalkanen
27: */
28: public interface Watchable {
29: /**
30: * This is a callback which is called whenever your expected
31: * completion time is exceeded. The current state of the
32: * stack is available.
33: *
34: * @param state The state in which your Watchable is currently.
35: */
36: public void timeoutExceeded(String state);
37:
38: /**
39: * Returns a human-readable name of this Watchable. Used in
40: * logging.
41: *
42: * @return The name of the Watchable.
43: */
44: public String getName();
45:
46: /**
47: * Returns <code>true</code>, if this Watchable is still alive and can be
48: * watched; otherwise <code>false</code>. For example, a stopped Thread
49: * is not very interesting to watch.
50: *
51: * @return the result
52: */
53: public boolean isAlive();
54: }
|