Transactable.java

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * 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.kaaproject.kaa.client.transact;

/**
 * General interface for transaction managers.
 */
public interface Transactable {

  /**
   * Create new transaction entry.<br>
   *
   * @return TransactionId Unique id of created transaction.
   */
  TransactionId beginTransaction();

  /**
   * Submit the transaction<br>
   *
   * @param trxId The unique identifier of the transaction which should be submitted.
   */
  void commit(TransactionId trxId);

  /**
   * Revert the transaction<br>
   *
   * @param trxId The unique identifier of the transaction which should be reverted.
   */
  void rollback(TransactionId trxId);
}