1 package org.apache.turbine.services.factory;
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 import org.apache.turbine.util.TurbineException;
58
59 /***
60 * Factory is an interface for object factories. Object factories
61 * can be registered to the Factory Service to support customized
62 * functionality during instantiation of specific classes that
63 * the service itself cannot provide. Examples include
64 * instantiation of XML parsers and secure sockets requiring
65 * provider specific initializations before instantiation.
66 *
67 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
68 * @version $Id: Factory.java,v 1.1.1.1 2001/08/16 05:08:52 jvanzyl Exp $
69 */
70 public interface Factory
71 {
72 /***
73 * Initializes the factory. This method is called by
74 * the Factory Service before the factory is taken into use.
75 *
76 * @param className the name of the production class
77 * @throws TurbineException if initialization fails.
78 */
79 public void init(String className)
80 throws TurbineException;
81
82 /***
83 * Gets an instance of a class.
84 *
85 * @return the instance.
86 * @throws TurbineException if instantiation fails.
87 */
88 public Object getInstance()
89 throws TurbineException;
90
91 /***
92 * Gets an instance of a class using a specified class loader.
93 *
94 * <p>Class loaders are supported only if the isLoaderSupported
95 * method returns true. Otherwise the loader parameter is ignored.
96 *
97 * @param loader the class loader.
98 * @return the instance.
99 * @throws TurbineException if instantiation fails.
100 */
101 public Object getInstance(ClassLoader loader)
102 throws TurbineException;
103
104 /***
105 * Gets an instance of a named class.
106 * Parameters for its constructor are given as an array of objects,
107 * primitive types must be wrapped with a corresponding class.
108 *
109 * @param params an array containing the parameters of the constructor.
110 * @param signature an array containing the signature of the constructor.
111 * @return the instance.
112 * @throws TurbineException if instantiation fails.
113 */
114 public Object getInstance(Object[] params,
115 String[] signature)
116 throws TurbineException;
117
118 /***
119 * Gets an instance of a named class using a specified class loader.
120 * Parameters for its constructor are given as an array of objects,
121 * primitive types must be wrapped with a corresponding class.
122 *
123 * <p>Class loaders are supported only if the isLoaderSupported
124 * method returns true. Otherwise the loader parameter is ignored.
125 *
126 * @param loader the class loader.
127 * @param params an array containing the parameters of the constructor.
128 * @param signature an array containing the signature of the constructor.
129 * @return the instance.
130 * @throws TurbineException if instantiation fails.
131 */
132 public Object getInstance(ClassLoader loader,
133 Object[] params,
134 String[] signature)
135 throws TurbineException;
136
137 /***
138 * Tests if this object factory supports specified class loaders.
139 *
140 * @return true if class loaders are supported, false otherwise.
141 */
142 public boolean isLoaderSupported();
143 }
This page was automatically generated by Maven