KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > easybeans > api > EZBManageableContainer


1 /**
2  * EasyBeans
3  * Copyright (C) 2006 Bull S.A.S.
4  * Contact: easybeans@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  * --------------------------------------------------------------------------
22  * $Id: EZBManageableContainer.java 925 2006-07-25 12:37:03Z benoitf $
23  * --------------------------------------------------------------------------
24  */

25
26 package org.objectweb.easybeans.api;
27
28
29 /**
30  * Manageable interface for {@link EZBContainer}.
31  * @author Guillaume Sauthier
32  */

33 public interface EZBManageableContainer {
34
35     /**
36      * Gets the id of this container.
37      * @return string id.
38      */

39     String JavaDoc getId();
40
41     /**
42      * Gets the name of this container.
43      * @return the name.
44      */

45     String JavaDoc getName();
46
47     /**
48      * Start this container.
49      * @throws EZBContainerException if the start fails.
50      */

51     void start() throws EZBContainerException;
52
53     /**
54      * Stop this container.
55      */

56     void stop();
57
58     /**
59      * Gets the archive used by this container. It can be a .jar file or a directory.
60      * @return the archive.
61      */

62     EZBArchive getArchive();
63
64     /**
65      * Check if the container is available or not.
66      * @return true if the container is available.
67      */

68     boolean isAvailable();
69
70 }
71
Popular Tags