How to enlist a custom XAResouce in the spring and start the recovery manager service

[zhfeng]

Hi,

I currently use the following codes to enlist the custom XAResouce explictly

   
@Service
public class ExampleService {

    private JdbcTemplate jdbc;

    @Autowired
    private JtaTransactionManager transactionManager;

    @Autowired
    public ExampleService(JdbcTemplate jdbc) {
        this.jdbc = jdbc;
    }

    @Transactional
    public void testRecovery() throws Exception {
        Transaction transaction  = transactionManager.getTransactionManager().getTransaction();
        transaction.enlistResource(new DummyXAResource(DummyXAResource.faultType.HALT));
        jdbc.execute("insert into example values (1, 'test1')");
    }
}

I wonder that is there the way to inject the bean of DummyXAResouce and the spring can enlist it in the method with the annotation of Transactional automatically ?

in term of starting the recovery manager service, it looks like the spring does not provide the way to integrate the recovery manager. So it need to setup and run the scanning manually in the application.

I borrow some codes from the ArjunaJTA/recovery and it should work.

    if(args.length == 1) {
            if (args[0].equals("-f")) {
                BeanPopulator.getDefaultInstance(ObjectStoreEnvironmentBean.class).setObjectStoreDir(Util.recoveryStoreDir);
                service.testRecovery();
            } else if (args[0].equals("-r")) {
                RecoverySetup.startRecovery();
                try {
                    new DummyRecovery().waitForRecovery();
                    service.checkRecord();
                } catch (RuntimeException e) {
                    System.err.println(e);
                }
                RecoverySetup.stopRecovery();
            }
        }

Thanks for the input,

Amos

[tomjenkinson]

Amos Feng wrote:

Hi,

I currently use the following codes to enlist the custom XAResouce explictly

1.     
2. @Service 
3. public class ExampleService { 
4.  
5.     private JdbcTemplate jdbc; 
6.  
7.     @Autowired 
8.     private JtaTransactionManager transactionManager; 
9.  
10.     @Autowired 
11.     public ExampleService(JdbcTemplate jdbc) { 
12.         this.jdbc = jdbc; 
13.     } 
14.  
15.     @Transactional 
16.     public void testRecovery() throws Exception { 
17.         Transaction transaction  = transactionManager.getTransactionManager().getTransaction(); 
18.         transaction.enlistResource(new DummyXAResource(DummyXAResource.faultType.HALT)); 
19.         jdbc.execute("insert into example values (1, 'test1')"); 
20.     } 
21. } 

I wonder that is there the way to inject the bean of DummyXAResouce and the spring can enlist it in the method with the annotation of Transactional automatically ?

I don't think there is a problem with doing that for a dummy XAResource.

[tomjenkinson]

Amos Feng wrote:

in term of starting the recovery manager service, it looks like the spring does not provide the way to integrate the recovery manager. So it need to setup and run the scanning manually in the application.

I borrow some codes from the ArjunaJTA/recovery and it should work.

1.     if(args.length == 1) { 
2.             if (args[0].equals("-f")) { 
3.                 BeanPopulator.getDefaultInstance(ObjectStoreEnvironmentBean.class).setObjectStoreDir(Util.recoveryStoreDir); 
4.                 service.testRecovery(); 
5.             } else if (args[0].equals("-r")) { 
6.                 RecoverySetup.startRecovery(); 
7.                 try { 
8.                     new DummyRecovery().waitForRecovery(); 
9.                     service.checkRecord(); 
10.                 } catch (RuntimeException e) { 
11.                     System.err.println(e); 
12.                 } 
13.                 RecoverySetup.stopRecovery(); 
14.             } 
15.         } 

Thanks for the input,

Amos

This is the more interesting topic.

@gytis did some work as part of JBTM-2470 to allow the recovery manager to start up when the transaction server does [JBTM-2470] Start embedded RM if -recovery is passed to transaction s… · jbosstm/narayana@37b096f · GitHub

You could do something similar - RecoveryManager.manager().startRecoveryManagerThread()

The real question you need to answer is what is the best way to pass generic resources to the recovery manager. In WildFly we add XAResources via narayana/RecoveryManagerService.java at master · jbosstm/narayana · GitHub where the XAResourceRecovery is established by JCA or proprietary code in the resource adapter. What is the way that existing Spring compliant transaction managers (e.g. Atomikos or Bitronix) are passed these references? It could be they are passed an XAResource for recovery or something that has that anyway.

[tomjenkinson]

gytis - sorry my tags didn't work hopefully you see my response above with suggestions about how to investigate passing in XAResources to the recovery manager.

[mmusgrov]

You could take a look at what I did in ceylon (basically I used XARecoveryModule#addXAResourceRecoveryHelper and RecoveryManager#manger()):

ceylon-sdk/ConcreteRecoveryManager.ceylon at master · ceylon/ceylon-sdk · GitHub

and

ceylon-sdk/ConcreteRecoveryManager.ceylon at master · ceylon/ceylon-sdk · GitHub

[tomjenkinson]

Yep looks good too.

The real question is how to get hold of the XADataSource in ceylon-sdk/ConcreteRecoveryManager.ceylon at master · ceylon/ceylon-sdk · GitHub i.e. who calls registerXAResourceRecoveryDataSource and can we make them do it with JMS connections etc too. I think making the app do it is not ideal.

We could just configure classnames and credentials in the spring beans config to load up an XADataSource XAConnectionFactory and pass it into a new Spring Narayana recovery bean which can call the equivalent of registerXAResourceRecoveryDataSource for us with the spring initialized XADS or whatever.

[zhfeng]

It looks like the Atomiks wrapper the XADataSource and XAConnectionFactory to register for recovery

http://www.atomikos.com/Documentation/SpringIntegration#With_the_Atomikos_MessageDrivenContainercom.atomikos.jdbc.AtomikosDataSourceBean

<bean id="xaFactory" 
              class="org.apache.activemq.ActiveMQXAConnectionFactory">
      <property name="brokerURL" value="tcp://localhost:61616" />
   </bean>

   <!-- 
             Configure the JMS connector; 
             call init to register for recovery! 
        -->
   <bean id="ConnectionFactory" 
              class="com.atomikos.jms.AtomikosConnectionFactoryBean" 
              init-method="init" destroy-method="close">
      <property name="uniqueResourceName" value="amq1" />
      <property name="xaConnectionFactory" ref="xaFactory" />
   </bean>

<bean id="dataSource" class="com.atomikos.jdbc.AtomikosDataSourceBean"
init-method="init" destroy-method="close">
<property name="uniqueResourceName" value="XA1DBMS" />
<property name="xaDataSource" ref="db1" />
<property name="poolSize" value="3" />
</bean>

<bean id="db1" class="com.mysql.jdbc.jdbc2.optional.MysqlXADataSource"
lazy-init="true">
<property name="pinGlobalTxToPhysicalConnection" value="true" />
<property name="user" value="root" />
<property name="password" value="pass" />
<property name="url" value="jdbc:mysql://localhost:3306/users" />
</bean>

The wrapper class is "com.atomikos.jms.AtomikosConnectionFactoryBean" and "com.atomikos.jdbc.AtomikosDataSourceBean"

I think Bitronix does the similar things.

[zhfeng]

The property "uniqueResouceName"  should be used to recovery.

[tomjenkinson]

Great - I think we should do something equivalent then. When setXaConnectionFactory is called on our bean we can pass it to the XARecoveryModule for scanning.

Please can you prototype this and share your branch on the thread? Unless you feel that is not the correct approach?

gytis - do you agree with that approach and can something similar be done in Spring boot or have you tried something like this already?

[gytis]

Yes that makes sense. I have not tried anything related to recovery so far. But I am in the process of implementing equivalent beans to AtomikosConnectionFactoryBean and AtomikosDataSourceBean.

[gytis]

Currently I'm implementing them in order to enlist JDBC and JMS resources to the transaction, but later I have been planning to extend them to add recovery too.

However, currently they are in Spring Boot repository. If we need them for general Spring integration too, I'll have to move them to our source code.

[zhfeng]

I think we should move them to our source code as the general spring integration need them too. It has to use the TransactionalDriver currently.

[zhfeng]

It looks like there is a  bean in the spring-boot extends AtomikosConnectionFactoryBean

spring-boot/AtomikosConnectionFactoryBean.java at master · spring-projects/spring-boot · GitHub

[gytis]

I know, but since we have to implement it from scratch I've put the code in spring-boot repo. But it's not a problem to move it out.

[tomjenkinson]

Did you make a decision on where to put this class. Putting as much as we can in our repo will be easier to maintain.