+ * So if you have a {@code com.acme.AppConfig} extending {@link AbstractCouchbaseConfiguration} the base package will + * be considered {@code com.acme} unless the method is overridden to implement alternate behavior. + *
+ * + * @return the base package to scan for mapped {@link Document} classes or {@literal null} to not enable scanning for + * entities. + */ + protected String getMappingBasePackage() { + return getClass().getPackage().getName(); + } + + /** + * Set to true if field names should be abbreviated with the {@link CamelCaseAbbreviatingFieldNamingStrategy}. + * + * @return true if field names should be abbreviated, default is false. + */ + protected boolean abbreviateFieldNames() { + return false; + } + + /** + * Configures a {@link FieldNamingStrategy} on the {@link CouchbaseMappingContext} instance created. + * + * @return the naming strategy. + */ + protected FieldNamingStrategy fieldNamingStrategy() { + return abbreviateFieldNames() ? new CamelCaseAbbreviatingFieldNamingStrategy() + : PropertyNameFieldNamingStrategy.INSTANCE; + } } diff --git a/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseDataConfiguration.java b/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseDataConfiguration.java deleted file mode 100644 index fe75db01..00000000 --- a/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseDataConfiguration.java +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Copyright 2012-2020 the original author or authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.springframework.data.couchbase.config; - -import com.couchbase.client.java.Bucket; -import com.couchbase.client.java.cluster.ClusterInfo; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.data.couchbase.core.CouchbaseOperations; -import org.springframework.data.couchbase.core.CouchbaseTemplate; -import org.springframework.data.couchbase.repository.CouchbaseRepository; -import org.springframework.data.couchbase.repository.config.RepositoryOperationsMapping; - - -/** - * Provides beans to setup SDC using {@link CouchbaseConfigurer}. - * This is used by Spring boot to provide auto configuration support. - * - * - * @author Simon Baslé - * @author Subhashni Balakrishnan - */ -@Configuration -public abstract class AbstractCouchbaseDataConfiguration extends CouchbaseConfigurationSupport { - - protected abstract CouchbaseConfigurer couchbaseConfigurer(); - - /** - * Creates a {@link CouchbaseTemplate}. - * - * This uses {@link #mappingCouchbaseConverter()}, {@link #translationService()} and {@link #getDefaultConsistency()} - * for construction. - * - * Additionally, it will expect injection of a {@link ClusterInfo} and a {@link Bucket} beans from the context (most - * probably from another configuration). For a self-sufficient configuration that defines such beans, see - * {@link AbstractCouchbaseConfiguration}. - * - * @throws Exception on Bean construction failure. - */ - @Bean(name = BeanNames.COUCHBASE_TEMPLATE) - public CouchbaseTemplate couchbaseTemplate() throws Exception { - CouchbaseTemplate template = new CouchbaseTemplate(couchbaseConfigurer().couchbaseClusterInfo(), - couchbaseConfigurer().couchbaseClient(), mappingCouchbaseConverter(), translationService()); - template.setDefaultConsistency(getDefaultConsistency()); - return template; - } - - /** - * Creates the {@link RepositoryOperationsMapping} bean which will be used by the framework to choose which - * {@link CouchbaseOperations} should back which {@link CouchbaseRepository}. - * Override {@link #configureRepositoryOperationsMapping(RepositoryOperationsMapping)} in order to customize this. - * - * @throws Exception - */ - @Bean(name = BeanNames.COUCHBASE_OPERATIONS_MAPPING) - public RepositoryOperationsMapping repositoryOperationsMapping(CouchbaseTemplate couchbaseTemplate) throws Exception { - //create a base mapping that associates all repositories to the default template - RepositoryOperationsMapping baseMapping = new RepositoryOperationsMapping(couchbaseTemplate); - //let the user tune it - configureRepositoryOperationsMapping(baseMapping); - return baseMapping; - } - - /** - * 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). - * - * @param mapping the default mapping (will associate all repositories to the default template). - */ - protected void configureRepositoryOperationsMapping(RepositoryOperationsMapping mapping) { - //NO_OP - } -} diff --git a/src/main/java/org/springframework/data/couchbase/config/AbstractReactiveCouchbaseConfiguration.java b/src/main/java/org/springframework/data/couchbase/config/AbstractReactiveCouchbaseConfiguration.java deleted file mode 100644 index 843080da..00000000 --- a/src/main/java/org/springframework/data/couchbase/config/AbstractReactiveCouchbaseConfiguration.java +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Copyright 2017-2020 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.springframework.data.couchbase.config; - -import java.util.List; - -import com.couchbase.client.java.Bucket; -import com.couchbase.client.java.Cluster; -import com.couchbase.client.java.CouchbaseCluster; -import com.couchbase.client.java.cluster.ClusterInfo; -import com.couchbase.client.java.env.CouchbaseEnvironment; -import com.couchbase.client.java.env.DefaultCouchbaseEnvironment; - -import java.lang.reflect.Proxy; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -/** - * - * Base class for Reactive Spring Data Couchbase configuration java config - * - * @author Subhashni Balakrishnan - */ -@Configuration -public abstract class AbstractReactiveCouchbaseConfiguration - extends AbstractReactiveCouchbaseDataConfiguration implements CouchbaseConfigurer { - - /** - * The list of hostnames (or IP addresses) to bootstrap from. - * - * @return the list of bootstrap hosts. - */ - protected abstract List{@value BeanNames#COUCHBASE_CLUSTER} is used.
- *
- * See attributes {@link #CLUSTER_REF_ATTR}, {@link #BUCKETNAME_ATTR}, {@link #USERNAME_ATTR} and {@link #BUCKETPASSWORD_ATTR}.
- *
- * @author Simon Baslé
- */
-public class CouchbaseBucketParser extends AbstractSingleBeanDefinitionParser {
-
- /**
- * The cluster-ref attribute in a bucket definition defines the cluster to build from.
- */
- public static final String CLUSTER_REF_ATTR = "cluster-ref";
-
- /**
- * The bucketName attribute in a bucket definition defines the name of the bucket to open.
- */
- public static final String BUCKETNAME_ATTR = "bucketName";
-
- /*
- * The username attribute in a bucket definition defines the user of the bucket to open.
- */
- public static final String USERNAME_ATTR = "username";
-
- /**
- * The bucketPassword attribute in a bucket definition defines the password of the bucket/user of the bucket to open.
- */
- public static final String BUCKETPASSWORD_ATTR = "bucketPassword";
-
- /**
- * Resolve the bean ID and assign a default if not set.
- *
- * @param element the XML element which contains the attributes.
- * @param definition the bean definition to work with.
- * @param parserContext encapsulates the parsing state and configuration.
- * @return the ID to work with.
- */
- @Override
- protected String resolveId(final Element element, final AbstractBeanDefinition definition, final ParserContext parserContext) {
- String id = super.resolveId(element, definition, parserContext);
- return StringUtils.hasText(id) ? id : BeanNames.COUCHBASE_BUCKET;
- }
-
- /**
- * Defines the bean class that will be constructed.
- *
- * @param element the XML element which contains the attributes.
- * @return the class type to instantiate.
- */
- @Override
- protected Class getBeanClass(final Element element) {
- return CouchbaseBucketFactoryBean.class;
- }
-
- /**
- * Parse the bean definition and build up the bean.
- *
- * @param element the XML element which contains the attributes.
- * @param builder the builder which builds the bean.
- */
- @Override
- protected void doParse(final Element element, final BeanDefinitionBuilder builder) {
- String clusterRef = element.getAttribute(CLUSTER_REF_ATTR);
- if (!StringUtils.hasText(clusterRef)) {
- clusterRef = BeanNames.COUCHBASE_CLUSTER;
- }
- builder.addConstructorArgReference(clusterRef);
-
- String bucketName = element.getAttribute(BUCKETNAME_ATTR);
- if (StringUtils.hasText(bucketName)) {
- builder.addConstructorArgValue(bucketName);
- }
-
- String username = element.getAttribute(USERNAME_ATTR);
- if (StringUtils.hasText(username)) {
- builder.addConstructorArgValue(username);
- }
-
- String password = element.getAttribute(BUCKETPASSWORD_ATTR);
- if (StringUtils.hasText(password)) {
- builder.addConstructorArgValue(password);
- }
- }
-}
diff --git a/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterInfoFactoryBean.java b/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterInfoFactoryBean.java
deleted file mode 100644
index e1668a66..00000000
--- a/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterInfoFactoryBean.java
+++ /dev/null
@@ -1,61 +0,0 @@
-/*
- * Copyright 2012-2020 the original author or authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.data.couchbase.config;
-
-import com.couchbase.client.java.Cluster;
-import com.couchbase.client.java.cluster.ClusterInfo;
-
-import org.springframework.beans.factory.config.AbstractFactoryBean;
-import org.springframework.dao.DataAccessException;
-import org.springframework.dao.support.PersistenceExceptionTranslator;
-import org.springframework.data.couchbase.core.CouchbaseExceptionTranslator;
-
-/**
- * The Factory Bean to help {@link CouchbaseClusterInfoParser} constructing a {@link ClusterInfo} from a given
- * {@link Cluster} reference.
- *
- * @author Simon Baslé
- */
-public class CouchbaseClusterInfoFactoryBean extends AbstractFactoryBean{@value BeanNames#COUCHBASE_CLUSTER_INFO} is used.
- *
- * See attributes {@link #CLUSTER_REF_ATTR}, {@link #LOGIN_ATTR} and {@link #PASSWORD_ATTR}.
- *
- * @author Simon Baslé
- */
-public class CouchbaseClusterInfoParser extends AbstractSingleBeanDefinitionParser {
-
- /**
- * The cluster-ref attribute in a cluster info definition defines the cluster to build from.
- */
- public static final String CLUSTER_REF_ATTR = "cluster-ref";
-
- /**
- * The login attribute in a cluster info definition defines the credential to use (can also be a
- * bucket level credential).
- */
- public static final String LOGIN_ATTR = "login";
-
- /**
- * The password attribute in a cluster info definition defines the credential's password.
- */
- public static final String PASSWORD_ATTR = "password";
-
- /**
- * Resolve the bean ID and assign a default if not set.
- *
- * @param element the XML element which contains the attributes.
- * @param definition the bean definition to work with.
- * @param parserContext encapsulates the parsing state and configuration.
- * @return the ID to work with.
- */
- @Override
- protected String resolveId(final Element element, final AbstractBeanDefinition definition, final ParserContext parserContext) {
- String id = super.resolveId(element, definition, parserContext);
- return StringUtils.hasText(id) ? id : BeanNames.COUCHBASE_CLUSTER_INFO;
- }
-
- /**
- * Defines the bean class that will be constructed.
- *
- * @param element the XML element which contains the attributes.
- * @return the class type to instantiate.
- */
- @Override
- protected Class getBeanClass(final Element element) {
- return CouchbaseClusterInfoFactoryBean.class;
- }
-
- /**
- * Parse the bean definition and build up the bean.
- *
- * @param element the XML element which contains the attributes.
- * @param builder the builder which builds the bean.
- */
- @Override
- protected void doParse(final Element element, final BeanDefinitionBuilder builder) {
- String clusterRef = element.getAttribute(CLUSTER_REF_ATTR);
- if (!StringUtils.hasText(clusterRef)) {
- clusterRef = BeanNames.COUCHBASE_CLUSTER;
- }
- builder.addConstructorArgReference(clusterRef);
-
- String login = element.getAttribute(LOGIN_ATTR);
- if (!StringUtils.hasText(login)) {
- login = "default";
- }
- builder.addConstructorArgValue(login);
-
- String password = element.getAttribute(PASSWORD_ATTR);
- if (!StringUtils.hasText(password)) {
- password = "";
- }
- builder.addConstructorArgValue(password);
- }
-}
diff --git a/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterParser.java b/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterParser.java
deleted file mode 100644
index 79b14629..00000000
--- a/src/main/java/org/springframework/data/couchbase/config/CouchbaseClusterParser.java
+++ /dev/null
@@ -1,156 +0,0 @@
-/*
- * Copyright 2012-2020 the original author or authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.data.couchbase.config;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import com.couchbase.client.java.Cluster;
-import com.couchbase.client.java.CouchbaseCluster;
-import com.couchbase.client.java.env.CouchbaseEnvironment;
-import org.w3c.dom.Element;
-
-import org.springframework.beans.factory.support.AbstractBeanDefinition;
-import org.springframework.beans.factory.support.BeanDefinitionBuilder;
-import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
-import org.springframework.beans.factory.xml.ParserContext;
-import org.springframework.util.StringUtils;
-import org.springframework.util.xml.DomUtils;
-
-/**
- * The XML parser for a {@link Cluster} definition.
- *
- * Such a definition can be tuned by either referencing a {@link CouchbaseEnvironment} via
- * the {@value #CLUSTER_ENVIRONMENT_REF} attribute or define a custom environment inline via
- * the <{@value #CLUSTER_ENVIRONMENT_TAG}> tag (not recommended, environments should be
- * shared as possible). If no environment reference or inline description is provided, the
- * default environment reference {@value BeanNames#COUCHBASE_ENV} is used.
- *
- * To bootstrap the connection, one can provide IPs or hostnames of nodes to connect to
- * via 1 or more <{@value #CLUSTER_NODE_TAG}> tags.
- *
- * @author Simon Baslé
- */
-public class CouchbaseClusterParser extends AbstractSingleBeanDefinitionParser {
-
- /**
- * The <node> elements in a cluster definition define the bootstrap hosts to use
- */
- public static final String CLUSTER_NODE_TAG = "node";
-
- /**
- * The unique <env> element in a cluster definition define the environment customizations.
- *
- * @see CouchbaseEnvironmentParser CouchbaseEnvironmentParser for the possible fields.
- * @see #CLUSTER_ENVIRONMENT_REF CLUSTER_ENVIRONMENT_REF as an alternative (giving a reference to
- * an env instead of inline description, lower precedence)
- */
- public static final String CLUSTER_ENVIRONMENT_TAG = "env";
-
- /**
- * The <env-ref> attribute allows to use a reference to an {@link CouchbaseEnvironment} to
- * tune the connection.
- *
- * @see #CLUSTER_ENVIRONMENT_TAG CLUSTER_ENVIRONMENT_TAG for an inline alternative
- * (which takes priority over this reference)
- */
- public static final String CLUSTER_ENVIRONMENT_REF = "env-ref";
-
- /**
- * Resolve the bean ID and assign a default if not set.
- *
- * @param element the XML element which contains the attributes.
- * @param definition the bean definition to work with.
- * @param parserContext encapsulates the parsing state and configuration.
- * @return the ID to work with.
- */
- @Override
- protected String resolveId(final Element element, final AbstractBeanDefinition definition, final ParserContext parserContext) {
- String id = super.resolveId(element, definition, parserContext);
- return StringUtils.hasText(id) ? id : BeanNames.COUCHBASE_CLUSTER;
- }
-
- /**
- * Defines the bean class that will be constructed.
- *
- * @param element the XML element which contains the attributes.
- * @return the class type to instantiate.
- */
- @Override
- protected Class getBeanClass(final Element element) {
- return CouchbaseCluster.class;
- }
-
- /**
- * Parse the bean definition and build up the bean.
- *
- * @param element the XML element which contains the attributes.
- * @param bean the builder which builds the bean.
- */
- @Override
- protected void doParse(final Element element, final BeanDefinitionBuilder bean) {
- bean.setFactoryMethod("create");
- bean.setDestroyMethodName("disconnect");
-
- parseEnvironment(bean, element);
-
- ListSo if you have a {@code com.acme.AppConfig} extending {@link AbstractCouchbaseConfiguration} the base package - * will be considered {@code com.acme} unless the method is overridden to implement alternate behavior.
- * - * @return the base package to scan for mapped {@link Document} classes or {@literal null} to not enable scanning for - * entities. - */ - protected String getMappingBasePackage() { - return getClass().getPackage().getName(); - } - - /** - * Set to true if field names should be abbreviated with the {@link CamelCaseAbbreviatingFieldNamingStrategy}. - * - * @return true if field names should be abbreviated, default is false. - */ - protected boolean abbreviateFieldNames() { - return false; - } - - /** - * Configures a {@link FieldNamingStrategy} on the {@link CouchbaseMappingContext} instance created. - * - * @return the naming strategy. - */ - protected FieldNamingStrategy fieldNamingStrategy() { - return abbreviateFieldNames() ? new CamelCaseAbbreviatingFieldNamingStrategy() : PropertyNameFieldNamingStrategy.INSTANCE; - } - - /** - * Configures the default consistency for generated {@link ViewQuery view queries} - * and {@link N1qlQuery N1QL queries} in repositories. - * - * @return the {@link Consistency consistency} to apply by default on generated queries. - */ - protected Consistency getDefaultConsistency() { - return Consistency.DEFAULT_CONSISTENCY; - } -} diff --git a/src/main/java/org/springframework/data/couchbase/config/CouchbaseConfigurer.java b/src/main/java/org/springframework/data/couchbase/config/CouchbaseConfigurer.java deleted file mode 100644 index 4d238f9b..00000000 --- a/src/main/java/org/springframework/data/couchbase/config/CouchbaseConfigurer.java +++ /dev/null @@ -1,50 +0,0 @@ -package org.springframework.data.couchbase.config; - -import com.couchbase.client.java.Bucket; -import com.couchbase.client.java.Cluster; -import com.couchbase.client.java.cluster.ClusterInfo; -import com.couchbase.client.java.env.CouchbaseEnvironment; - -import org.springframework.data.couchbase.core.CouchbaseOperations; - -/** - * Strategy interface for users to provide as a factory for custom components needed - * by the Couchbase integration. - * - * This allows to centralize instantiation of Couchbase SDK core elements. - * - * @author Stephane Nicoll - */ -public interface CouchbaseConfigurer { - - /** - * Set up the underlying main {@link CouchbaseEnvironment}, allowing tuning of the Couchbase SDK. - * - * @throws Exception in case of error during the CouchbaseEnvironment instantiation. - */ - CouchbaseEnvironment couchbaseEnvironment() throws Exception; - - /** - * Set up the underlying main Couchbase {@link Cluster} reference to be used by the Spring Data framework - * when storing into Couchbase. - * - * @throws Exception in case of error during the Cluster instantiation. - */ - Cluster couchbaseCluster() throws Exception; - - /** - * Set up the underlying main {@link ClusterInfo}, allowing to check feature availability and cluster configuration. - * - * @throws Exception in case of error during the ClusterInfo instantiation. - */ - ClusterInfo couchbaseClusterInfo() throws Exception; - - /** - * Set up the underlying main {@link Bucket}, the primary Couchbase SDK entry point to be used by the Spring Data - * framework for the {@link CouchbaseOperations}. - * - * @throws Exception in case of error during the bucket instantiation. - */ - Bucket couchbaseClient() throws Exception; - -} diff --git a/src/main/java/org/springframework/data/couchbase/config/CouchbaseEnvironmentFactoryBean.java b/src/main/java/org/springframework/data/couchbase/config/CouchbaseEnvironmentFactoryBean.java deleted file mode 100644 index de6351e0..00000000 --- a/src/main/java/org/springframework/data/couchbase/config/CouchbaseEnvironmentFactoryBean.java +++ /dev/null @@ -1,248 +0,0 @@ -/* - * Copyright 2012-2020 the original author or authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.springframework.data.couchbase.config; - -import com.couchbase.client.core.retry.BestEffortRetryStrategy; -import com.couchbase.client.core.retry.FailFastRetryStrategy; -import com.couchbase.client.core.retry.RetryStrategy; -import com.couchbase.client.java.env.CouchbaseEnvironment; -import com.couchbase.client.java.env.DefaultCouchbaseEnvironment; -import com.couchbase.client.java.env.DefaultCouchbaseEnvironment.Builder; - -import org.springframework.beans.factory.config.AbstractFactoryBean; - -/** - * Factory Bean to help create a CouchbaseEnvironment (by offering setters for supported tuning methods). - * - * @author Simon Baslé - * @author Simon Bland - * @author Subhashni Balakrishnan - */ -/*package*/ class CouchbaseEnvironmentFactoryBean extends AbstractFactoryBean
- * The following properties are supported:
When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be - * created.
- * - * @param objectToSave the object to store in the bucket. - */ - void save(Object objectToSave); + CouchbaseConverter getConverter(); - /** - * Save the given object. - * - *When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be - * created.
- * - * @param objectToSave the object to store in the bucket. - */ - void save(Object objectToSave, PersistTo persistTo, ReplicateTo replicateTo); + String getBucketName(); - /** - * Save a list of objects. - * - *When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it - * will be created.
- * - * @param batchToSave the list of objects to store in the bucket. - */ - void save(Collection batchToSave); + String getScopeName(); - /** - * Save a list of objects. - * - *When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it - * will be created.
- * - * @param batchToSave the list of objects to store in the bucket. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void save(Collection batchToSave, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Insert the given object. - * - *When the document already exists (specified by its unique id), then it will not be overriden. Use the - * {@link CouchbaseOperations#save} method for this task.
- * - * @param objectToInsert the object to add to the bucket. - */ - void insert(Object objectToInsert); - - /** - * Insert the given object. - * - *When the document already exists (specified by its unique id), then it will not be overriden. Use the - * {@link CouchbaseOperations#save} method for this task.
- * - * @param objectToInsert the object to add to the bucket. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void insert(Object objectToInsert, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Insert a list of objects. - * - *When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param batchToInsert the list of objects to add to the bucket. - */ - void insert(Collection batchToInsert); - - /** - * Insert a list of objects. - * - *When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param batchToInsert the list of objects to add to the bucket. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void insert(Collection batchToInsert, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Update the given object. - * - *When the document does not exist (specified by its unique id) it will not be created. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param objectToUpdate the object to add to the bucket. - */ - void update(Object objectToUpdate); - - /** - * Update the given object. - * - *When the document does not exist (specified by its unique id) it will not be created. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param objectToUpdate the object to add to the bucket. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void update(Object objectToUpdate, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Insert a list of objects. - * - *If one of the documents does not exist (specified by its unique id), then it will not be created. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param batchToUpdate the list of objects to add to the bucket. - */ - void update(Collection batchToUpdate); - - /** - * Insert a list of objects. - * - *If one of the documents does not exist (specified by its unique id), then it will not be created. Use the - * {@link CouchbaseOperations#save} method for this.
- * - * @param batchToUpdate the list of objects to add to the bucket. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void update(Collection batchToUpdate, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Find an object by its given Id and map it to the corresponding entity. - * - * @param id the unique ID of the document. - * @param entityClass the entity to map to. - * @return returns the found object or null otherwise. - */ -There is no need to {@link ViewQuery#includeDocs(boolean) set includeDocs} explicitly, since this method will - * manage the retrieval of documents internally. It is valid to pass in a empty constructed {@link ViewQuery} object.
- * - *Weak consistency in the query (stale(Stale.TRUE)) can lead to some documents being unreachable due
- * to their deletion not having been indexed. These deleted null documents are eliminated from the result of this
- * method.
This method does not work with reduced views, because they by design do not contain references to original - * objects. Use the provided {@link #queryView} method for more flexibility and direct access.
- * - * @param query the Query object (also specifying view design document and view name). - * @param entityClass the entity to map to. - * @return the converted collection - */ -This method is available to ease the working with views by still wrapping exceptions into the Spring - * infrastructure.
- *It is especially needed if you want to run reduced viewName queries, because they can't be mapped onto entities - * directly.
- * - * @param query the Query object (also specifying view design document and view name). - * @return ViewResult containing the results of the query. - */ - ViewResult queryView(ViewQuery query); - - /** - * Query a Spatial View for a list of documents of type T. - * - *There is no need to {@link SpatialViewQuery#includeDocs(boolean) set includeDocs} explicitly, since this method - * will manage the retrieval of documents internally. It is valid to pass in a empty constructed {@link SpatialViewQuery} object.
- * - *Weak consistency in the query (stale(Stale.TRUE)) can lead to some documents being unreachable due
- * to their deletion not having been indexed. These deleted null documents are eliminated from the result of this
- * method.
This method is available to ease the working with spatial views by still wrapping exceptions into the Spring - * infrastructure.
- * - * @param query the SpatialViewQuery object (also specifying view design document and view name). - * @return SpatialViewResult containing the results of the query. - */ - SpatialViewResult querySpatialView(SpatialViewQuery query); - - /** - * Query the N1QL Service for JSON data of type T. Enough data to construct the full - * entity is expected to be selected, including the metadata (document id and cas), obtained through N1QL's query. - *This is done via a {@link N1qlQuery} that contains a {@link Statement} and possibly
- * additional query parameters ({@link N1qlParams}) and placeholder values if the
- * statement contains placeholders.
- *
- * Use {@link N1qlQuery}'s factory methods to construct such a Query.
Weak consistency in the query (eg. ScanConsistency.NOT_BOUND) can lead to some documents being
- * unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the
- * result of this method.
This is done via a {@link N1qlQuery} that contains a {@link Statement} and possibly
- * additional query parameters ({@link N1qlParams}) and placeholder values if the
- * statement contains placeholders.
- *
- * Use {@link N1qlQuery}'s factory methods to construct such a Query.
Weak consistency in the query (eg. ScanConsistency.NOT_BOUND) can lead to some documents being
- * unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the
- * result of this method.
- * This is done via a {@link N1qlQuery} that can - * contain a {@link Statement}, additional query parameters ({@link N1qlParams}) - * and placeholder values if the statement contains placeholders.
- *- * Use {@link N1qlQuery}'s factory methods to construct this.
- * - * @param n1ql the N1QL query. - * @return {@link N1qlQueryResult} containing the results of the n1ql query. - */ - N1qlQueryResult queryN1QL(N1qlQuery n1ql); - - /** - * Checks if the given document exists. - * - * @param id the unique ID of the document. - * @return whether the document could be found or not. - */ - boolean exists(String id); - - /** - * Remove the given object from the bucket by id. - * - * If the object is a String, it will be treated as the document key - * directly. - * - * @param objectToRemove the Object to remove. - */ - void remove(Object objectToRemove); - - /** - * Remove the given object from the bucket by id. - * - * If the object is a String, it will be treated as the document key - * directly. - * - * @param objectToRemove the Object to remove. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void remove(Object objectToRemove, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Remove a list of objects from the bucket by id. - * - * @param batchToRemove the list of Objects to remove. - */ - void remove(Collection batchToRemove); - - /** - * Remove a list of objects from the bucket by id. - * - * @param batchToRemove the list of Objects to remove. - * @param persistTo the persistence constraint setting. - * @param replicateTo the replication constraint setting. - */ - void remove(Collection batchToRemove, PersistTo persistTo, ReplicateTo replicateTo); - - /** - * Executes a BucketCallback translating any exceptions as necessary. - * - * Allows for returning a result object, that is a domain object or a collection of domain objects. - * - * @param action the action to execute in the callback. - * @param