Package com.couchbase.client.core.config.refresher

Interface BucketRefresher

All Known Implementing Classes:

ClusterManagerBucketRefresher, KeyValueBucketRefresher

public interface BucketRefresher

The BucketRefresher is responsible to keep the configurations up to date after the initial bootstrap/load.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
Mono<Void>	deregister(String name)	Deregisters a bucket from refreshing (stopping the refresh).
void	markTainted(String name)	Marks the bucket as tainted, which will change the behavior of the refresher.
void	markUntainted(String name)	Marks the bucket as untainted, which will change the behavior of the refresher.
Mono<Void>	register(String name)	Registers a bucket for refreshing.
Set<String>	registered()	Returns the names of all registered buckets.
Mono<Void>	shutdown()	Permanently shuts down the refresher.

Method Details

register

Mono<Void> register(String name)

Registers a bucket for refreshing.

Parameters:

name - the name of the bucket.

Returns:

a Mono once complete.

deregister

Mono<Void> deregister(String name)

Deregisters a bucket from refreshing (stopping the refresh).

Parameters:

name - the name of the bucket.

Returns:

a Mono once complete.

registered

Set<String> registered()

Returns the names of all registered buckets.

Returns:

all registered buckets.

markTainted

void markTainted(String name)

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).

Parameters:

name - the name of the bucket.

markUntainted

void markUntainted(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).

Parameters:

name - the name of the bucket.

shutdown

Mono<Void> shutdown()

Permanently shuts down the refresher.

Returns:

a Mono once complete.