com.couchbase.client.java.diagnostics.WaitUntilReadyOptions 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.2
/*
 * Copyright (c) 2019 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.diagnostics;

import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.diagnostics.ClusterState;
import com.couchbase.client.core.error.InvalidArgumentException;
import com.couchbase.client.core.service.ServiceType;

import java.util.Set;

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

/**
 * Allows to customize the diagnostics report.
 */
public class WaitUntilReadyOptions {

  /**
   * The service types to limit this diagnostics request to.
   */
  private Set serviceTypes;

  /**
   * The desired cluster state to reach.
   */
  private ClusterState desiredState = ClusterState.ONLINE;

  /**
   * Creates a new set of {@link WaitUntilReadyOptions}.
   *
   * @return options to customize.
   */
  public static WaitUntilReadyOptions waitUntilReadyOptions() {
    return new WaitUntilReadyOptions();
  }

  private WaitUntilReadyOptions() {}

  /**
   * Allows to customize the set of services to wait for.
   * 
   * If no set is provided, all possible services are waited for.
   *
   * @param serviceTypes the service types that should be waited for. If none are specified, wait for all.
   * @return the {@link WaitUntilReadyOptions} to allow method chaining.
   */
  public WaitUntilReadyOptions serviceTypes(final Set serviceTypes) {
    notNull(serviceTypes, "Service Types");
    this.serviceTypes = serviceTypes.isEmpty() ? null : serviceTypes;
    return this;
  }

  /**
   * Allows to customize the set of services to wait for.
   * 
   * If no service types are provided, all possible services are waited for.
   *
   * @param serviceTypes the service types that should be waited for. If none are specified, wait for all.
   * @return the {@link WaitUntilReadyOptions} to allow method chaining.
   */
  public WaitUntilReadyOptions serviceTypes(final ServiceType... serviceTypes) {
    return serviceTypes(setOf(serviceTypes));
  }

  /**
   * Allows to customize the desired state to wait for.
   *
   * @param desiredState the state the sdk should wait for.
   * @return the {@link WaitUntilReadyOptions} to allow method chaining.
   */
  public WaitUntilReadyOptions desiredState(final ClusterState desiredState) {
    notNull(desiredState, "Desired State");
    if (desiredState == ClusterState.OFFLINE) {
      throw InvalidArgumentException.fromMessage("Offline cannot be passed in as a state to wait for");
    }

    this.desiredState = desiredState;
    return this;
  }

  @Stability.Internal
  public Built build() {
    return new Built();
  }

  @Stability.Internal
  public class Built {

    Built() { }

    public Set serviceTypes() {
      return serviceTypes;
    }

    public ClusterState desiredState() {
      return desiredState;
    }
  }

}