com.speedment.runtime.core.component.transaction.Transaction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.runtime.core.component.transaction;

import com.speedment.runtime.core.exception.TransactionException;

/**
 *
 * @author Per Minborg
 * @since 3.0.17
 */
public interface Transaction {

    /**
     * Makes all changes made since the previous commit/rollback permanent and
     * releases any transaction domain locks currently affected by this
     * Transaction object.
     *
     * @throws TransactionException if an exception is thrown by the underlying
     * transaction aware object (e.g. an SqlException is thrown)
     */
    void commit() throws TransactionException;

    /**
     * Undoes all changes made in the current transaction and releases any
     * transaction domain locks currently affected by this
     * Transaction object.
     *
     * @throws TransactionException if an exception is thrown by the underlying
     * transaction aware object (e.g. an SqlException is thrown)
     */
    void rollback() throws TransactionException;

    /**
     * Attaches the current thread to this Transaction.
     * 
     * After this call, data operations executed by the current thread will be
     * issued within this transaction's scope.
     * 

     * NB: Not all databases support transaction operations carried out by by a
     * plurality of threads.
     *
     * @throws IllegalStateException if the current thread is already associated
     * with another Transaction within any transaction domain.
     */
    void attachCurrentThread();

    /**
     * Detaches the current thread from this Transaction. If the current thread
     * is not attached to this Transaction, then this method is a no-operation.
     * 
     * After this call, data operations executed by the current thread will be
     * issued separated from this transaction's scope.
     */
    void detachCurrentThread();
    
//    /**
//     * Closes this transaction, rolling back any uncommitted updates, detatching
//     * all attached threads and relinquishing any underlying resources.
//     */
//    void close();
}