com.couchbase.client.vbucket.provider

Class BucketConfigurationProvider

java.lang.Object

net.spy.memcached.compat.SpyObject

com.couchbase.client.vbucket.provider.BucketConfigurationProvider

All Implemented Interfaces:

ConfigurationProvider, Reconfigurable

public class BucketConfigurationProvider
extends net.spy.memcached.compat.SpyObject
implements ConfigurationProvider, Reconfigurable

This ConfigurationProvider provides the current bucket configuration in a best-effort way, mixing both http and binary fetching techniques (depending on the supported mechanisms on the cluster side).

Constructor Summary

Constructors

Constructor and Description
BucketConfigurationProvider(java.util.List<java.net.URI> seedNodes, java.lang.String bucket, java.lang.String password, CouchbaseConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method and Description
Bucket	bootstrap() Initiate the config fetching process, eventually returning a valid configuration.
java.lang.String	getAnonymousAuthBucket() Retrieves a default bucket name i.e.
Bucket	getConfig() Returns the current Bucket configuration.
void	reconfigure(Bucket bucket) Call on a configuration update.
void	reloadConfig() Method used to signal a new configuration should be loaded.
void	setConfig(Bucket config) Explictly set the current Bucket configuration.
void	setConfig(java.lang.String config) Replace the current config with a raw JSON string configuration.
void	shutdown() Shut down the ConfigurationProvider.
void	signalOutdated() Can be used as a hint for the ConfigurationProvider to signal that his current configuration may be outdated.
void	subscribe(Reconfigurable rec) Subscribes for configuration updates.
void	unsubscribe(Reconfigurable rec) Unsubscribe from updates on the connected bucket.

Methods inherited from class net.spy.memcached.compat.SpyObject

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketConfigurationProvider

public BucketConfigurationProvider(java.util.List<java.net.URI> seedNodes,
                                   java.lang.String bucket,
                                   java.lang.String password,
                                   CouchbaseConnectionFactory connectionFactory)

Method Detail

bootstrap

public Bucket bootstrap()

Description copied from interface: ConfigurationProvider

Initiate the config fetching process, eventually returning a valid configuration.

Specified by:

bootstrap in interface ConfigurationProvider

Returns:

a valid configuration.

reconfigure

public void reconfigure(Bucket bucket)

Description copied from interface: Reconfigurable

Call on a configuration update.

Specified by:

reconfigure in interface Reconfigurable

Parameters:

bucket - updated vbucket configuration

getConfig

public Bucket getConfig()

Description copied from interface: ConfigurationProvider

Returns the current Bucket configuration.

Specified by:

getConfig in interface ConfigurationProvider

Returns:

the current bucket configuration.

setConfig

public void setConfig(Bucket config)

Description copied from interface: ConfigurationProvider

Explictly set the current Bucket configuration.

Specified by:

setConfig in interface ConfigurationProvider

signalOutdated

public void signalOutdated()

Description copied from interface: ConfigurationProvider

Can be used as a hint for the ConfigurationProvider to signal that his current configuration may be outdated.

Specified by:

signalOutdated in interface ConfigurationProvider

reloadConfig

public void reloadConfig()

Description copied from interface: ConfigurationProvider

Method used to signal a new configuration should be loaded. With HTTP streaming connections, this method is ignored, but it can be helpful in some scenarios that a carrier config needs to be reloaded from the current active connection.

Specified by:

reloadConfig in interface ConfigurationProvider

shutdown

public void shutdown()

Description copied from interface: ConfigurationProvider

Shut down the ConfigurationProvider.

Specified by:

shutdown in interface ConfigurationProvider

getAnonymousAuthBucket

public java.lang.String getAnonymousAuthBucket()

Description copied from interface: ConfigurationProvider

Retrieves a default bucket name i.e. 'default'.

Specified by:

getAnonymousAuthBucket in interface ConfigurationProvider

Returns:

the anonymous bucket's name i.e. 'default'

setConfig

public void setConfig(java.lang.String config)

Description copied from interface: ConfigurationProvider

Replace the current config with a raw JSON string configuration.

Specified by:

setConfig in interface ConfigurationProvider

Parameters:

config - the raw string configuration.

subscribe

public void subscribe(Reconfigurable rec)

Description copied from interface: ConfigurationProvider

Subscribes for configuration updates.

Specified by:

subscribe in interface ConfigurationProvider

Parameters:

rec - reconfigurable that will receive updates

unsubscribe

public void unsubscribe(Reconfigurable rec)

Description copied from interface: ConfigurationProvider

Unsubscribe from updates on the connected bucket.

Specified by:

unsubscribe in interface ConfigurationProvider

Parameters:

rec - reconfigurable