View Javadoc
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  
36  import org.apache.commons.lang3.StringUtils;
37  import org.springframework.transaction.PlatformTransactionManager;
38  import org.springframework.transaction.TransactionDefinition;
39  import org.springframework.transaction.TransactionStatus;
40  import org.springframework.transaction.support.DefaultTransactionStatus;
41  
42  import fr.paris.lutece.portal.service.plugin.Plugin;
43  import fr.paris.lutece.portal.service.plugin.PluginService;
44  import fr.paris.lutece.util.sql.TransactionManager;
45  
46  /**
47   * Lutece transaction manager. This TM use Lutece's specific pool transaction manager with the class {@link TransactionManager}. It allow plugins to use multi
48   * plugin transactions, and nested transactions. Note that nested transactions does not create savepoints : if a nested transaction is roll backed, then the
49   * whole transaction is roll backed.
50   */
51  public class LuteceTransactionManager implements PlatformTransactionManager
52  {
53      private String _strPluginName;
54      private Plugin _plugin;
55  
56      /**
57       * Gets the plugin name
58       * 
59       * @return the plugin name
60       */
61      public String getPluginName( )
62      {
63          return _strPluginName;
64      }
65  
66      /**
67       * Sets the plugin name
68       * 
69       * @param strPluginName
70       *            the plugin name
71       */
72      public void setPluginName( String strPluginName )
73      {
74          _strPluginName = strPluginName;
75      }
76  
77      /**
78       * {@inheritDoc}
79       */
80      @Override
81      public TransactionStatus getTransaction( TransactionDefinition definition )
82      {
83          TransactionStatus trStatus = new DefaultTransactionStatus( null, true, false, false, false, null );
84          TransactionManager.beginTransaction( getPlugin( ) );
85  
86          return trStatus;
87      }
88  
89      /**
90       * {@inheritDoc}
91       */
92      @Override
93      public void commit( TransactionStatus status )
94      {
95          TransactionManager.commitTransaction( getPlugin( ) );
96      }
97  
98      /**
99       * {@inheritDoc}
100      */
101     @Override
102     public void rollback( TransactionStatus status )
103     {
104         TransactionManager.rollBack( getPlugin( ) );
105     }
106 
107     private synchronized Plugin getPlugin( )
108     {
109         if ( _plugin == null )
110         {
111             if ( StringUtils.isNotBlank( _strPluginName ) )
112             {
113                 _plugin = PluginService.getPlugin( _strPluginName );
114             }
115             else
116             {
117                 _plugin = PluginService.getCore( );
118             }
119         }
120 
121         return _plugin;
122     }
123 }