com.couchbase.client.core.config.refresher.BucketRefresher Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation

The official Couchbase JVM Core IO Library

There is a newer version: 3.7.2

/*
 * Copyright (c) 2016 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.core.config.refresher;

import reactor.core.publisher.Mono;

import java.util.Set;

/**
 * The {@link BucketRefresher} is responsible to keep the configurations up to date after the initial
 * bootstrap/load.
 *
 * @since 1.0.0
 */
public interface BucketRefresher {

  /**
   * Registers a bucket for refreshing.
   *
   * @param name the name of the bucket.
   * @return a {@link Mono} once complete.
   */
  Mono register(String name);

  /**
   * Deregisters a bucket from refreshing (stopping the refresh).
   *
   * @param name the name of the bucket.
   * @return a {@link Mono} once complete.
   */
  Mono deregister(String name);

  /**
   * Returns the names of all registered buckets.
   *
   * @return all registered buckets.
   */
  Set registered();

  /**
   * Marks the bucket as tainted, which will change the behavior of the refresher.
   *
   * A config is marked as tainted during rebalance, which usually leads to shorter intervals
   * of checking if a new configuration exists (depending of the refresher impl).
   *
   * @param name the name of the bucket.
   */
  void markTainted(String name);

  /**
   * Marks the bucket as untainted, which will change the behavior of the refresher.
   *
   * A config is marked as tainted during rebalance, which usually leads to shorter intervals
   * of checking if a new configuration exists (depending of the refresher impl).
   *
   * @param name the name of the bucket.
   */
  void markUntainted(String name);

  /**
   * Permanently shuts down the refresher.
   *
   * @return a {@link Mono} once complete.
   */
  Mono shutdown();

}