org.springframework.data.couchbase.config

Class AbstractCouchbaseConfiguration

java.lang.Object

org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration

@Configuration
public abstract class AbstractCouchbaseConfiguration
extends Object

Base class for Spring Data Couchbase configuration using JavaConfig.

Author:

Michael Nitschinger, Simon Baslé

Constructor Summary

Constructors

Constructor and Description
AbstractCouchbaseConfiguration()

Method Summary

Modifier and Type	Method and Description
protected boolean	abbreviateFieldNames() Set to true if field names should be abbreviated with the CamelCaseAbbreviatingFieldNamingStrategy.
protected void	configureRepositoryOperationsMapping(RepositoryOperationsMapping mapping) In order to customize the mapping between repositories/entity types to couchbase templates, use the provided mapping's api (eg. in order to have different buckets backing different repositories).
com.couchbase.client.java.Bucket	couchbaseClient() Return the Bucket instance to connect to.
com.couchbase.client.java.Cluster	couchbaseCluster() Returns the Cluster instance to connect to.
com.couchbase.client.java.cluster.ClusterInfo	couchbaseClusterInfo()
com.couchbase.client.java.env.CouchbaseEnvironment	couchbaseEnvironment()
CouchbaseMappingContext	couchbaseMappingContext() Creates a CouchbaseMappingContext equipped with entity classes scanned from the mapping base package.
CouchbaseTemplate	couchbaseTemplate() Creates a CouchbaseTemplate.
CustomConversions	customConversions() Register custom Converters in a CustomConversions object if required.
protected FieldNamingStrategy	fieldNamingStrategy() Configures a FieldNamingStrategy on the CouchbaseMappingContext instance created.
protected abstract List<String>	getBootstrapHosts() The list of hostnames (or IP addresses) to bootstrap from.
protected abstract String	getBucketName() The name of the bucket to connect to.
protected abstract String	getBucketPassword() The password of the bucket (can be an empty string).
protected Consistency	getDefaultConsistency() Configures the default consistency for generated view queries and N1QL queries in repositories.
protected com.couchbase.client.java.env.CouchbaseEnvironment	getEnvironment() Override this method if you want a customized CouchbaseEnvironment.
protected Set<Class<?>>	getInitialEntitySet() Scans the mapping base package for classes annotated with Document.
protected String	getMappingBasePackage() Return the base package to scan for mapped Documents.
IndexManager	indexManager() Register an IndexManager bean that will be used to process ViewIndexed, N1qlPrimaryIndexed and N1qlSecondaryIndexed annotations on repositories to automatically create indexes.
protected boolean	isEnvironmentManagedBySpring() Is the getEnvironment() to be destroyed by Spring?
MappingCouchbaseConverter	mappingCouchbaseConverter() Creates a MappingCouchbaseConverter using the configured couchbaseMappingContext().
RepositoryOperationsMapping	repositoryOperationsMapping() Creates the RepositoryOperationsMapping bean which will be used by the framework to choose which CouchbaseOperations should back which CouchbaseRepository.
TranslationService	translationService() Creates a TranslationService.
String	typeKey() Determines the name of the field that will store the type information for complex types when using the mappingCouchbaseConverter().

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCouchbaseConfiguration

public AbstractCouchbaseConfiguration()

Method Detail

getBootstrapHosts

protected abstract List<String> getBootstrapHosts()

The list of hostnames (or IP addresses) to bootstrap from.

Returns:

the list of bootstrap hosts.

getBucketName

protected abstract String getBucketName()

The name of the bucket to connect to.

Returns:

the name of the bucket.

getBucketPassword

protected abstract String getBucketPassword()

The password of the bucket (can be an empty string).

Returns:

the password of the bucket.

isEnvironmentManagedBySpring

protected boolean isEnvironmentManagedBySpring()

Is the getEnvironment() to be destroyed by Spring?

Returns:

true if Spring should destroy the environment with the context, false otherwise.

getEnvironment

protected com.couchbase.client.java.env.CouchbaseEnvironment getEnvironment()

Override this method if you want a customized CouchbaseEnvironment. This environment will be managed by Spring, which will call its shutdown() method upon bean destruction, unless you override isEnvironmentManagedBySpring() as well to return false.

Returns:

a customized environment, defaults to a DefaultCouchbaseEnvironment.

couchbaseEnvironment

@Bean(destroyMethod="shutdown",
      name="couchbaseEnv")
public com.couchbase.client.java.env.CouchbaseEnvironment couchbaseEnvironment()

couchbaseCluster

@Bean(destroyMethod="disconnect",
      name="couchbaseCluster")
public com.couchbase.client.java.Cluster couchbaseCluster()
                                                                                                                    throws Exception

Returns the Cluster instance to connect to.

Throws:

Exception - on Bean construction failure.

couchbaseClusterInfo

@Bean(name="couchbaseClusterInfo")
public com.couchbase.client.java.cluster.ClusterInfo couchbaseClusterInfo()
                                                                                                      throws Exception

Throws:

Exception

couchbaseClient

@Bean(destroyMethod="close",
      name="couchbaseBucket")
public com.couchbase.client.java.Bucket couchbaseClient()
                                                                                                            throws Exception

Return the Bucket instance to connect to.

Throws:

Exception - on Bean construction failure.

couchbaseTemplate

@Bean(name="couchbaseTemplate")
public CouchbaseTemplate couchbaseTemplate()
                                                                    throws Exception

Creates a CouchbaseTemplate. This uses couchbaseClusterInfo(), couchbaseClient(), mappingCouchbaseConverter(), , translationService() and getDefaultConsistency() for construction.

Throws:

Exception - on Bean construction failure.

repositoryOperationsMapping

@Bean(name="couchbaseRepositoryOperationsMapping")
public RepositoryOperationsMapping repositoryOperationsMapping()
                                                                                                           throws Exception

Creates the RepositoryOperationsMapping bean which will be used by the framework to choose which CouchbaseOperations should back which CouchbaseRepository. Override configureRepositoryOperationsMapping(RepositoryOperationsMapping) in order to customize this.

Throws:

Exception

configureRepositoryOperationsMapping

protected void configureRepositoryOperationsMapping(RepositoryOperationsMapping mapping)

In order to customize the mapping between repositories/entity types to couchbase templates, use the provided mapping's api (eg. in order to have different buckets backing different repositories).

Parameters:

mapping - the default mapping (will associate all repositories to the default template).

typeKey

public String typeKey()

Determines the name of the field that will store the type information for complex types when using the mappingCouchbaseConverter(). Defaults to .

See Also:

MappingCouchbaseConverter.TYPEKEY_DEFAULT, MappingCouchbaseConverter.TYPEKEY_SYNCGATEWAY_COMPATIBLE

mappingCouchbaseConverter

@Bean(name="couchbaseMappingConverter")
public MappingCouchbaseConverter mappingCouchbaseConverter()
                                                                                            throws Exception

Creates a MappingCouchbaseConverter using the configured couchbaseMappingContext().

Throws:

Exception - on Bean construction failure.

translationService

@Bean(name="couchbaseTranslationService")
public TranslationService translationService()

Creates a TranslationService.

Returns:

TranslationService, defaulting to JacksonTranslationService.

couchbaseMappingContext

@Bean(name="couchbaseMappingContext")
public CouchbaseMappingContext couchbaseMappingContext()
                                                                                      throws Exception

Creates a CouchbaseMappingContext equipped with entity classes scanned from the mapping base package.

Throws:

Exception - on Bean construction failure.

customConversions

@Bean(name="couchbaseCustomConversions")
public CustomConversions customConversions()

Register custom Converters in a CustomConversions object if required. These CustomConversions will be registered with the mappingCouchbaseConverter() and couchbaseMappingContext(). Returns an empty CustomConversions instance by default.

Returns:

must not be null.

indexManager

@Bean(name="couchbaseIndexManager")
public IndexManager indexManager()

Register an IndexManager bean that will be used to process ViewIndexed, N1qlPrimaryIndexed and N1qlSecondaryIndexed annotations on repositories to automatically create indexes. By default, since such automatic creations are discouraged in production envrironment, the configuration will assume the worst and will ignore these annotations.

If you are sure this configuration used in a context where such automatic creations are desired (eg. you want automatic index creation in Dev, just not in Prod, and this configuration is the Dev one), override the bean and use the IndexManager.IndexManager() constructor (or IndexManager.IndexManager(boolean, boolean, boolean) constructor with appropriate flags set to true to activate).

getInitialEntitySet

protected Set<Class<?>> getInitialEntitySet()
                                     throws ClassNotFoundException

Scans the mapping base package for classes annotated with Document.

Throws:

ClassNotFoundException - if initial entity sets could not be loaded.

getMappingBasePackage

protected String getMappingBasePackage()

Return the base package to scan for mapped Documents. Will return the package name of the configuration class (the concrete class, not this one here) by default.

So if you have a com.acme.AppConfig extending AbstractCouchbaseConfiguration the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base package to scan for mapped Document classes or null to not enable scanning for entities.

abbreviateFieldNames

protected boolean abbreviateFieldNames()

Set to true if field names should be abbreviated with the CamelCaseAbbreviatingFieldNamingStrategy.

Returns:

true if field names should be abbreviated, default is false.

fieldNamingStrategy

protected FieldNamingStrategy fieldNamingStrategy()

Configures a FieldNamingStrategy on the CouchbaseMappingContext instance created.

Returns:

the naming strategy.

getDefaultConsistency

protected Consistency getDefaultConsistency()

Configures the default consistency for generated view queries and N1QL queries in repositories.

Returns:

the consistency to apply by default on generated queries.