com.arangodb.model.TransactionOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation
ArangoDB Java Driver
There is a newer version: 7.15.0
/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.model;

import java.util.Arrays;
import java.util.Collection;

/**
 * @author Mark Vollmary
 * 
 * @see API
 *      Documentation
 */
public class TransactionOptions {

	private String action;
	private Object params;
	private final TransactionCollectionOptions collections;
	private Integer lockTimeout;
	private Boolean waitForSync;
	private Long maxTransactionSize;
	private Long intermediateCommitCount;
	private Long intermediateCommitSize;

	public TransactionOptions() {
		super();
		collections = new TransactionCollectionOptions();
	}

	protected String getAction() {
		return action;
	}

	/**
	 * @param action
	 *            the actual transaction operations to be executed, in the form of stringified JavaScript code
	 * @return options
	 */
	protected TransactionOptions action(final String action) {
		this.action = action;
		return this;
	}

	public Object getParams() {
		return params;
	}

	/**
	 * @param params
	 *            optional arguments passed to action
	 * @return options
	 */
	public TransactionOptions params(final Object params) {
		this.params = params;
		return this;
	}

	public Integer getLockTimeout() {
		return lockTimeout;
	}

	/**
	 * @param lockTimeout
	 *            an optional numeric value that can be used to set a timeout for waiting on collection locks. If not
	 *            specified, a default value will be used. Setting lockTimeout to 0 will make ArangoDB not time out
	 *            waiting for a lock.
	 * @return options
	 */
	public TransactionOptions lockTimeout(final Integer lockTimeout) {
		this.lockTimeout = lockTimeout;
		return this;
	}

	public Boolean getWaitForSync() {
		return waitForSync;
	}

	/**
	 * @param waitForSync
	 *            an optional boolean flag that, if set, will force the transaction to write all data to disk before
	 *            returning
	 * @return options
	 */
	public TransactionOptions waitForSync(final Boolean waitForSync) {
		this.waitForSync = waitForSync;
		return this;
	}

	/**
	 * @param read
	 *            contains the array of collection-names to be used in the transaction (mandatory) for read
	 * @return options
	 */
	public TransactionOptions readCollections(final String... read) {
		collections.read(read);
		return this;
	}

	/**
	 * @param write
	 *            contains the array of collection-names to be used in the transaction (mandatory) for write
	 * @return options
	 */
	public TransactionOptions writeCollections(final String... write) {
		collections.write(write);
		return this;
	}

	public TransactionOptions allowImplicit(final Boolean allowImplicit) {
		collections.allowImplicit(allowImplicit);
		return this;
	}

	public Long getMaxTransactionSize() {
		return maxTransactionSize;
	}

	/**
	 * @param maxTransactionSize
	 *            Transaction size limit in bytes. Honored by the RocksDB storage engine only.
	 * @since ArangoDB 3.2.0
	 * @return options
	 */
	public TransactionOptions maxTransactionSize(final Long maxTransactionSize) {
		this.maxTransactionSize = maxTransactionSize;
		return this;
	}

	public Long getIntermediateCommitCount() {
		return intermediateCommitCount;
	}

	/**
	 * @param intermediateCommitCount
	 *            Maximum number of operations after which an intermediate commit is performed automatically. Honored by
	 *            the RocksDB storage engine only.
	 * @since ArangoDB 3.2.0
	 * @return options
	 */
	public TransactionOptions intermediateCommitCount(final Long intermediateCommitCount) {
		this.intermediateCommitCount = intermediateCommitCount;
		return this;
	}

	public Long getIntermediateCommitSize() {
		return intermediateCommitSize;
	}

	/**
	 * @param intermediateCommitSize
	 *            Maximum total size of operations after which an intermediate commit is performed automatically.
	 *            Honored by the RocksDB storage engine only.
	 * @since ArangoDB 3.2.0
	 * @return options
	 */
	public TransactionOptions intermediateCommitSize(final Long intermediateCommitSize) {
		this.intermediateCommitSize = intermediateCommitSize;
		return this;
	}

	public static class TransactionCollectionOptions {

		private Collection read;
		private Collection write;
		private Boolean allowImplicit;

		public Collection getRead() {
			return read;
		}

		public TransactionCollectionOptions read(final String... read) {
			this.read = Arrays.asList(read);
			return this;
		}

		public Collection getWrite() {
			return write;
		}

		public TransactionCollectionOptions write(final String... write) {
			this.write = Arrays.asList(write);
			return this;
		}

		public Boolean getAllowImplicit() {
			return allowImplicit;
		}

		public TransactionCollectionOptions allowImplicit(final Boolean allowImplicit) {
			this.allowImplicit = allowImplicit;
			return this;
		}

	}

}