01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.system.server;
23:
24: import java.util.Properties;
25:
26: /**
27: * The interface of the basic JBoss server component.
28: *
29: * @version <tt>$Revision: 57205 $</tt>
30: * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
31: */
32: public interface Server {
33: /** The JMX notification event type sent on end of server startup */
34: public final String START_NOTIFICATION_TYPE = "org.jboss.system.server.started";
35: /** The JMX notification event type sent on begin of the server shutdown */
36: public final String STOP_NOTIFICATION_TYPE = "org.jboss.system.server.stopped";
37:
38: /**
39: * Initialize the Server instance.
40: *
41: * @param props The configuration properties for the server.
42: * @return Typed server configuration object.
43: *
44: * @throws IllegalStateException Already initialized.
45: * @throws Exception Failed to initialize.
46: */
47: void init(Properties props) throws IllegalStateException, Exception;
48:
49: /**
50: * Get the typed server configuration object which the
51: * server has been initalized to use.
52: *
53: * @return Typed server configuration object.
54: *
55: * @throws IllegalStateException Not initialized.
56: */
57: ServerConfig getConfig() throws IllegalStateException;
58:
59: /**
60: * Start the Server instance.
61: *
62: * @throws IllegalStateException Already started or not initialized.
63: * @throws Exception Failed to start.
64: */
65: void start() throws IllegalStateException, Exception;
66:
67: /**
68: * Check if the server is started.
69: *
70: * @return True if the server is started, else false.
71: */
72: boolean isStarted();
73:
74: /**
75: * Shutdown the Server instance and run shutdown hooks.
76: *
77: * <p>If the exit on shutdown flag is true, then {@link #exit}
78: * is called, else only the shutdown hook is run.
79: *
80: * @throws IllegalStateException No started.
81: */
82: void shutdown() throws IllegalStateException;
83:
84: /**
85: * Shutdown the server, the JVM and run shutdown hooks.
86: *
87: * @param exitcode The exit code returned to the operating system.
88: */
89: void exit(int exitcode);
90:
91: /**
92: * Forcibly terminates the currently running Java virtual machine.
93: *
94: * @param exitcode The exit code returned to the operating system.
95: */
96: void halt(int exitcode);
97: }
|