org.apache.samza.table.remote.couchbase

Class CouchbaseBucketRegistry

java.lang.Object

org.apache.samza.table.remote.couchbase.CouchbaseBucketRegistry

public class CouchbaseBucketRegistry
extends java.lang.Object

The CouchbaseBucketRegistry is intended to reuse the same Cluster instance given same clusterNodes and reuse the same Bucket given same bucketName. Instantiating a Bucket is expensive. Different tasks within a container that is using the same bucket should use this registry to avoid creating multiple Buckets.

Constructor Summary

Constructors

Constructor and Description
CouchbaseBucketRegistry() Constructor of the CouchbaseTableRegistry.

Method Summary

Modifier and Type	Method and Description
boolean	closeBucket(java.lang.String bucketName, java.util.List<java.lang.String> clusterNodes) A synchronized method to close a bucket given the bucket name.
com.couchbase.client.java.Bucket	getBucket(java.lang.String bucketName, java.util.List<java.lang.String> clusterNodes, org.apache.samza.table.remote.couchbase.CouchbaseEnvironmentConfigs configs) A synchronized method to open a bucket given the bucket name and cluster nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseBucketRegistry

public CouchbaseBucketRegistry()

Constructor of the CouchbaseTableRegistry.

Method Detail

getBucket

public com.couchbase.client.java.Bucket getBucket(java.lang.String bucketName,
                                                  java.util.List<java.lang.String> clusterNodes,
                                                  org.apache.samza.table.remote.couchbase.CouchbaseEnvironmentConfigs configs)

A synchronized method to open a bucket given the bucket name and cluster nodes. Once a bucket has been opened, the reference of the bucket will be stored in the registry, and the same reference will be returned given same bucket name. Each time this method is called, the counter of usage of the bucket is increased by one.

Parameters:

bucketName - name of the bucket to be opened

clusterNodes - list of cluster nodes

configs - couchbase environment configs

Returns:

A Bucket instance associated with the bucket name and cluster nodes

closeBucket

public boolean closeBucket(java.lang.String bucketName,
                           java.util.List<java.lang.String> clusterNodes)

A synchronized method to close a bucket given the bucket name. Each time this method is called, the counter of usage of the bucket is decreased by one. Only when the counter becomes zero will the bucket be actually closed. Same for cluster, only when all buckets within a cluster have been closed will the cluster be closed.

Parameters:

bucketName - name of the bucket to be opened

clusterNodes - list of cluster nodes

Returns:

true if bucket is closed successfully, otherwise false.