View Javadoc
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 import java.util.Properties; 58 import org.apache.commons.configuration.Configuration; 59 60 61 /*** 62 * Classes that implement this interface can act as a broker for 63 * <code>Service</code> classes. 64 * 65 * Functionality that <code>ServiceBroker</code> provides in addition 66 * to <code>InitableBroker</code> functionality includes: 67 * 68 * <ul> 69 * 70 * <li>Maintaining service name to class name mapping, allowing 71 * plugable service implementations.</li> 72 * 73 * <li>Providing <code>Services</code> with <code>Properties</code> 74 * based on a system wide configuration mechanism.</li> 75 * 76 * </ul> 77 * 78 * @author <a href="mailto:burton@apache.org">Kevin Burton</a> 79 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a> 80 * @author <a href="mailto:dlr@collab.net">Daniel Rall</a> 81 * @version $Id: ServiceBroker.java,v 1.3 2002/04/16 22:07:07 kschrader Exp $ 82 */ 83 public interface ServiceBroker 84 extends InitableBroker 85 { 86 /*** 87 * Determines whether a service is registered in the configured 88 * <code>TurbineResources.properties</code>. 89 * 90 * @param serviceName The name of the service whose existance to check. 91 * @return Registration predicate for the desired services. 92 */ 93 public boolean isRegistered( String serviceName ); 94 95 /*** 96 * Performs early initialization of specified service. 97 * 98 * @param name The name of the service. 99 * @param data An Object to use for initialization activities. 100 * @exception InitializationException, if the service is unknown 101 * or can't be initialized. 102 */ 103 public void initService( String name, 104 Object data ) 105 throws InitializationException; 106 107 /*** 108 * Performs early initialization of all services. 109 * 110 * @param data An Object to use for initialization activities. 111 */ 112 public void initServices( Object data ); 113 114 /*** 115 * Shutdowns a Service. 116 * 117 * This method is used to release resources allocated by a 118 * Service, and return it to initial (uninitailized) state. 119 * 120 * @param name The name of the Service to be uninitialized. 121 */ 122 public void shutdownService( String name ); 123 124 /*** 125 * Shutdowns all Services. 126 * 127 * This method is used to release resources allocated by 128 * Services, and return them to initial (uninitailized) state. 129 */ 130 public void shutdownServices( ); 131 132 133 /*** 134 * Returns an instance of requested Service. 135 * 136 * @param name The name of the Service requested. 137 * @return An instance of requested Service. 138 * @exception InstantiationException, if the service is unknown or 139 * can't be initialized. 140 */ 141 public Service getService( String name ) 142 throws InstantiationException; 143 144 /*** 145 * Returns the properites of a specific service. Services use 146 * this method to retrieve their properties. 147 * 148 * @param name The name of the service. 149 * @return Properties of requested Service. 150 */ 151 public Properties getProperties( String name ); 152 153 /*** 154 * Returns the configuration of a specific service. Services 155 * use this method to retrieve their configuration. 156 * 157 * @param name The name of the service. 158 * @return Configuration of the requested service. 159 */ 160 public Configuration getConfiguration( String name ); 161 }

This page was automatically generated by Maven