offapi/com/sun/star/sdbc/ConnectionPool.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ConnectionPool.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_ConnectionPool_idl__
  31 #define __com_sun_star_sdbc_ConnectionPool_idl__
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35  published interface XDriverManager;
  36
  37
  38 /** is the basic service for pooling SDBC connections.
  39
  40     <p>
  41     When the method
  42     <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
  43     is called,
  44     the ConnectionPool will attempt to locate a suitable pooled connection
  45     or create a new connection from the DriverManager. When the connection
  46     will be released it will move to the pool of unused connections.
  47
  48     </p>
  49     @see com::sun::star::sdbc::XDriver
  50     @see com::sun::star::sdbc::XConnection
  51  */
  52 published service ConnectionPool: XDriverManager;
  53
  54 //=============================================================================
  55
  56 }; }; }; };
  57
  58
  59 #endif
  60