KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: Entry.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 Entry
17 {
18
19     /**
20      * Name of this entry
21      *
22      * @return
23      */
24     String JavaDoc getName();
25
26     void setName(String JavaDoc name);
27
28     /**
29      * Retrieves the installation directory.
30      *
31      * @return the installation directory
32      */
33     String JavaDoc getInstallRoot();
34
35     /**
36      * Sets the installation directory.
37      *
38      * @param installRoot the installation directory
39      */
40     void setInstallRoot(String JavaDoc installRoot);
41
42     /**
43      * Get the current state of this managed compononent.
44      *
45      * @return the current state of this managed component (must be one of the string
46      * constants defined by this interface)
47      */
48     String JavaDoc getCurrentState();
49
50     /**
51      * Status before JBI was shutdown.
52      *
53      * @return
54      */
55     String JavaDoc getStateAtShutdown();
56
57     /**
58      * Set the state before the server was shutdown.
59      *
60      * @param state
61      */
62     void setStateAtShutdown(String JavaDoc state) throws RegistryException;
63
64     void setCurrentState(String JavaDoc state) throws RegistryException;
65
66     /** Value returned by {@link #getCurrentState()} for a shutdown component. */
67     final static String JavaDoc SHUTDOWN = "Shutdown";
68
69     /** Value returned by {@link #getCurrentState()} for a stopped component. */
70     final static String JavaDoc STOPPED = "Stopped";
71
72     /** Value returned by {@link #getCurrentState()} for a running component. */
73     final static String JavaDoc RUNNING = "Running";
74
75     /**
76      * Value returned by {@link #getCurrentState()} for a component in an unknown
77      * state.
78      */
79     final static String JavaDoc UNKNOWN = "Unknown";
80
81     /**
82      * Value returned by {@link #getCurrentState()} for a component in an initialised
83      * state.
84      */
85     final static String JavaDoc INITIALIZED = "Initialized";
86
87 }
88
Popular Tags