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 * <code>Services</code> are <code>Initables</code> that have a name,
63 * and a set of properties.
64 *
65 * @author <a href="mailto:greg@shwoop.com">Greg Ritter</a>
66 * @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
67 * @author <a href="mailto:burton@apache.org">Kevin Burton</a>
68 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
69 * @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
70 * @version $Id: Service.java,v 1.3 2002/04/16 22:07:07 kschrader Exp $
71 */
72 public interface Service
73 extends Initable
74 {
75 /*** The name of this service. */
76 public static final String SERVICE_NAME = "Service";
77
78 /***
79 * Provides a Service with a reference to the ServiceBroker that
80 * instantiated this object, so that it can ask for its properties
81 * and access other Services.
82 *
83 * @param broker The ServiceBroker that instantiated this object.
84 */
85 public void setServiceBroker( ServiceBroker broker );
86
87 /***
88 * ServiceBroker uses this method to pass a Service its name.
89 * Service uses its name to ask the broker for an apropriate set
90 * of Properties.
91 *
92 * @param name The name of this Service.
93 */
94 public void setName( String name );
95
96 /***
97 * Returns the name of this Service.
98 *
99 * @return The name of this Service.
100 */
101 public String getName();
102
103 /***
104 * Returns the Properties of this Service. Every Service has at
105 * least one property, which is "classname", containing the name
106 * of the class implementing this service. Note that the service
107 * may chose to alter its properties, therefore they may be
108 * different from those returned by ServiceBroker.
109 *
110 * @return The properties of this Service.
111 */
112 public Properties getProperties();
113
114 /***
115 * Returns the Configuration of this Service. Every Service has at
116 * least one property, which is "classname", containing the name
117 * of the class implementing this service. Note that the service
118 * may chose to alter its configuration, therefore they may be
119 * different from those returned by ServiceBroker.
120 *
121 * @return The Configuration of this Service.
122 */
123 public Configuration getConfiguration();
124 }
This page was automatically generated by Maven