1 package org.apache.turbine.services;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 /***
58 * Classes that implement this interface can act as a broker for
59 * <code>Initable</code> classes.
60 *
61 * Functionality provided by the broker includes:
62 *
63 * <ul>
64 *
65 * <li>Maintaining a single instance of each <code>Initable</code> in
66 * the system.</li>
67 *
68 * <li>Early initialization of <code>Initables</code> during system
69 * startup.</li>
70 *
71 * <li>Late initialization of <code>Initables</code> before they are
72 * used.</li>
73 *
74 * <li>Providing instances of <code>Initables</code> to requesting
75 * parties.</li>
76 *
77 * <li>Maintainging dependencies between <code>Initables</code> during
78 * early initalization phases, including circular dependencies
79 * detection.</li>
80 *
81 * </ul>
82 *
83 * @author <a href="mailto:burton@apache.org">Kevin Burton</a>
84 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
85 * @version $Id: InitableBroker.java,v 1.1.1.1 2001/08/16 05:08:46 jvanzyl Exp $
86 */
87 public interface InitableBroker
88 {
89 /***
90 * Performs early initialization of an Initable class.
91 *
92 * If your class depends on another Initable being initialized to
93 * perform early initialization, you should always ask your broker
94 * to initialize the other class with the objects that are passed
95 * to you, before you try to retrieve that Initable's instance with
96 * getInitable().
97 *
98 * @param className The name of the class to be initailized.
99 * @param data An object to be used for initialization activities.
100 * @exception InitializationException, if initialization of this
101 * class was not successful.
102 */
103 public void initClass( String className,
104 Object data )
105 throws InitializationException;
106
107 /***
108 * Shutdowns an Initable class.
109 *
110 * This method is used to release resources allocated by an
111 * Initable class, and return it to initial (uninitailized)
112 * state.
113 *
114 * @param className The name of the class to be uninitialized.
115 */
116 public void shutdownClass( String className );
117
118 /***
119 * Provides an instance of Initable class ready to work.
120 *
121 * If the requested class couldn't be instatiated or initialized,
122 * InstantiationException will be thrown. You needn't handle this
123 * exception in your code, since it indicates fatal
124 * misconfigurtion of the system.
125 *
126 * @param className The name of the Initable requested.
127 * @return An instance of requested Initable.
128 * @exception InstantiationException, if there was a problem
129 * during instantiation or initialization of the Initable.
130 */
131 public Initable getInitable( String className )
132 throws InstantiationException;
133 }
This page was automatically generated by Maven