View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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  
36  import fr.paris.lutece.util.pool.PoolManager;
37  
38  import java.sql.Connection;
39  
40  
41  /**
42   * Class for Plugins connection services.
43   */
44  public class PluginConnectionService
45  {
46      private String _strPoolName;
47  
48      /**
49       * Creates a new PluginConnectionService object.
50       *
51       * @param strPoolName Rhe name of the pool
52       */
53      public PluginConnectionService( String strPoolName )
54      {
55          setPool( strPoolName );
56      }
57  
58      /**
59       * Sets the pool to be used by this Connection Service
60       *
61       * @param strPoolName The name of the pool
62       */
63      public final void setPool( String strPoolName )
64      {
65          _strPoolName = strPoolName;
66      }
67  
68      /**
69       * Returns a connection to database from the pool name
70       *
71       * @return a connection to database from the pool
72       */
73      public Connection getConnection(  )
74      {
75          PoolManager poolManager = AppConnectionService.getPoolManager(  );
76          Connection conn = poolManager.getConnection( _strPoolName );
77  
78          return conn;
79      }
80  
81      /**
82       * Releases a connection and replaces it in the pool
83       *
84       * @param conn The connection to realease
85       */
86      public void freeConnection( Connection conn )
87      {
88          PoolManager poolManager = AppConnectionService.getPoolManager(  );
89          poolManager.freeConnection( _strPoolName, conn );
90      }
91  
92      /**
93       * Gets the pool name
94       * @return the pool name
95       */
96      public String getPoolName(  )
97      {
98          return _strPoolName;
99      }
100 }