org.camunda.bpm.engine.impl.cfg.TransactionContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha1

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.impl.cfg;



/**
 * The transaction context is an abstraction for different transaction management strategies
 * existing the Java Ecosystem. Provides transaction lifecycle management and management of transaction listeners.
 *
 * Note: not every Technology or environment may provide a full implementation of this interface.
 *
 * @author Tom Baeyens
 * @author Daniel Meyer
 */
public interface TransactionContext {

  /**
   * Commit the current transaction.
   */
  void commit();

  /**
   * Rollback the current transaction.
   */
  void rollback();


  /**
   * Add a {@link TransactionListener} to the current transaction.
   *
   * @param transactionState the transaction state for which the {@link TransactionListener} should be added.
   * @param transactionListener the {@link TransactionListener} to add.
   */
  void addTransactionListener(TransactionState transactionState, TransactionListener transactionListener);

  boolean isTransactionActive();

}