KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mule > registry > Assembly


1 /*
2  * $Id: Assembly.java 3798 2006-11-04 04:07:14Z aperepel $
3  * --------------------------------------------------------------------------------------
4  * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
5  *
6  * The software in this package is published under the terms of the MuleSource MPL
7  * license, a copy of which has been included with this distribution in the
8  * LICENSE.txt file.
9  */
10
11 package org.mule.registry;
12
13 /**
14  * @author <a HREF="mailto:gnt@codehaus.org">Guillaume Nodet</a>
15  */
16 public interface Assembly extends Entry
17 {
18
19     void restoreState() throws RegistryException;
20
21     void saveAndShutdown() throws RegistryException;
22
23     boolean isTransient();
24
25     void setTransient(boolean isTransient);
26
27     /**
28      * Start the item.
29      *
30      * @exception RegistryException if the item fails to start.
31      */
32     String JavaDoc start() throws RegistryException;
33
34     /**
35      * Stop the item. This suspends current messaging activities.
36      *
37      * @exception RegistryException if the item fails to stop.
38      */
39     String JavaDoc stop() throws RegistryException;
40
41     /**
42      * Shut down the item. The releases resources, preparatory to uninstallation.
43      *
44      * @exception RegistryException if the item fails to shut down.
45      */
46     String JavaDoc shutDown() throws RegistryException;
47
48     /**
49      * Return the Unit of the given name.
50      *
51      * @param name the name of the unit
52      * @return the Unit or <code>null</code> if not found
53      */
54     Unit getUnit(String JavaDoc name);
55
56     /**
57      * Get all units of this Assembly
58      *
59      * @return the units of this Assembly
60      */
61     Unit[] getUnits();
62
63     /**
64      * Return the descriptor for this component.
65      *
66      * @return
67      */
68     RegistryDescriptor getDescriptor() throws RegistryException;
69
70     void setDescriptor(RegistryDescriptor descriptor) throws RegistryException;
71
72     String JavaDoc deploy() throws RegistryException;
73
74     String JavaDoc undeploy() throws RegistryException;
75
76 }
77
Popular Tags