PluginConnectionService.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.portal.service.database;

  35. import fr.paris.lutece.util.pool.PoolManager;

  36. import java.sql.Connection;

  37. /**
  38.  * Class for Plugins connection services.
  39.  */
  40. public class PluginConnectionService
  41. {
  42.     private String _strPoolName;

  43.     /**
  44.      * Creates a new PluginConnectionService object.
  45.      *
  46.      * @param strPoolName
  47.      *            Rhe name of the pool
  48.      */
  49.     public PluginConnectionService( String strPoolName )
  50.     {
  51.         setPool( strPoolName );
  52.     }

  53.     /**
  54.      * Sets the pool to be used by this Connection Service
  55.      *
  56.      * @param strPoolName
  57.      *            The name of the pool
  58.      */
  59.     public final void setPool( String strPoolName )
  60.     {
  61.         _strPoolName = strPoolName;
  62.     }

  63.     /**
  64.      * Returns a connection to database from the pool name
  65.      *
  66.      * @return a connection to database from the pool
  67.      */
  68.     public Connection getConnection( )
  69.     {
  70.         PoolManager poolManager = AppConnectionService.getPoolManager( );
  71.         return poolManager.getConnection( _strPoolName );
  72.     }

  73.     /**
  74.      * Releases a connection and replaces it in the pool
  75.      *
  76.      * @param conn
  77.      *            The connection to realease
  78.      */
  79.     public void freeConnection( Connection conn )
  80.     {
  81.         PoolManager poolManager = AppConnectionService.getPoolManager( );
  82.         poolManager.freeConnection( _strPoolName, conn );
  83.     }

  84.     /**
  85.      * Gets the pool name
  86.      *
  87.      * @return the pool name
  88.      */
  89.     public String getPoolName( )
  90.     {
  91.         return _strPoolName;
  92.     }
  93. }