com.couchbase.client.vbucket.provider

Interface ConfigurationProvider

All Known Implementing Classes:

BucketConfigurationProvider

public interface ConfigurationProvider

Defines common methods for a ConfigurationProvider. One ConfigurationProvider is needed per bucket.

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

Method Detail

bootstrap

Bucket bootstrap()
          throws ConfigurationException

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

Returns:

a valid configuration.

Throws:

ConfigurationException - if no valid configuration could be loaded.

getConfig

Bucket getConfig()

Returns the current Bucket configuration.

Returns:

the current bucket configuration.

setConfig

void setConfig(Bucket config)

Explictly set the current Bucket configuration.

setConfig

void setConfig(java.lang.String config)

Replace the current config with a raw JSON string configuration.

Parameters:

config - the raw string configuration.

signalOutdated

void signalOutdated()

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

reloadConfig

void reloadConfig()

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.

shutdown

void shutdown()

Shut down the ConfigurationProvider.

getAnonymousAuthBucket

java.lang.String getAnonymousAuthBucket()

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

Returns:

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

subscribe

void subscribe(Reconfigurable rec)

Subscribes for configuration updates.

Parameters:

rec - reconfigurable that will receive updates

Throws:

ConfigurationException

unsubscribe

void unsubscribe(Reconfigurable rec)

Unsubscribe from updates on the connected bucket.

Parameters:

rec - reconfigurable