KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jonas > service > Service


1 /**
2  * JOnAS: Java(TM) Open Application Server
3  * Copyright (C) 1999 Bull S.A.
4  * Contact: jonas-team@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA
20  *
21  * Initial developer(s): ____________________________________.
22  * Contributor(s): ______________________________________.
23  *
24  * 01/06/15 Regis Le Brettevillois - Libelis / JOnAS team - Evidian
25  * Creation.
26  *
27  * --------------------------------------------------------------------------
28  * $Id: Service.java,v 1.3 2004/08/23 13:07:03 sauthieg Exp $
29  * --------------------------------------------------------------------------
30  */

31
32 package org.objectweb.jonas.service;
33
34 import javax.naming.Context JavaDoc;
35
36 /**
37  * This interface defines a Service.
38  * Objects which implement this interface must have a public constructor
39  * with a string parameter which is the name of the service.
40  */

41 public interface Service {
42
43     /**
44      * Initialize the service
45      * @param ctx configuration of the service
46      * @throws ServiceException when init fails.
47      */

48     void init(Context JavaDoc ctx) throws ServiceException;
49
50     /**
51      * Start the service
52      * @throws ServiceException when start fails.
53      */

54     void start() throws ServiceException;
55
56     /**
57      * Stop the service
58      * @throws ServiceException when stop fails.
59      */

60     void stop() throws ServiceException;
61
62     /**
63      * @return Returns true if the service is started, false otherwise
64      */

65     boolean isStarted();
66
67     /**
68      * Set the service's name
69      * @param name the service's name
70      */

71     void setName(String JavaDoc name);
72
73     /**
74      * @return Returns the service's name
75      */

76     String JavaDoc getName();
77 }
Popular Tags