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 * This class is a generic implementation of <code>Service</code>. 62 * 63 * @author <a href="mailto:burton@apache.org">Kevin Burton</a> 64 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a> 65 * @version $Id: BaseService.java,v 1.3 2002/04/16 22:07:07 kschrader Exp $ 66 */ 67 public class BaseService 68 extends BaseInitable 69 implements Service 70 { 71 /*** A reference to the ServiceBroker that instantiated this object. */ 72 protected ServiceBroker serviceBroker; 73 74 /*** The properties of this service. */ 75 protected Properties properties; 76 77 /*** The configuration for this service */ 78 protected Configuration configuration; 79 80 /*** The name of this Service. */ 81 protected String name; 82 83 /*** 84 * Saves a reference to the ServiceBroker that instantiated this 85 * object, so that it can ask for its properties and access other 86 * Services. 87 * 88 * @param broker The ServiceBroker that instantiated this object. 89 */ 90 public void setServiceBroker( ServiceBroker broker ) 91 { 92 this.serviceBroker = broker; 93 } 94 95 /*** 96 * ServiceBroker uses this method to pass a Service its name. 97 * 98 * @param name The name of this Service. 99 */ 100 public void setName( String name ) 101 { 102 this.name = name; 103 } 104 105 /*** 106 * Returns the name of this service. 107 * 108 * @return The name of this Service. 109 */ 110 public String getName() 111 { 112 return name; 113 } 114 115 /*** 116 * Returns a ServiceBroker reference. 117 * 118 * @return The ServiceBroker that instantiated this object. 119 */ 120 public ServiceBroker getServiceBroker() 121 { 122 return serviceBroker; 123 } 124 125 /*** 126 * Returns the properties of this Service. 127 * 128 * @return The Properties of this Service. 129 */ 130 public Properties getProperties() 131 { 132 if (name == null) 133 { 134 return null; 135 } 136 137 if (properties == null) 138 { 139 properties = getServiceBroker().getProperties(name); 140 } 141 return properties; 142 } 143 144 /*** 145 * Returns the configuration of this Service. 146 * 147 * @return The Configuration of this Service. 148 */ 149 public Configuration getConfiguration() 150 { 151 if (name == null) 152 { 153 return null; 154 } 155 156 if (configuration == null) 157 { 158 configuration = getServiceBroker().getConfiguration(name); 159 } 160 return configuration; 161 } 162 }

This page was automatically generated by Maven