1 /*

     2  * Copyright (c)  2017, 2018, 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 package jdk.incubator.sql2;

    26 

    27 /**

    28  * A mutable object that controls whether a transactionCompletion Operation sends

    29  * a database commit or a database rollback to the server. A transactionCompletion

    30  * Operation is created with a TransactionCompletion. By default a transactionCompletion

    31  * Operation requests that the database end the transaction with a commit.

    32  * If {@link TransactionCompletion#setRollbackOnly} is called on the TransactionCompletion used to create

    33  the Operation prior to the Operation being executed, the Operation will

    34  request that the database end the transaction with a rollback.

    35  

    36  Example:

    37 

    38  <pre>

    39  * {@code

    40    TransactionCompletion t = session.transactionCompletion();

    41    session.countOperation(updateSql)

    42        .resultProcessor( count -> { if (count > 1) t.setRollbackOnly(); } )

    43        .submit();

    44    session.commitMaybeRollback(t);

    45  }</pre>

    46 

    47  A TransactionCompletion can not be used to create more than one endTransaction 

    48  Operation.

    49  

    50  A TransactionCompletion is thread safe.

    51  

    52  ISSUE: The name is terrible. Please suggest a better alternative, TransactionLatch?

    53  */

    54 public interface TransactionCompletion {

    55 

    56   /**

    57    * Causes an endTransactionOperation created with this TransactionCompletion that is executed

    58    * subsequent to this call to perform a rollback. If this method is not called

    59    * prior to Operation execution the Operation will perform a commit.

    60    *

    61    * @return true if the call succeeded. False if the call did not succeed in

    62  setting the TransactionCompletion rollback only because the endTransaction

    63  Operation had already been executed.

    64    */

    65   public boolean setRollbackOnly();

    66 

    67   /**

    68    * Returns {@code true} iff the {@link setRollbackOnly} method has been called

    69  on this TransactionCompletion

    70    *

    71    * @return {@code true} if {@link setRollbackOnly} has been called.

    72    */

    73   public boolean isRollbackOnly();

    74 

    75 }