org.apache.commons.transaction.TransactionalResourceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.org.apache.commons.transaction Show documentation

Classes that aid concurrent programming in a transactional style.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.transaction;

import java.util.concurrent.TimeUnit;


/**
 * Interface for something that makes up a transactional resource manager. Used for user control.
 * Comparable to an XA resource.
 * 
 */
public interface TransactionalResourceManager {
    /**
     * Starts a new transaction and associates it with the current thread. All
     * subsequent changes in the same thread made to the resource manager are invisible from
     * other threads until {@link #commitTransaction()} is called. Use
     * {@link #rollbackTransaction()} to discard your changes. After calling
     * either method there will be no transaction associated to the current
     * thread any longer. 

     * 

     * Caution: Be careful to finally call one of those methods, as
     * otherwise the transaction will lurk around for ever.
     * 
     * @see #commitTransaction()
     * @see #rollbackTransaction()
     */
    void startTransaction(long timeout, TimeUnit unit);

    /**
     * Discards all changes made in the current transaction and deletes the
     * association between the current thread and the transaction.
     * 
     * @see #startTransaction(long, TimeUnit)
     * @see #commitTransaction()
     */
    void rollbackTransaction();

    /**
     * Commits all changes made in the current transaction and deletes the
     * association between the current thread and the transaction.
     * 
     * @see #startTransaction(long, TimeUnit)
     * @see #rollbackTransaction()
     */
    boolean commitTransaction();
}