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.util.sql;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import org.apache.commons.lang.NotImplementedException;
39
40 import java.sql.PreparedStatement;
41 import java.sql.SQLException;
42
43
44 /**
45 * Class to represents transactions that are shared between plugins. Such
46 * transactions will be shared by each plugin using the same pool than the one
47 * that created the transaction.
48 */
49 public class MultiPluginTransaction extends Transaction
50 {
51 private int _nNbTransactionsOpened;
52
53 /**
54 * Constructor
55 */
56 public MultiPluginTransaction( )
57 {
58 super( );
59 _nNbTransactionsOpened = 1;
60 }
61
62 /**
63 * Constructor
64 * @param plugin The plugin owner of the transaction
65 */
66 public MultiPluginTransaction( Plugin plugin )
67 {
68 super( plugin );
69 _nNbTransactionsOpened = 1;
70 }
71
72 /**
73 * Get the number of transactions that plugins tried to open simultaneously
74 * on the same pool. If the number if 1, then the transaction can be safely
75 * committed. If it is more than 1, then this number should be decremented
76 * and the transaction should not be committed.
77 * @return The number of transactions that was required
78 */
79 public int getNbTransactionsOpened( )
80 {
81 return _nNbTransactionsOpened;
82 }
83
84 /**
85 * Increment the number of transactions by one. See
86 * {@link #getNbTransactionsOpened()} for more details.
87 */
88 public void incrementNbTransactionsOpened( )
89 {
90 _nNbTransactionsOpened++;
91 }
92
93 /**
94 * Decrement the number of transactions by one. See
95 * {@link #getNbTransactionsOpened()} for more details.
96 */
97 public void decrementNbTransactionsOpened( )
98 {
99 _nNbTransactionsOpened--;
100 }
101
102 /**
103 * {@inheritDoc}
104 */
105 @Override
106 public PreparedStatement prepareStatement( String strSQL )
107 throws SQLException
108 {
109 // Get a new statement
110 if ( getConnection( ) == null )
111 {
112 throw new SQLException(
113 "MultiPluginTransaction - Connection has been closed. The new prepared statement can not be created : " +
114 strSQL );
115 }
116
117 return getConnection( ).prepareStatement( strSQL );
118 }
119
120 /**
121 * {@inheritDoc}
122 */
123 @Override
124 public void executeStatement( ) throws SQLException
125 {
126 throw new NotImplementedException(
127 "The method executeStatement( ) of class MultiPluginTransaction must not be called. Use manually PreparedStatement.executeQuery() instead." );
128 }
129
130 /**
131 * {@inheritDoc}
132 */
133 @Override
134 public void commit( )
135 {
136 _nNbTransactionsOpened = 0;
137 super.commit( );
138 }
139
140 /**
141 * {@inheritDoc}
142 */
143 @Override
144 public void rollback( Exception e )
145 {
146 _nNbTransactionsOpened = 0;
147 super.rollback( e );
148 }
149 }