View Javadoc
1 package org.apache.turbine.services.db; 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 org.apache.torque.map.DatabaseMap; 58 import org.apache.turbine.services.Service; 59 import org.apache.turbine.util.TurbineException; 60 61 /*** 62 * This service manages {@link org.apache.turbine.util.db.map.DatabaseMap} 63 * objects used throughout a Turbine application. It provides single point 64 * of access to a pool of maps, assuring that every client will access 65 * the same instance of DatabaseMap object. 66 * 67 * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> 68 * @version $Id: MapBrokerService.java,v 1.4 2002/07/12 20:46:55 mpoeschl Exp $ 69 * @deprecated use org.apache.torque.Torque 70 */ 71 public interface MapBrokerService extends Service 72 { 73 public static final String SERVICE_NAME = "MapBrokerService"; 74 75 /*** 76 * Name of the default map builder and map. 77 */ 78 public static final String DEFAULT = "default"; 79 80 /*** Name of default map property */ 81 public static final String DEFAULT_MAP = "defaultMap"; 82 83 /*** Return default map */ 84 public String getDefaultMap(); 85 86 /*** 87 * Returns the default database map information. 88 * 89 * @return A DatabaseMap. 90 * @throws TurbineException Any exceptions caught during procssing will be 91 * rethrown wrapped into a TurbineException. 92 */ 93 public DatabaseMap getDatabaseMap() throws TurbineException; 94 95 /*** 96 * Returns the database map information. Name relates to the name 97 * of the connection pool to associate with the map. 98 * 99 * @param name The name of the <code>DatabaseMap</code> to 100 * retrieve. 101 * @return The named <code>DatabaseMap</code>. 102 * @throws TurbineException Any exceptions caught during procssing will be 103 * rethrown wrapped into a TurbineException. 104 */ 105 public DatabaseMap getDatabaseMap(String name) throws TurbineException; 106 }

This page was automatically generated by Maven