1 /*
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.sql.rowset.spi;
27
28 import java.sql.SQLException;
29 import java.io.Reader;
30
31 import javax.sql.RowSetWriter;
32 import javax.sql.rowset.*;
33 import java.sql.Savepoint;
34
35 /**
36 * A specialized interface that facilitates an extension of the standard
37 * <code>SyncProvider</code> abstract class so that it has finer grained
38 * transaction control.
39 * <p>
40 * If one or more disconnected <code>RowSet</code> objects are participating
41 * in a global transaction, they may wish to coordinate their synchronization
42 * commits to preserve data integrity and reduce the number of
43 * synchronization exceptions. If this is the case, an application should set
44 * the <code>CachedRowSet</code> constant <code>COMMIT_ON_ACCEPT_CHANGES</code>
45 * to <code>false</code> and use the <code>commit</code> and <code>rollback</code>
46 * methods defined in this interface to manage transaction boundaries.
47 */
48 public interface TransactionalWriter extends RowSetWriter {
49
50 /**
51 * Makes permanent all changes that have been performed by the
52 * <code>acceptChanges</code> method since the last call to either the
53 * <code>commit</code> or <code>rollback</code> methods.
54 * This method should be used only when auto-commit mode has been disabled.
55 *
56 * @throws SQLException if a database access error occurs or the
57 * <code>Connection</code> object within this <code>CachedRowSet</code>
58 * object is in auto-commit mode
59 */
60 public void commit() throws SQLException;
61
62 /**
63 * Undoes all changes made in the current transaction. This method should be
64 * used only when auto-commit mode has been disabled.
65 *
66 * @throws SQLException if a database access error occurs or the <code>Connection</code>
67 * object within this <code>CachedRowSet</code> object is in auto-commit mode
68 */
69 public void rollback() throws SQLException;
70
71 /**
72 * Undoes all changes made in the current transaction made prior to the given
73 * <code>Savepoint</code> object. This method should be used only when auto-commit
74 * mode has been disabled.
75 *
76 * @param s a <code>Savepoint</code> object marking a savepoint in the current
77 * transaction. All changes made before <i>s</i> was set will be undone.
78 * All changes made after <i>s</i> was set will be made permanent.
79 * @throws SQLException if a database access error occurs or the <code>Connection</code>
80 * object within this <code>CachedRowSet</code> object is in auto-commit mode
81 */
82 public void rollback(Savepoint s) throws SQLException;
83 }