01: /**
02: * Copyright 2006 Webmedia Group Ltd.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: **/package org.araneaframework;
16:
17: import java.io.Serializable;
18:
19: /**
20: * An entity with a licecycle (<code>init</code>, <code>destroy</code>) and an Environment.
21: * <br><br>
22: * A components lifecycle is simple. It starts with init and ends with destroy.
23: * <ul>
24: * <li>A component once inited, cannot be reinited.
25: * <li>A component once destroyed, cannot be reinited.
26: * <li>A component not inited, cannot be destroyed.
27: * </ul>
28: * If a lifecycle contract is broken {@link org.araneaframework.core.AraneaRuntimeException}
29: * will be thrown.
30: * <br><br>
31: * The component is initialized with an {@link org.araneaframework.Environment}. The component's
32: * Environment cannot be altered after the initialization process.
33: * <br><br>
34: * The Component follows the template pattern by defining <code>_getComponent()</code>
35: * which returns the implementation.
36: *
37: * @author "Toomas Römer" <toomas@webmedia.ee>
38: * @author Jevgeni Kabanov (ekabanov <i>at</i> araneaframework <i>dot</i> org)
39: */
40: public interface Component extends Serializable {
41: /** @since 1.1 */
42: public Environment getEnvironment();
43:
44: /** @since 1.1 */
45: public Scope getScope();
46:
47: /**
48: * Returns true iff this component has been initialized and is not destroyed.
49: * @since 1.1 */
50: public boolean isAlive();
51:
52: /**
53: * The factory method returning the implementation of the Component.
54: * @return the implementation of the Component.
55: */
56: public Component.Interface _getComponent();
57:
58: /**
59: * The interface which takes care of calling the hooks in the template.
60: */
61: public interface Interface extends Serializable {
62:
63: /**
64: * Initializes this Component with the specified Environment.
65: * @param scope TODO
66: * @param env the Environment of this Component
67: */
68: public void init(Scope scope, Environment env);
69:
70: /**
71: * Destroys this Component.
72: */
73: public void destroy();
74:
75: public void propagate(Message message);
76:
77: public void enable();
78:
79: public void disable();
80: }
81: }
|