KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > ComponentLifecycle


1 package com.jcorporate.expresso.kernel;
2
3 /* ====================================================================
4  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
5  *
6  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by Jcorporate Ltd.
23  * (http://www.jcorporate.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. "Jcorporate" and product names such as "Expresso" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written permission,
30  * please contact info@jcorporate.com.
31  *
32  * 5. Products derived from this software may not be called "Expresso",
33  * or other Jcorporate product names; nor may "Expresso" or other
34  * Jcorporate product names appear in their name, without prior
35  * written permission of Jcorporate Ltd.
36  *
37  * 6. No product derived from this software may compete in the same
38  * market space, i.e. framework, without prior written permission
39  * of Jcorporate Ltd. For written permission, please contact
40  * partners@jcorporate.com.
41  *
42  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
43  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
44  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
45  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
46  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
47  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
48  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
49  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
50  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
51  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
52  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53  * SUCH DAMAGE.
54  * ====================================================================
55  *
56  * This software consists of voluntary contributions made by many
57  * individuals on behalf of the Jcorporate Ltd. Contributions back
58  * to the project(s) are encouraged when you make modifications.
59  * Please send them to support@jcorporate.com. For more information
60  * on Jcorporate Ltd. and its products, please see
61  * <http://www.jcorporate.com/>.
62  *
63  * Portions of this software are based upon other open source
64  * products and are subject to their respective licenses.
65  */
66
67 import com.jcorporate.expresso.kernel.exception.ConfigurationException;
68
69 /**
70  * Lifecycle interface of an Expresso component. This should be implemented
71  * by any serious Expresso service that wishes to benefit from a component
72  * based architecture. Although there are other lifecycle events available
73  * in other interfaces, these are the basic lifecycle events that most
74  * components will utilize in one way or another.
75  *
76  * @author Michael Rimov
77  */
78 public interface ComponentLifecycle {
79
80     /**
81      * Initialize the component, this is called before the component receives
82      * any configuration information.
83      */
84     public void initialize();
85
86     /**
87      * Configure the service. This is where any parameter settings will take
88      * place.
89      *
90      * @param newConfig a read only dynabean containing all the needed configuration.
91      * @throws IllegalArgumentException newConfig is null or the types in it are
92      * not what is expected by the Component
93      * @throws ConfigurationException if for some reason the Component cannot cope
94      * with the configuration sent to it. If this exception is thrown then ZERO
95      * reconfiguration takes place. Configure() must be an all or nothing 'transaction'
96      */
97     public void configure(Configuration newConfig) throws ConfigurationException;
98
99     /**
100      * <p>Reconfigures the service during runtime without having to restart the
101      * container.<p>
102      * <p>Reconfigure is done this way vs. bean/property setters because sometimes
103      * components need special property setting orders and it is not easily possible
104      * to determine what order to set things in. This is the responsibility
105      * of the component</p>
106      * <p>reConfigure() should be done in a transactional manner.... by that, we mean
107      * that if the reconfiguration fails, the component should revert to its previous
108      * state and continue operation</p>
109      *
110      * @param newConfig a read only dynabean containing all the needed configuration.
111      * @throws IllegalArgumentException newConfig is null or the types in it are
112      * not what is expected by the Component
113      * @throws ConfigurationException if for some reason the Component cannot cope
114      * with the configuration sent to it. If this exception is thrown then ZERO
115      * reconfiguration takes place. Configure() must be an all or nothing 'transaction'
116      */
117     public void reconfigure(Configuration newConfig) throws ConfigurationException;
118
119
120     /**
121      * Called upon destruction of the service. This may or may not have anything
122      * to do with container shutdown or reloading.
123      */
124     public void destroy();
125 }
Popular Tags