TxRunnable.java

/*
 * Copyright © 2014-2016 Cask Data, 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 co.cask.cdap.api;

import co.cask.cdap.api.data.DatasetContext;
import co.cask.cdap.api.dataset.Dataset;

/**
 * A runnable that provides a {@link DatasetContext} to programs which may be used to get
 * access to and use datasets.
 */
public interface TxRunnable {

  /**
   * Provides a {@link DatasetContext} to get instances of {@link Dataset}s.
   *
   * <p>
   *   Operations executed on a dataset within the execution of this method are committed as a single transaction.
   *   The transaction is started before this method is invoked and is committed upon successful execution.
   *   Exceptions thrown while committing the transaction or thrown by user-code result in a rollback of the
   *   transaction.
   * </p>
   *
   * @param context to get datasets from
   */
  void run(DatasetContext context) throws Exception;
}