01: /*
02: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: *
23: * Free Software Foundation, Inc.
24: * 59 Temple Place, Suite 330
25: * Boston, MA 02111-1307 USA
26: *
27: * @author Scott Ferguson
28: */
29:
30: package com.caucho.boot;
31:
32: import java.io.*;
33:
34: import com.caucho.config.ConfigException;
35:
36: /**
37: * Process responsible for watching a backend server.
38: */
39: public interface WatchdogAPI {
40: /**
41: * Returns the status of the watchdog manager
42: *
43: * @param password the watchdog password
44: *
45: * @return a user-readable status report
46: */
47: public String status(String password);
48:
49: /**
50: * Starts the server with the given arguments. If the
51: * start fails, a ConfigException is thrown.
52: */
53: public void start(String password, String[] argv)
54: throws ConfigException, IllegalStateException, IOException;
55:
56: /**
57: * Restarts the server with the given arguments.
58: *
59: * @param password watchdog password
60: * @param serverId the server to be restarted
61: * @param argv the new arguments for the server
62: */
63: public void restart(String password, String serverId, String[] argv)
64: throws ConfigException, IllegalStateException, IOException;
65:
66: /**
67: * Stops the named server
68: *
69: * @param password the watchdog password
70: * @param serverId the server to stop
71: * @throws com.caucho.config.ConfigException
72: */
73: public void stop(String password, String serverId)
74: throws ConfigException, IllegalStateException, IOException;
75:
76: /**
77: * Kills the named server, terminating the process.
78: *
79: * @param password the watchdog password
80: * @param serverId the server to kill
81: */
82: public void kill(String password, String serverId)
83: throws ConfigException, IllegalStateException, IOException;
84:
85: /**
86: * Shuts the entire watchdog manager down.
87: *
88: * @param password
89: * @return true on success
90: */
91: public boolean shutdown(String password) throws IOException;
92: }
|