LuteceTransactionManager.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 org.apache.commons.lang3.StringUtils;
  36. import org.springframework.transaction.PlatformTransactionManager;
  37. import org.springframework.transaction.TransactionDefinition;
  38. import org.springframework.transaction.TransactionStatus;
  39. import org.springframework.transaction.support.DefaultTransactionStatus;

  40. import fr.paris.lutece.portal.service.plugin.Plugin;
  41. import fr.paris.lutece.portal.service.plugin.PluginService;
  42. import fr.paris.lutece.util.sql.TransactionManager;

  43. /**
  44.  * Lutece transaction manager. This TM use Lutece's specific pool transaction manager with the class {@link TransactionManager}. It allow plugins to use multi
  45.  * plugin transactions, and nested transactions. Note that nested transactions does not create savepoints : if a nested transaction is roll backed, then the
  46.  * whole transaction is roll backed.
  47.  */
  48. public class LuteceTransactionManager implements PlatformTransactionManager
  49. {
  50.     private String _strPluginName;
  51.     private Plugin _plugin;

  52.     /**
  53.      * Gets the plugin name
  54.      *
  55.      * @return the plugin name
  56.      */
  57.     public String getPluginName( )
  58.     {
  59.         return _strPluginName;
  60.     }

  61.     /**
  62.      * Sets the plugin name
  63.      *
  64.      * @param strPluginName
  65.      *            the plugin name
  66.      */
  67.     public void setPluginName( String strPluginName )
  68.     {
  69.         _strPluginName = strPluginName;
  70.     }

  71.     /**
  72.      * {@inheritDoc}
  73.      */
  74.     @Override
  75.     public TransactionStatus getTransaction( TransactionDefinition definition )
  76.     {
  77.         TransactionStatus trStatus = new DefaultTransactionStatus( null, true, false, false, false, null );
  78.         TransactionManager.beginTransaction( getPlugin( ) );

  79.         return trStatus;
  80.     }

  81.     /**
  82.      * {@inheritDoc}
  83.      */
  84.     @Override
  85.     public void commit( TransactionStatus status )
  86.     {
  87.         TransactionManager.commitTransaction( getPlugin( ) );
  88.     }

  89.     /**
  90.      * {@inheritDoc}
  91.      */
  92.     @Override
  93.     public void rollback( TransactionStatus status )
  94.     {
  95.         TransactionManager.rollBack( getPlugin( ) );
  96.     }

  97.     private synchronized Plugin getPlugin( )
  98.     {
  99.         if ( _plugin == null )
  100.         {
  101.             if ( StringUtils.isNotBlank( _strPluginName ) )
  102.             {
  103.                 _plugin = PluginService.getPlugin( _strPluginName );
  104.             }
  105.             else
  106.             {
  107.                 _plugin = PluginService.getCore( );
  108.             }
  109.         }

  110.         return _plugin;
  111.     }
  112. }