View Javadoc
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 import org.apache.turbine.services.Service; 59 60 /*** 61 * The Factory Service instantiates objects using either default 62 * class loaders or a specified one. Whether specified class 63 * loaders are supported for a class depends on implementation 64 * and can be tested with the isLoaderSupported method. 65 * 66 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a> 67 * @version $Id: FactoryService.java,v 1.1.1.1 2001/08/16 05:08:52 jvanzyl Exp $ 68 */ 69 public interface FactoryService extends Service 70 { 71 /*** 72 * The key under which this service is stored in TurbineServices. 73 */ 74 public static final String SERVICE_NAME = "FactoryService"; 75 76 /*** 77 * Gets an instance of a named class. 78 * 79 * @param className the name of the class. 80 * @return the instance. 81 * @throws TurbineException if instantiation fails. 82 */ 83 public Object getInstance(String className) 84 throws TurbineException; 85 86 /*** 87 * Gets an instance of a named class using a specified class loader. 88 * 89 * <p>Class loaders are supported only if the isLoaderSupported 90 * method returns true. Otherwise the loader parameter is ignored. 91 * 92 * @param className the name of the class. 93 * @param loader the class loader. 94 * @return the instance. 95 * @throws TurbineException if instantiation fails. 96 */ 97 public Object getInstance(String className, 98 ClassLoader loader) 99 throws TurbineException; 100 101 /*** 102 * Gets an instance of a named class. 103 * Parameters for its constructor are given as an array of objects, 104 * primitive types must be wrapped with a corresponding class. 105 * 106 * @param className the name of the class. 107 * @param params an array containing the parameters of the constructor. 108 * @param signature an array containing the signature of the constructor. 109 * @return the instance. 110 * @throws TurbineException if instantiation fails. 111 */ 112 public Object getInstance(String className, 113 Object[] params, 114 String[] signature) 115 throws TurbineException; 116 117 /*** 118 * Gets an instance of a named class using a specified class loader. 119 * Parameters for its constructor are given as an array of objects, 120 * primitive types must be wrapped with a corresponding class. 121 * 122 * <p>Class loaders are supported only if the isLoaderSupported 123 * method returns true. Otherwise the loader parameter is ignored. 124 * 125 * @param className the name of the class. 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(String className, 133 ClassLoader loader, 134 Object[] params, 135 String[] signature) 136 throws TurbineException; 137 138 /*** 139 * Tests if specified class loaders are supported for a named class. 140 * 141 * @param className the name of the class. 142 * @return true if class loaders are supported, false otherwise. 143 * @throws TurbineException if test fails. 144 */ 145 public boolean isLoaderSupported(String className) 146 throws TurbineException; 147 }

This page was automatically generated by Maven