com.couchbase.client

Class CouchbaseConnectionFactory

java.lang.Object

net.spy.memcached.compat.SpyObject

net.spy.memcached.DefaultConnectionFactory

net.spy.memcached.BinaryConnectionFactory

com.couchbase.client.CouchbaseConnectionFactory

All Implemented Interfaces:

net.spy.memcached.ConnectionFactory

public class CouchbaseConnectionFactory
extends net.spy.memcached.BinaryConnectionFactory

Couchbase implementation of ConnectionFactory.

This implementation creates connections where the operation queue is an ArrayBlockingQueue and the read and write queues are unbounded LinkedBlockingQueues. The Retry FailureMode and KetamaHash VBucket hashing mechanism are always used. If other configurations are needed, look at the ConnectionFactoryBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationProvider	configurationProvider
static long	DEFAULT_AUTH_WAIT_TIME Default auth wait time.
static net.spy.memcached.FailureMode	DEFAULT_FAILURE_MODE Default failure mode.
static net.spy.memcached.HashAlgorithm	DEFAULT_HASH Default hash algorithm.
static long	DEFAULT_MIN_RECONNECT_INTERVAL Specify a default minimum reconnect interval of 1.1s.
static long	DEFAULT_OBS_POLL_INTERVAL Default Observe poll interval in ms.
static int	DEFAULT_OBS_POLL_MAX Deprecated.
static long	DEFAULT_OBS_TIMEOUT Default Timeout when persistence/replication constraints are used (in ms).
static int	DEFAULT_OP_QUEUE_LEN Maximum length of the operation queue returned by this connection factory.
static CouchbaseNodeOrder	DEFAULT_STREAMING_NODE_ORDER Default Node ordering to use for streaming connection.
static int	DEFAULT_VIEW_CONNS_PER_NODE Default amount of max connections per node.
static int	DEFAULT_VIEW_TIMEOUT Default View request timeout in ms.
static int	DEFAULT_VIEW_WORKER_SIZE Default size of view io worker threads.

Fields inherited from class net.spy.memcached.DefaultConnectionFactory

DEFAULT_MAX_RECONNECT_DELAY, DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD, DEFAULT_METRIC_TYPE, DEFAULT_OP_QUEUE_MAX_BLOCK_TIME, DEFAULT_OPERATION_TIMEOUT, DEFAULT_READ_BUFFER_SIZE, opQueueLen

Constructor Summary

Constructors

Constructor and Description
CouchbaseConnectionFactory() Create a new CouchbaseConnectionFactory and load the required connection information from system properties.
CouchbaseConnectionFactory(java.util.List<java.net.URI> baseList, java.lang.String bucketName, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
net.spy.memcached.MemcachedConnection	createConnection(java.util.List<java.net.InetSocketAddress> addrs)
net.spy.memcached.NodeLocator	createLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes)
ViewConnection	createViewConnection(java.util.List<java.net.InetSocketAddress> addrs)
net.spy.memcached.auth.AuthDescriptor	getAuthDescriptor()
long	getAuthWaitTime()
java.lang.String	getBucketName()
ClusterManager	getClusterManager() Returns a ClusterManager and initializes one if it does not exist.
ConfigurationProvider	getConfigurationProvider()
long	getMinReconnectInterval() The minimum reconnect interval in milliseconds.
long	getObsPollInterval() The observe poll interval in milliseconds.
int	getObsPollMax() The number of observe polls to execute before giving up.
long	getObsTimeout() The observe timeout in milliseconds.
CouchbaseNodeOrder	getStreamingNodeOrder()
Config	getVBucketConfig()
int	getViewConnsPerNode()
int	getViewTimeout()
int	getViewWorkerSize()
protected void	requestConfigReconnect(java.lang.String bucketName, Reconfigurable rec)
boolean	shouldOptimize()
java.lang.String	toString()

Methods inherited from class net.spy.memcached.BinaryConnectionFactory

createMemcachedNode, getName, getOperationFactory

Methods inherited from class net.spy.memcached.DefaultConnectionFactory

createOperationQueue, createReadOperationQueue, createWriteOperationQueue, enableMetrics, getDefaultTranscoder, getFailureMode, getHashAlg, getInitialObservers, getListenerExecutorService, getMaxReconnectDelay, getMetricCollector, getOperationTimeout, getOpQueueLen, getOpQueueMaxBlockTime, getReadBufSize, getTimeoutExceptionThreshold, isDaemon, isDefaultExecutorService, useNagleAlgorithm

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

getLogger

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FAILURE_MODE

public static final net.spy.memcached.FailureMode DEFAULT_FAILURE_MODE

Default failure mode.

DEFAULT_HASH

public static final net.spy.memcached.HashAlgorithm DEFAULT_HASH

Default hash algorithm.

DEFAULT_OP_QUEUE_LEN

public static final int DEFAULT_OP_QUEUE_LEN

Maximum length of the operation queue returned by this connection factory.

See Also:

Constant Field Values

DEFAULT_MIN_RECONNECT_INTERVAL

public static final long DEFAULT_MIN_RECONNECT_INTERVAL

Specify a default minimum reconnect interval of 1.1s. This means that if a reconnect is needed, it won't try to reconnect more frequently than 1.1s between tries. The initial HTTP connections under us take up to 500ms per request.

See Also:

Constant Field Values

DEFAULT_VIEW_TIMEOUT

public static final int DEFAULT_VIEW_TIMEOUT

Default View request timeout in ms.

See Also:

Constant Field Values

DEFAULT_VIEW_WORKER_SIZE

public static final int DEFAULT_VIEW_WORKER_SIZE

Default size of view io worker threads.

See Also:

Constant Field Values

DEFAULT_VIEW_CONNS_PER_NODE

public static final int DEFAULT_VIEW_CONNS_PER_NODE

Default amount of max connections per node.

See Also:

Constant Field Values

DEFAULT_OBS_TIMEOUT

public static final long DEFAULT_OBS_TIMEOUT

Default Timeout when persistence/replication constraints are used (in ms).

See Also:

Constant Field Values

DEFAULT_OBS_POLL_INTERVAL

public static final long DEFAULT_OBS_POLL_INTERVAL

Default Observe poll interval in ms.

See Also:

Constant Field Values

DEFAULT_OBS_POLL_MAX

@Deprecated
public static final int DEFAULT_OBS_POLL_MAX

Deprecated.

Default maximum amount of poll cycles before failure. See DEFAULT_OBS_TIMEOUT for correct use. The number of polls is now calculated automatically based on the DEFAULT_OBS_TIMEOUT and DEFAULT_OBS_POLL_INTERVAL.

See Also:

Constant Field Values

DEFAULT_AUTH_WAIT_TIME

public static final long DEFAULT_AUTH_WAIT_TIME

Default auth wait time.

See Also:

Constant Field Values

DEFAULT_STREAMING_NODE_ORDER

public static final CouchbaseNodeOrder DEFAULT_STREAMING_NODE_ORDER

Default Node ordering to use for streaming connection.

configurationProvider

protected volatile ConfigurationProvider configurationProvider

Constructor Detail

CouchbaseConnectionFactory

public CouchbaseConnectionFactory()

Create a new CouchbaseConnectionFactory and load the required connection information from system properties.

The following properties need to be set in order to bootstrap: - cbclient.nodes: ;-separated list of URIs - cbclient.bucket: name of the bucket - cbclient.password: password of the bucket

CouchbaseConnectionFactory

public CouchbaseConnectionFactory(java.util.List<java.net.URI> baseList,
                                  java.lang.String bucketName,
                                  java.lang.String password)
                           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createConnection

public net.spy.memcached.MemcachedConnection createConnection(java.util.List<java.net.InetSocketAddress> addrs)
                                                       throws java.io.IOException

Specified by:

createConnection in interface net.spy.memcached.ConnectionFactory

Overrides:

createConnection in class net.spy.memcached.DefaultConnectionFactory

Throws:

java.io.IOException

createViewConnection

public ViewConnection createViewConnection(java.util.List<java.net.InetSocketAddress> addrs)
                                    throws java.io.IOException

Throws:

java.io.IOException

createLocator

public net.spy.memcached.NodeLocator createLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes)

Specified by:

createLocator in interface net.spy.memcached.ConnectionFactory

Overrides:

createLocator in class net.spy.memcached.DefaultConnectionFactory

shouldOptimize

public boolean shouldOptimize()

Specified by:

shouldOptimize in interface net.spy.memcached.ConnectionFactory

Overrides:

shouldOptimize in class net.spy.memcached.DefaultConnectionFactory

getAuthDescriptor

public net.spy.memcached.auth.AuthDescriptor getAuthDescriptor()

Specified by:

getAuthDescriptor in interface net.spy.memcached.ConnectionFactory

Overrides:

getAuthDescriptor in class net.spy.memcached.DefaultConnectionFactory

getBucketName

public java.lang.String getBucketName()

getViewTimeout

public int getViewTimeout()

getViewWorkerSize

public int getViewWorkerSize()

getViewConnsPerNode

public int getViewConnsPerNode()

getStreamingNodeOrder

public CouchbaseNodeOrder getStreamingNodeOrder()

getVBucketConfig

public Config getVBucketConfig()

getConfigurationProvider

public ConfigurationProvider getConfigurationProvider()

requestConfigReconnect

protected void requestConfigReconnect(java.lang.String bucketName,
                                      Reconfigurable rec)

getMinReconnectInterval

public long getMinReconnectInterval()

The minimum reconnect interval in milliseconds.

Returns:

the minReconnectInterval

getObsPollInterval

public long getObsPollInterval()

The observe poll interval in milliseconds.

Returns:

the observe poll interval.

getObsTimeout

public long getObsTimeout()

The observe timeout in milliseconds.

Returns:

the observe timeout.

getAuthWaitTime

public long getAuthWaitTime()

Specified by:

getAuthWaitTime in interface net.spy.memcached.ConnectionFactory

Overrides:

getAuthWaitTime in class net.spy.memcached.DefaultConnectionFactory

getObsPollMax

public int getObsPollMax()

The number of observe polls to execute before giving up. It is calculated out of the observe timeout and the observe interval, rounded to the next largest integer value.

Returns:

the number of polls.

getClusterManager

public ClusterManager getClusterManager()

Returns a ClusterManager and initializes one if it does not exist.

Returns:

Returns an instance of a ClusterManager.

toString

public java.lang.String toString()

Overrides:

toString in class net.spy.memcached.DefaultConnectionFactory