Merge pull request #41 from simonbasle/configuration

basic configuration (xml parsers and @configuration)

Author: simonbasle

src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java

@@ -0,0 +1,193 @@
+/*
+ * Copyright 2012-2015 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
+ *
+ *        http://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.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import com.couchbase.client.java.Bucket;
+import com.couchbase.client.java.Cluster;
+import com.couchbase.client.java.CouchbaseCluster;
+import com.couchbase.client.java.env.CouchbaseEnvironment;
+import com.couchbase.client.java.env.DefaultCouchbaseEnvironment;
+
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.ConfigurationCondition;
+import org.springframework.core.type.filter.AnnotationTypeFilter;
+import org.springframework.data.annotation.Persistent;
+import org.springframework.data.couchbase.core.CouchbaseTemplate;
+import org.springframework.data.couchbase.core.mapping.Document;
+import org.springframework.data.mapping.model.CamelCaseAbbreviatingFieldNamingStrategy;
+import org.springframework.data.mapping.model.FieldNamingStrategy;
+import org.springframework.data.mapping.model.PropertyNameFieldNamingStrategy;
+import org.springframework.util.ClassUtils;
+import org.springframework.util.StringUtils;
+
+/**
+ * Base class for Spring Data Couchbase configuration using JavaConfig.
+ *
+ * @author Michael Nitschinger
+ * @author Simon Baslé
+ */
+@Configuration
+public abstract class AbstractCouchbaseConfiguration {
+
+	/**
+	 * The list of hostnames (or IP addresses) to bootstrap from.
+	 *
+	 * @return the list of bootstrap hosts.
+	 */
+	protected abstract List<String> getBootstrapHosts();
+
+	/**
+	 * The name of the bucket to connect to.
+	 *
+	 * @return the name of the bucket.
+	 */
+	protected abstract String getBucketName();
+
+	/**
+	 * The password of the bucket (can be an empty string).
+	 *
+	 * @return the password of the bucket.
+	 */
+	protected abstract String getBucketPassword();
+
+	/**
+	 * Is the {@link #getEnvironment()} to be destroyed by Spring?
+	 *
+	 * @return true if Spring should destroy the environment with the context, false otherwise.
+	 */
+	protected boolean isEnvironmentManagedBySpring() {
+		return true;
+	}
+
+	/**
+	 * Override this method if you want a customized {@link CouchbaseEnvironment}.
+	 * This environment will be managed by Spring, which will call its shutdown()
+	 * method upon bean destruction, unless you override {@link #isEnvironmentManagedBySpring()}
+	 * as well to return false.
+	 *
+	 * @return a customized environment, defaults to a {@link DefaultCouchbaseEnvironment}.
+	 */
+	protected CouchbaseEnvironment getEnvironment() {
+		return DefaultCouchbaseEnvironment.create();
+	}
+
+	@Bean(destroyMethod = "shutdown", name = BeanNames.COUCHBASE_ENV)
+	public CouchbaseEnvironment couchbaseEnvironment() {
+		CouchbaseEnvironment env = getEnvironment();
+		if (isEnvironmentManagedBySpring()) {
+			return env;
+		}
+		return new CouchbaseEnvironmentNoShutdownProxy(env);
+	}
+
+	/**
+	 * Returns the {@link Cluster} instance to connect to.
+	 *
+	 * @throws Exception on Bean construction failure.
+	 */
+	@Bean(destroyMethod = "disconnect", name = BeanNames.COUCHBASE_CLUSTER)
+	public Cluster couchbaseCluster() throws Exception {
+		return CouchbaseCluster.create(couchbaseEnvironment(), getBootstrapHosts());
+	}
+
+	/**
+	 * Return the {@link Bucket} instance to connect to.
+	 *
+	 * @throws Exception on Bean construction failure.
+	 */
+	@Bean(destroyMethod = "close", name = BeanNames.COUCHBASE_BUCKET)
+	public Bucket couchbaseClient() throws Exception {
+		//@Bean method can use another @Bean method in the same @Configuration by directly invoking it
+		return couchbaseCluster().openBucket(getBucketName(), getBucketPassword());
+	}
+
+	/**
+	 * Creates a {@link CouchbaseTemplate}.
+	 *
+	 * @throws Exception on Bean construction failure.
+	 */
+	@Bean(name = BeanNames.COUCHBASE_TEMPLATE)
+	public CouchbaseTemplate couchbaseTemplate() throws Exception {
+		//TODO use mappingCouchbaseConverter and translationService when implemented
+		return new CouchbaseTemplate(couchbaseClient());
+	}
+
+	//TODO create beans for mappingCouchbaseConverter, translationService, couchbaseMappingContext when implemented
+	//TODO for mappingCouchbaseConverter, allow registering of customConversions
+
+	/**
+	 * Scans the mapping base package for classes annotated with {@link Document}.
+	 *
+	 * @throws ClassNotFoundException if initial entity sets could not be loaded.
+	 */
+	protected Set<Class<?>> getInitialEntitySet() throws ClassNotFoundException {
+		String basePackage = getMappingBasePackage();
+		Set<Class<?>> initialEntitySet = new HashSet<Class<?>>();
+
+		if (StringUtils.hasText(basePackage)) {
+			ClassPathScanningCandidateComponentProvider componentProvider = new ClassPathScanningCandidateComponentProvider(false);
+			componentProvider.addIncludeFilter(new AnnotationTypeFilter(Document.class));
+			componentProvider.addIncludeFilter(new AnnotationTypeFilter(Persistent.class));
+			for (BeanDefinition candidate : componentProvider.findCandidateComponents(basePackage)) {
+				initialEntitySet.add(ClassUtils.forName(candidate.getBeanClassName(), AbstractCouchbaseConfiguration.class.getClassLoader()));
+			}
+		}
+
+		return initialEntitySet;
+	}
+
+	/**
+	 * Return the base package to scan for mapped {@link Document}s. Will return the package name of the configuration
+	 * class (the concrete class, not this one here) by default.
+	 * <p/>
+	 * <p>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.</p>
+	 *
+	 * @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 CouchbaseMappingContext instance created.
+	 *
+	 * @return the naming strategy.
+	 */
+	protected FieldNamingStrategy fieldNamingStrategy() {
+		//TODO implement a CouchbaseMappingContext, use this method (update link in javadoc)
+		return abbreviateFieldNames() ? new CamelCaseAbbreviatingFieldNamingStrategy() : PropertyNameFieldNamingStrategy.INSTANCE;
+	}
+}

src/main/java/org/springframework/data/couchbase/config/BeanNames.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2012-2015 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
+ *
+ *        http://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;
+
+/**
+ * Contains default bean names that will be used when no "id" is supplied to the beans.
+ *
+ * @author Michael Nitschinger
+ * @author Simon Baslé
+ */
+public class BeanNames {
+
+	/**
+	 * Refers to the <couchbase:env /> bean.
+	 */
+	static final String COUCHBASE_ENV = "couchbaseEnv";
+	/**
+	 * Refers to the "<couchbase:cluster />" bean.
+	 */
+	static final String COUCHBASE_CLUSTER = "couchbaseCluster";
+
+	/**
+	 * Refers to the "<couchbase:bucket />" bean.
+	 */
+	static final String COUCHBASE_BUCKET = "couchbaseBucket";
+
+	/**
+	 * Refers to the "<couchbase:template />" bean.
+	 */
+	static final String COUCHBASE_TEMPLATE = "couchbaseTemplate";
+
+	/**
+	 * Refers to the "<couchbase:translation-service />" bean
+	 */
+	static final String TRANSLATION_SERVICE = "couchbaseTranslationService";
+
+
+}