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 java.sql.Connection; 58 import org.apache.torque.adapter.DB; 59 import org.apache.turbine.services.Service; 60 61 /*** 62 * This service provides database connection pooling to Turbine applications. 63 * 64 * The service can manage a number of connection pools. Each pool is related 65 * to a specific database, identified by it's driver class name, url, username 66 * and password. The pools may be defined in TurbineResources.properties 67 * file, or created at runtime using 68 * {@link #registerPool(String,String,String,String,String)} method. 69 * 70 * <p> You can use {@link #getConnection(String)} to acquire a 71 * {@link org.apache.turbine.util.db.pool.DBConnection} object, which in 72 * turn can be used to create <code>java.sql.Statement</code> objects. 73 * 74 * <p>When you are done using the <code>DBConnection</code> you <strong>must</strong> 75 * return it to the pool using {@link #releaseConnection(DBConnection)} method. 76 * This method call is often placed in <code>finally</code> clause of a <code>try / 77 * catch</code> statement, to ensure that the connection is always returned 78 * to the pool.<br> 79 * 80 * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> 81 * @version $Id: PoolBrokerService.java,v 1.4 2002/07/12 20:46:55 mpoeschl Exp $ 82 * @deprecated use org.apache.torque.Torque 83 */ 84 public interface PoolBrokerService extends Service 85 { 86 /*** the name of the service */ 87 public static final String SERVICE_NAME = "PoolBrokerService"; 88 89 /*** the name of the default pool */ 90 public static final String DEFAULT = "default"; 91 92 /*** Name of default pool property */ 93 public static final String DEFAULT_POOL = "defaultPool"; 94 95 /*** Return default DB */ 96 public String getDefaultDB(); 97 98 /*** 99 * This method returns a DBConnection from the default pool. 100 * 101 * @return The requested connection. 102 * @throws Exception A generic exception. 103 */ 104 public Connection getConnection() throws Exception; 105 106 /*** 107 * This method returns a DBConnection from the pool with the 108 * specified name. 109 * 110 * @param name The name of the pool to get a connection from. 111 * @return The requested connection. 112 * @throws Exception A generic exception. 113 */ 114 public Connection getConnection(String name) throws Exception; 115 116 /*** 117 * Release a connection back to the database pool. 118 * 119 * @throws Exception A generic exception. 120 */ 121 public void releaseConnection(Connection dbconn) throws Exception; 122 123 /*** 124 * Returns the database adapter for the default connection pool. 125 * 126 * @return The database adapter. 127 * @throws Exception A generic exception. 128 */ 129 public DB getDB() throws Exception; 130 131 /*** 132 * Returns database adapter for a specific connection pool. 133 * 134 * @param name A pool name. 135 * @return The corresponding database adapter. 136 * @throws Exception A generic exception. 137 */ 138 public DB getDB(String name) throws Exception; 139 }

This page was automatically generated by Maven