View Javadoc

1   package org.apache.turbine.services.assemblerbroker;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.turbine.modules.Assembler;
23  import org.apache.turbine.services.TurbineServices;
24  import org.apache.turbine.services.assemblerbroker.util.AssemblerFactory;
25  import org.apache.turbine.util.TurbineException;
26  
27  /***
28   * An interface the Turbine Assembler service.
29   * See TurbineAssemblerBrokerService for more info.
30   *
31   * @author <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a>
32   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
33   * @version $Id: TurbineAssemblerBroker.java 534527 2007-05-02 16:10:59Z tv $
34   */
35  public abstract class TurbineAssemblerBroker
36  {
37      /***
38       * Utility method for accessing the service
39       * implementation
40       *
41       * @return An AssemblerBroker implementation instance
42       */
43      public static AssemblerBrokerService getService()
44      {
45          return (AssemblerBrokerService) TurbineServices.getInstance()
46              .getService(AssemblerBrokerService.SERVICE_NAME);
47      }
48  
49      /***
50       * Register a new Assembler factory with this service.
51       *
52       * @param type The type of Assembler Factory
53       * @param factory The actual Factory Object
54       */
55      public static void registerFactory(String type, AssemblerFactory factory)
56      {
57          getService().registerFactory(type, factory);
58      }
59  
60      /***
61       * Return an Assembler for a given type and object name.
62       *
63       * @param type The Type of Assember we want
64       * @param name The name of the Assembler
65       *
66       * @return An Assembler Object.
67       *
68       * @throws TurbineException If a problem locating the Assember occured.
69       */
70      public static Assembler getAssembler(String type, String name)
71          throws TurbineException
72      {
73          return getService().getAssembler(type, name);
74      }
75  }