01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.resource.spi;
23:
24: import javax.transaction.xa.XAException;
25: import javax.transaction.xa.Xid;
26:
27: /**
28: * Transaction completion and crash recovery
29: */
30: public interface XATerminator {
31: /**
32: * Commit the transaction
33: *
34: * @param xid the xid
35: * @param onePhase true for one phase commit, false for two phase
36: * @throws XAException for an error
37: */
38: void commit(Xid xid, boolean onePhase) throws XAException;
39:
40: /**
41: * Forget the transaction
42: *
43: * @param xid the xid
44: * @throws XAException for an error
45: */
46: void forget(Xid xid) throws XAException;
47:
48: /**
49: * Prepare the transaction
50: *
51: * @param xid the xid
52: * @return Either XA_RDONLY or XA_OK
53: * @throws XAException for an error
54: */
55: int prepare(Xid xid) throws XAException;
56:
57: /**
58: * Rollback the transaction
59: *
60: * @param xid the xid
61: * @throws XAException for an error
62: */
63: void rollback(Xid xid) throws XAException;
64:
65: /**
66: * Retrieve xids that are recoverable
67: *
68: * @param flag the recovery option
69: * @throws XAException for an error
70: */
71: Xid[] recover(int flag) throws XAException;
72: }
|