@Configuration public abstract class AbstractCouchbaseConfiguration extends Object
Constructor and Description |
---|
AbstractCouchbaseConfiguration() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
abbreviateFieldNames()
Set to true if field names should be abbreviated with the
CamelCaseAbbreviatingFieldNamingStrategy . |
protected com.couchbase.client.core.env.Authenticator |
authenticator()
Allows to override the
Authenticator used. |
protected boolean |
autoIndexCreation()
Configure whether to automatically create indices for domain types by deriving the from the entity or not.
|
protected void |
configureEnvironment(com.couchbase.client.java.env.ClusterEnvironment.Builder builder)
Can be overridden to customize the configuration of the environment before bootstrap.
|
protected void |
configureReactiveRepositoryOperationsMapping(ReactiveRepositoryOperationsMapping 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).
|
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).
|
CouchbaseClientFactory |
couchbaseClientFactory(com.couchbase.client.java.Cluster couchbaseCluster)
The
CouchbaseClientFactory provides access to the lower level SDK resources. |
com.couchbase.client.java.Cluster |
couchbaseCluster(com.couchbase.client.java.env.ClusterEnvironment couchbaseClusterEnvironment) |
com.couchbase.client.java.env.ClusterEnvironment |
couchbaseClusterEnvironment() |
CouchbaseMappingContext |
couchbaseMappingContext(CustomConversions customConversions)
Creates a
CouchbaseMappingContext equipped with entity classes scanned from the mapping base package. |
RepositoryOperationsMapping |
couchbaseRepositoryOperationsMapping(CouchbaseTemplate couchbaseTemplate) |
CouchbaseTemplate |
couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
MappingCouchbaseConverter mappingCouchbaseConverter) |
CouchbaseTemplate |
couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
MappingCouchbaseConverter mappingCouchbaseConverter,
TranslationService couchbaseTranslationService) |
TranslationService |
couchbaseTranslationService()
Creates a
TranslationService . |
CustomConversions |
customConversions()
Register custom Converters in a
CustomConversions object if required. |
protected FieldNamingStrategy |
fieldNamingStrategy()
Configures a
FieldNamingStrategy on the CouchbaseMappingContext instance created. |
abstract String |
getBucketName()
The name of the bucket that should be used (for example "travel-sample").
|
abstract String |
getConnectionString()
The connection string which allows the SDK to connect to the cluster.
|
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
Document s. |
abstract String |
getPassword()
The password used or the username to authenticate against the cluster.
|
protected String |
getScopeName()
If a non-default scope should be used, override this method.
|
abstract String |
getUserName()
The username of the user accessing Couchbase, configured on the cluster.
|
MappingCouchbaseConverter |
mappingCouchbaseConverter(CouchbaseMappingContext couchbaseMappingContext,
CouchbaseCustomConversions couchbaseCustomConversions)
Creates a
MappingCouchbaseConverter using the configured couchbaseMappingContext(org.springframework.data.convert.CustomConversions) . |
ReactiveRepositoryOperationsMapping |
reactiveCouchbaseRepositoryOperationsMapping(ReactiveCouchbaseTemplate reactiveCouchbaseTemplate) |
ReactiveCouchbaseTemplate |
reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
MappingCouchbaseConverter mappingCouchbaseConverter) |
ReactiveCouchbaseTemplate |
reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory,
MappingCouchbaseConverter mappingCouchbaseConverter,
TranslationService couchbaseTranslationService) |
String |
typeKey()
Determines the name of the field that will store the type information for complex types when using the
mappingCouchbaseConverter(CouchbaseMappingContext, CouchbaseCustomConversions) . |
public abstract String getConnectionString()
Note that the connection string can take many forms, in its simplest it is just a single hostname like "127.0.0.1". Please refer to the couchbase Java SDK documentation for all the different possibilities and options.
public abstract String getUserName()
public abstract String getPassword()
public abstract String getBucketName()
protected String getScopeName()
protected com.couchbase.client.core.env.Authenticator authenticator()
Authenticator
used.
The default implementation uses the PasswordAuthenticator
and takes the username and password from
getUserName()
and getPassword()
respectively.
@Bean public CouchbaseClientFactory couchbaseClientFactory(com.couchbase.client.java.Cluster couchbaseCluster)
CouchbaseClientFactory
provides access to the lower level SDK resources.couchbaseCluster
- the cluster reference from the SDK.@Bean(destroyMethod="disconnect") public com.couchbase.client.java.Cluster couchbaseCluster(com.couchbase.client.java.env.ClusterEnvironment couchbaseClusterEnvironment)
@Bean(destroyMethod="shutdown") public com.couchbase.client.java.env.ClusterEnvironment couchbaseClusterEnvironment()
protected void configureEnvironment(com.couchbase.client.java.env.ClusterEnvironment.Builder builder)
builder
- the builder that can be customized.@Bean(name="couchbaseTemplate") public CouchbaseTemplate couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory, MappingCouchbaseConverter mappingCouchbaseConverter, TranslationService couchbaseTranslationService)
public CouchbaseTemplate couchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory, MappingCouchbaseConverter mappingCouchbaseConverter)
@Bean(name="reactiveCouchbaseTemplate") public ReactiveCouchbaseTemplate reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory, MappingCouchbaseConverter mappingCouchbaseConverter, TranslationService couchbaseTranslationService)
public ReactiveCouchbaseTemplate reactiveCouchbaseTemplate(CouchbaseClientFactory couchbaseClientFactory, MappingCouchbaseConverter mappingCouchbaseConverter)
@Bean(name="couchbaseRepositoryOperationsMapping") public RepositoryOperationsMapping couchbaseRepositoryOperationsMapping(CouchbaseTemplate couchbaseTemplate)
protected void configureRepositoryOperationsMapping(RepositoryOperationsMapping mapping)
mapping
- the default mapping (will associate all repositories to the default template).@Bean(name="reactiveCouchbaseRepositoryOperationsMapping") public ReactiveRepositoryOperationsMapping reactiveCouchbaseRepositoryOperationsMapping(ReactiveCouchbaseTemplate reactiveCouchbaseTemplate)
protected void configureReactiveRepositoryOperationsMapping(ReactiveRepositoryOperationsMapping mapping)
mapping
- the default mapping (will associate all repositories to the default template).protected Set<Class<?>> getInitialEntitySet() throws ClassNotFoundException
Document
.ClassNotFoundException
- if initial entity sets could not be loaded.public String typeKey()
mappingCouchbaseConverter(CouchbaseMappingContext, CouchbaseCustomConversions)
. Defaults to
.@Bean public MappingCouchbaseConverter mappingCouchbaseConverter(CouchbaseMappingContext couchbaseMappingContext, CouchbaseCustomConversions couchbaseCustomConversions)
MappingCouchbaseConverter
using the configured couchbaseMappingContext(org.springframework.data.convert.CustomConversions)
.Exception
- on Bean construction failure.@Bean public TranslationService couchbaseTranslationService()
TranslationService
.@Bean public CouchbaseMappingContext couchbaseMappingContext(CustomConversions customConversions) throws Exception
CouchbaseMappingContext
equipped with entity classes scanned from the mapping base package.Exception
- on Bean construction failure.protected boolean autoIndexCreation()
@Bean(name="couchbaseCustomConversions") public CustomConversions customConversions()
CustomConversions
object if required. These CustomConversions
will
be registered with the mappingCouchbaseConverter(CouchbaseMappingContext, CouchbaseCustomConversions)
)}
and couchbaseMappingContext(CustomConversions)
. Returns an empty CustomConversions
instance by
default.protected String getMappingBasePackage()
Document
s. 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.
Document
classes or null to not enable scanning for
entities.protected boolean abbreviateFieldNames()
CamelCaseAbbreviatingFieldNamingStrategy
.protected FieldNamingStrategy fieldNamingStrategy()
FieldNamingStrategy
on the CouchbaseMappingContext
instance created.Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.