KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > service > Serviceable


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: Serviceable.java,v 1.1 2004/11/26 01:51:01 tanderson Exp $
44  */
45 package org.exolab.jms.service;
46
47 import java.io.Serializable JavaDoc;
48
49
50 /**
51  * This interface defines a protocol for serviceable objects. A serviceable
52  * object is one that can be controlled through start, stop etc.
53  *
54  * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:01 $
55  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
56  * @see BasicService
57  */
58 public interface Serviceable extends Serializable JavaDoc {
59
60     /**
61      * Start the service.
62      *
63      * @throws ServiceException if the service fails to start, or is already
64      * running
65      */
66     public void start() throws ServiceException;
67     
68     /**
69      * Stop the service.
70      *
71      * @throws ServiceException if the service fails to stop, or is already
72      * stopped
73      */
74     public void stop() throws ServiceException;
75
76     /**
77      * Convenience method for restarting the service. This operation can
78      * be called regardless the current state of the service.
79      *
80      * @throws ServiceException if the service fails to restart
81      */
82     public void restart() throws ServiceException;
83     
84      /**
85       * Return the current state of the service
86       *
87       * @return the current state of the service
88       */
89     public ServiceState getState();
90
91     /**
92      * Return the name of the service
93      *
94      * @return the name of the service
95      */
96     public String JavaDoc getName();
97
98 }
99
Popular Tags