org.springframework.data.couchbase

Class SimpleCouchbaseClientFactory

java.lang.Object

org.springframework.data.couchbase.SimpleCouchbaseClientFactory

All Implemented Interfaces:

Closeable, AutoCloseable, CouchbaseClientFactory

public class SimpleCouchbaseClientFactory
extends Object
implements CouchbaseClientFactory

The default implementation of a CouchbaseClientFactory.

Author:

Michael Nitschinger, Michael Reiche

Constructor Summary

Constructors

Constructor and Description
SimpleCouchbaseClientFactory(com.couchbase.client.java.Cluster cluster, String bucketName, String scopeName)
SimpleCouchbaseClientFactory(String connectionString, com.couchbase.client.core.env.Authenticator authenticator, String bucketName)
SimpleCouchbaseClientFactory(String connectionString, com.couchbase.client.core.env.Authenticator authenticator, String bucketName, String scopeName)
SimpleCouchbaseClientFactory(String connectionString, com.couchbase.client.core.env.Authenticator authenticator, String bucketName, String scopeName, com.couchbase.client.java.env.ClusterEnvironment environment)

Method Summary

Modifier and Type	Method and Description
void	close()
com.couchbase.client.java.Bucket	getBucket() Provides access to the managed SDK Bucket reference.
com.couchbase.client.java.Cluster	getCluster() Provides access to the managed SDK Cluster reference.
com.couchbase.client.java.Collection	getCollection(String collectionName) Provides access to a collection (identified by its name) in managed SDK Scope reference.
com.couchbase.client.java.Collection	getDefaultCollection() Provides access to the default collection.
PersistenceExceptionTranslator	getExceptionTranslator() The exception translator used on the factory.
com.couchbase.client.java.Scope	getScope() Provides access to the managed SDK Scope reference.
CouchbaseClientFactory	withScope(String scopeName) Returns a new CouchbaseClientFactory set to the scope given as an argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCouchbaseClientFactory

public SimpleCouchbaseClientFactory(String connectionString,
                                    com.couchbase.client.core.env.Authenticator authenticator,
                                    String bucketName)

SimpleCouchbaseClientFactory

public SimpleCouchbaseClientFactory(String connectionString,
                                    com.couchbase.client.core.env.Authenticator authenticator,
                                    String bucketName,
                                    String scopeName)

SimpleCouchbaseClientFactory

public SimpleCouchbaseClientFactory(String connectionString,
                                    com.couchbase.client.core.env.Authenticator authenticator,
                                    String bucketName,
                                    String scopeName,
                                    com.couchbase.client.java.env.ClusterEnvironment environment)

SimpleCouchbaseClientFactory

public SimpleCouchbaseClientFactory(com.couchbase.client.java.Cluster cluster,
                                    String bucketName,
                                    String scopeName)

Method Detail

withScope

public CouchbaseClientFactory withScope(String scopeName)

Description copied from interface: CouchbaseClientFactory

Returns a new CouchbaseClientFactory set to the scope given as an argument.

Specified by:

withScope in interface CouchbaseClientFactory

Parameters:

scopeName - the name of the scope to use for all collection access.

Returns:

a new client factory, bound to the other scope.

getCluster

public com.couchbase.client.java.Cluster getCluster()

Description copied from interface: CouchbaseClientFactory

Provides access to the managed SDK Cluster reference.

Specified by:

getCluster in interface CouchbaseClientFactory

getBucket

public com.couchbase.client.java.Bucket getBucket()

Description copied from interface: CouchbaseClientFactory

Provides access to the managed SDK Bucket reference.

Specified by:

getBucket in interface CouchbaseClientFactory

getScope

public com.couchbase.client.java.Scope getScope()

Description copied from interface: CouchbaseClientFactory

Provides access to the managed SDK Scope reference.

Specified by:

getScope in interface CouchbaseClientFactory

getCollection

public com.couchbase.client.java.Collection getCollection(String collectionName)

Description copied from interface: CouchbaseClientFactory

Provides access to a collection (identified by its name) in managed SDK Scope reference.

Specified by:

getCollection in interface CouchbaseClientFactory

Parameters:

collectionName - the name of the collection. If null is passed in, the default collection is assumed.

getDefaultCollection

public com.couchbase.client.java.Collection getDefaultCollection()

Description copied from interface: CouchbaseClientFactory

Provides access to the default collection.

Specified by:

getDefaultCollection in interface CouchbaseClientFactory

getExceptionTranslator

public PersistenceExceptionTranslator getExceptionTranslator()

Description copied from interface: CouchbaseClientFactory

The exception translator used on the factory.

Specified by:

getExceptionTranslator in interface CouchbaseClientFactory

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable