org.skife.jdbi.v2.Transaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdbi Show documentation

jDBI is designed to provide convenient tabular data access in Java(tm). It uses the Java collections framework for query results, provides a convenient means of externalizing sql statements, and provides named parameter support for any database being used.

There is a newer version: 2.78

Show newest version

/*
 * Copyright (C) 2004 - 2014 Brian McCallister
 *
 * 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 org.skife.jdbi.v2;

public interface Transaction
{
    /**
     * Execute in a transaction. Will be committed afterwards, or rolled back if a transaction
     * is thrown.
     * 
     * If the transaction fails a {@link org.skife.jdbi.v2.exceptions.TransactionFailedException}
     * will be thrown from the {@link Handle#inTransaction(TransactionCallback)}
     *
     * @param transactional The object communicating with the database.
     * @param status a handle on the transaction, kind of
     * @return Something to return from {@link Handle#inTransaction(TransactionCallback)}
     * @throws Exception will cause the transaction be aborted
     */
    ReturnType inTransaction(ConnectionType transactional, TransactionStatus status) throws Exception;
}