com.couchbase.client.java.kv.CommonDurabilityOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
The official Couchbase Java SDK
There is a newer version: 3.7.6
/*
 * Copyright (c) 2018 Couchbase, 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 com.couchbase.client.java.kv;

import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.api.kv.CoreDurability;
import com.couchbase.client.core.msg.kv.DurabilityLevel;
import com.couchbase.client.java.CommonOptions;

import java.util.Optional;

import static com.couchbase.client.core.util.Validators.notNull;

/**
 * Extends the {@link CommonOptions} to also include the durability requirements.
 *
 * @since 2.0.0
 */
public abstract class CommonDurabilityOptions> extends CommonOptions {

  /**
   * The custom durability persistence setting, if set.
   */
  private PersistTo persistTo = PersistTo.NONE;

  /**
   * The custom replication setting, if set.
   */
  private ReplicateTo replicateTo = ReplicateTo.NONE;

  /**
   * The custom enhanced durability level setting, if set.
   */
  private Optional durabilityLevel = Optional.empty();

  /**
   * Allows to customize the poll-based durability requirements for this operation.
   *
   * Note: if a {@link #durability(DurabilityLevel)} has been set beforehand it will be set back to
   * {@link DurabilityLevel#NONE}, since it is not allowed to use both mechanisms at the same time.
   *
   * @param persistTo the durability persistence requirement.
   * @param replicateTo the durability replication requirement.
   * @return this options builder for chaining purposes.
   */
  public SELF durability(final PersistTo persistTo, final ReplicateTo replicateTo) {
    notNull(persistTo, "PersistTo");
    notNull(replicateTo, "ReplicateTo");

    if (durabilityLevel.isPresent()) {
      durabilityLevel = Optional.empty();
    }

    this.persistTo = persistTo;
    this.replicateTo = replicateTo;
    return self();
  }

  /**
   * Allows to customize the enhanced durability requirements for this operation.
   *
   * Note: if a {@link #durability(PersistTo, ReplicateTo)} has been set beforehand it will be set
   * back to {@link PersistTo#NONE} and {@link ReplicateTo#NONE}, since it is not allowed to use both mechanisms at
   * the same time.
   *
   * @param durabilityLevel the enhanced durability requirement.
   * @return this options builder for chaining purposes.
   */
  public SELF durability(final DurabilityLevel durabilityLevel) {
    notNull(durabilityLevel, "DurabilityLevel");

    this.persistTo = PersistTo.NONE;
    this.replicateTo = ReplicateTo.NONE;

    if (durabilityLevel != DurabilityLevel.NONE) {
      this.durabilityLevel = Optional.of(durabilityLevel);
    } else {
      this.durabilityLevel = Optional.empty();
    }

    return self();
  }

  public abstract class BuiltCommonDurabilityOptions extends BuiltCommonOptions {

    /**
     * Returns the persistence durability setting if provided.
     */
    public PersistTo persistTo() {
      return persistTo;
    }

    /**
     * Returns the replication durability setting if provided.
     */
    public ReplicateTo replicateTo() {
      return replicateTo;
    }

    /**
     * Returns the enhanced durability setting if provided.
     */
    public Optional durabilityLevel() {
      return durabilityLevel;
    }

    @Stability.Internal
    public CoreDurability toCoreDurability() {
      return durabilityLevel().isPresent()
        ? CoreDurability.of(durabilityLevel().get())
        : CoreDurability.of(persistTo().coreHandle(), replicateTo().coreHandle());
    }
  }

}