/*
 * 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.tweak;

import org.skife.jdbi.v2.Handle;
import org.skife.jdbi.v2.TransactionCallback;
import org.skife.jdbi.v2.TransactionIsolationLevel;

Interface which defines callbacks to be used when transaction methods are called on a handle.
Used by specifying on an IDBI instance. All Handle instances
opened from that IDBI will use the handler specified.

The default implementation, ConnectionTransactionHandler, explicitely manages
the transactions on the underlying JDBC Connection.
/**
 * Interface which defines callbacks to be used when transaction methods are called on a handle.
 * Used by specifying on an <code>IDBI</code> instance. All <code>Handle</code> instances
 * opened from that <code>IDBI</code> will use the handler specified.
 * <p />
 * The default implementation, <code>ConnectionTransactionHandler</code>, explicitely manages
 * the transactions on the underlying JDBC <code>Connection</code>.
 */
public interface TransactionHandler
{
    
Called when a transaction is started
/**
     * Called when a transaction is started
     */
    void begin(Handle handle); // TODO consider having this return a TransactionStatus

    
Called when a transaction is committed
/**
     * Called when a transaction is committed
     */
    void commit(Handle handle);

    
Called when a transaction is rolled back
/**
     * Called when a transaction is rolled back
     */
    void rollback(Handle handle);

    
Roll back to a named checkpoint
Params:
handle – the handle the rollback is being performed on
name – the name of the checkpoint to rollback to/**
     * Roll back to a named checkpoint
     * @param handle the handle the rollback is being performed on
     * @param name the name of the checkpoint to rollback to
     */
    void rollback(Handle handle, String name);

    
Called to test if a handle is in a transaction
/**
     * Called to test if a handle is in a transaction
     */
    boolean isInTransaction(Handle handle);

    
Create a new checkpoint (savepoint in JDBC terminology)
Params:
handle – the handle on which the transaction is being checkpointed
name – The name of the chckpoint, used to rollback to or release late/**
     * Create a new checkpoint (savepoint in JDBC terminology)
     *
     * @param handle the handle on which the transaction is being checkpointed
     * @param name The name of the chckpoint, used to rollback to or release late
     */
    void checkpoint(Handle handle, String name);

    
Release a previously created checkpoint
Params:
handle – the handle on which the checkpoint is being released
checkpointName – the checkpoint to release/**
     * Release a previously created checkpoint
     *
     * @param handle the handle on which the checkpoint is being released
     * @param checkpointName the checkpoint to release
     */
    void release(Handle handle, String checkpointName);

    
Run a transaction.
See Also:
inTransaction.inTransaction(TransactionCallback)/**
     * Run a transaction.
     * @see Handle#inTransaction(TransactionCallback)
     */
    <ReturnType> ReturnType inTransaction(Handle handle, TransactionCallback<ReturnType> callback);

    
Run a transaction.
See Also:
inTransaction.inTransaction(TransactionIsolationLevel, TransactionCallback)/**
     * Run a transaction.
     * @see Handle#inTransaction(TransactionIsolationLevel, TransactionCallback)
     */
    <ReturnType> ReturnType inTransaction(Handle handle, TransactionIsolationLevel level, TransactionCallback<ReturnType> callback);

}