View Javadoc

1   package org.apache.turbine.services;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import org.apache.commons.configuration.Configuration;
20  
21  /***
22   * Classes that implement this interface can act as a manager for
23   * <code>Service</code> classes.
24   *
25   * Functionality that <code>ServiceManager</code> provides in addition
26   * to <code>ServiceBroker</code> functionality includes configuration
27   * of the manager.
28   *
29   * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
30   * @author <a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
31   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
32   * @version $Id: ServiceManager.java 264148 2005-08-29 14:21:04Z henning $
33   */
34  public interface ServiceManager extends ServiceBroker
35  {
36      /***
37       * Initialize this service manager.
38       */
39      void init() throws InitializationException;
40  
41      /***
42       * Get the configuration for this service manager.
43       *
44       * @return Manager configuration.
45       */
46      Configuration getConfiguration();
47  
48      /***
49       * Set the configuration object for the services broker.
50       * This is the configuration that contains information
51       * about all services in the care of this service
52       * manager.
53       *
54       * @param configuration Manager configuration.
55       */
56      void setConfiguration(Configuration configuration);
57  
58      /***
59       * Set the application root.
60       *
61       * @param applicationRoot application root
62       */
63      void setApplicationRoot(String applicationRoot);
64  }