ServiceBroker


1   package org.apache.fulcrum;
2   
3   /* ====================================================================
4    * The Apache Software License, Version 1.1
5    *
6    * Copyright (c) 2001-2002 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.commons.configuration.Configuration;
58  
59  import org.apache.log4j.Category;
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>ServiceBroker</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   * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
82   * @author <a HREF="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
83   * @version $Id: ServiceBroker.java,v 1.1 2004/11/12 10:25:48 epugh Exp $
84   */
85  public interface ServiceBroker
86  {
87      /**
88       * Determines whether a service is registered in the configured
89       * <code>TurbineResources.properties</code>.
90       *
91       * @param serviceName The name of the service whose existance to check.
92       * @return Registration predicate for the desired services.
93       */
94      public boolean isRegistered( String   serviceName );
95  
96      /**
97       * Performs early initialization of the specified service.
98       *
99       * @param name The name of the service.
100      * @param data An Object to use for initialization activities.
101      * @exception InitializationException, if the service is unknown
102      * or can't be initialized.
103      */
104     public void initService( String   name )
105         throws InitializationException;
106 
107     /**
108      * Shutdowns a Service.
109      *
110      * This method is used to release resources allocated by a
111      * Service, and return it to initial (uninitailized) state.
112      *
113      * @param name The name of the Service to be uninitialized.
114      */
115     public void shutdownService( String   name );
116 
117     /**
118      * Shutdowns all Services.
119      *
120      * This method is used to release resources allocated by
121      * Services, and return them to initial (uninitailized) state.
122      */
123     public void shutdownServices( );
124 
125     /**
126      * Returns an instance of requested Service.
127      *
128      * @param name The name of the Service requested.
129      * @return An instance of requested Service.
130      * @exception InstantiationException, if the service is unknown or
131      * can't be initialized.
132      */
133     public Service getService( String   name )
134         throws InstantiationException  ;
135 
136     /**
137      * Returns the configuration of a specific service. Services
138      * use this method to retrieve their configuration.
139      *
140      * @param name The name of the service.
141      * @return Configuration of the requested service.
142      */
143     public Configuration getConfiguration( String   name );
144 
145     /**
146      * Set an object for use in the services.
147      *
148      * @param String key
149      * @param String value
150      */
151     public void setServiceObject(String   key, Object   value);
152 
153     /**
154      * Get service object
155      *
156      * @param String key
157      * @return Object value
158      */
159     public Object   getServiceObject(String   key);
160 
161     /**
162      * Return a path translated to the application root.
163      *
164      * @param String path
165      * @return String translated path
166      */
167     public String   getRealPath(String   path);
168 
169     /**
170      * Get the application root.
171      *
172      * @return String application root
173      */
174     public String   getApplicationRoot();
175 
176     /**
177      * Get default log4j category.
178      *
179      * @return Category default log4j category.
180      */
181     public Category getCategory();
182 }
183
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags