Skip to content

Commit

Permalink
DATACOUCH-6 - add support for xml-based configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
daschl committed Jul 16, 2013
1 parent dd9c3ed commit 2ed710c
Show file tree
Hide file tree
Showing 6 changed files with 412 additions and 1 deletion.
@@ -0,0 +1,41 @@
/*
* Copyright 2013 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 org.springframework.beans.factory.xml.NamespaceHandlerSupport;
import org.springframework.data.couchbase.repository.config.CouchbaseRepositoryConfigurationExtension;
import org.springframework.data.repository.config.RepositoryBeanDefinitionParser;
import org.springframework.data.repository.config.RepositoryConfigurationExtension;

/**
* {@link org.springframework.beans.factory.xml.NamespaceHandler} for Couchbase configuration.
*
* @author Michael Nitschinger
*/
public class CouchbaseNamespaceHandler extends NamespaceHandlerSupport {

public void init() {
RepositoryConfigurationExtension extension = new CouchbaseRepositoryConfigurationExtension();
RepositoryBeanDefinitionParser repositoryBeanDefinitionParser = new RepositoryBeanDefinitionParser(extension);

registerBeanDefinitionParser("repositories", repositoryBeanDefinitionParser);
registerBeanDefinitionParser("mongo", new CouchbaseParser());
registerBeanDefinitionParser("jmx", new CouchbaseJmxParser());
registerBeanDefinitionParser("template", new CouchbaseTemplateParser());
}

}
@@ -0,0 +1,48 @@
/*
* Copyright 2013 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 com.couchbase.client.CouchbaseClient;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.data.config.BeanComponentDefinitionBuilder;
import org.springframework.data.config.ParsingUtils;
import org.w3c.dom.Element;

/**
* Parser for "<couchbase>" definitions.
*
* @author Michael Nitschinger
*/
public class CouchbaseParser implements BeanDefinitionParser {

@Override
public BeanDefinition parse(final Element element, final ParserContext parserContext) {
Object source = parserContext.extractSource(element);
String id = element.getAttribute("id");

BeanComponentDefinitionBuilder helper = new BeanComponentDefinitionBuilder(element, parserContext);

BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(CouchbaseClient.class);
builder.s
ParsingUtils.setPropertyValue(builder, element, "port", "port");
ParsingUtils.setPropertyValue(builder, element, "host", "host");

}
}
@@ -0,0 +1,136 @@
/*
* Copyright 2013 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.core;

import com.couchbase.client.CouchbaseClient;
import com.couchbase.client.CouchbaseConnectionFactory;
import com.couchbase.client.CouchbaseConnectionFactoryBuilder;
import net.spy.memcached.FailureMode;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.support.PersistenceExceptionTranslator;

import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
* Convenient Factory for configuring Couchbase.
*
* @author Michael Nitschinger
*/
public class CouchbaseFactoryBean implements FactoryBean<CouchbaseClient>, InitializingBean,
DisposableBean, PersistenceExceptionTranslator{

public static final String DEFAULT_NODE = "127.0.0.1";
public static final String DEFAULT_BUCKET = "default";
public static final String DEFAULT_PASSWORD = "";

private CouchbaseClient couchbaseClient;
private PersistenceExceptionTranslator exceptionTranslator = new CouchbaseExceptionTranslator();
private String bucket;
private String password;
private List<URI> nodes;
private CouchbaseConnectionFactoryBuilder builder = new CouchbaseConnectionFactoryBuilder();

public void setObservePollInterval(final int interval) {
builder.setObsPollInterval(interval);
}

public void setObservePollMax(final int max) {
builder.setObsPollMax(max);
}

public void setReconnectThresholdTime(final int time) {
builder.setReconnectThresholdTime(time, TimeUnit.SECONDS);
}

public void setViewTimeout(final int timeout) {
builder.setViewTimeout(timeout);
}

public void setFailureMode(final String mode) {
builder.setFailureMode(FailureMode.valueOf(mode));
}

public void setOpTimeout(final int timeout) {
builder.setOpTimeout(timeout);
}

public void setOpQueueMaxBlockTime(final int time) {
builder.setOpQueueMaxBlockTime(time);
}

@Override
public void destroy() throws Exception {
couchbaseClient.shutdown();
}

@Override
public CouchbaseClient getObject() throws Exception {
return couchbaseClient;
}

@Override
public Class<?> getObjectType() {
return CouchbaseClient.class;
}

@Override
public boolean isSingleton() {
return true;
}

public void setNodes(final URI[] nodes) {
this.nodes = filterNonNullElementsAsList(nodes);
}

private <T> List<T> filterNonNullElementsAsList(T[] elements) {
if (elements == null) {
return Collections.emptyList();
}

List<T> candidateElements = new ArrayList<T>();
for (T element : elements) {
if (element != null) {
candidateElements.add(element);
}
}

return Collections.unmodifiableList(candidateElements);
}

@Override
public void afterPropertiesSet() throws Exception {
nodes = nodes != null ? nodes : Arrays.asList(new URI("http://" + DEFAULT_NODE + ":8091/pools"));
bucket = bucket != null ? bucket : DEFAULT_BUCKET;
password = password != null ? password : DEFAULT_PASSWORD;

CouchbaseConnectionFactory factory = builder.buildCouchbaseConnection(nodes, bucket, password);
couchbaseClient = new CouchbaseClient(factory);
}

@Override
public DataAccessException translateExceptionIfPossible(final RuntimeException ex) {
return exceptionTranslator.translateExceptionIfPossible(ex);
}
}
Expand Up @@ -28,9 +28,122 @@ Defines a CouchbaseClient instance used for accessing a Couchbase Cluster.
</xsd:annotation>
</xsd:element>

<!-- nodes -->
<xsd:element name="repositories">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="repository:repositories">
<xsd:attributeGroup ref="couchbase-repository-attributes"/>
<xsd:attributeGroup ref="repository:repository-attributes"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>

<xsd:element name="template">
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
The name of the couchbase definition (by default "couchbaseFactory").]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="converter-ref" type="converterRef" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
The reference to a CouchbaseConverter instance.
]]>
</xsd:documentation>
<xsd:appinfo>
<tool:annotation kind="ref">
<tool:assignable-to type="org.springframework.data.couchbase.core.convert.CouchbaseConverter"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="db-ref" type="xsd:string"
use="optional">
<xsd:annotation>
<xsd:documentation>
The reference to a CouchbaseClient object.
</xsd:documentation>
<xsd:appinfo>
<tool:annotation kind="ref">
<tool:assignable-to
type="com.couchbase.client.CouchbaseClient" />
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>

<xsd:element name="jmx">
<xsd:annotation>
<xsd:documentation><![CDATA[
Defines a JMX Model MBeans for monitoring a Couchbase cluster'.
]]></xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="couchbase-ref" type="couchbaseRef" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
The name of the Couchbase object that determines what connection to monitor. (by default "couchbase").
]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>

<xsd:simpleType name="converterRef">
<xsd:annotation>
<xsd:appinfo>
<tool:annotation kind="ref">
<tool:assignable-to type="org.springframework.data.couchbase.core.convert.CouchbaseConverter"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
<xsd:union memberTypes="xsd:string"/>
</xsd:simpleType>

<xsd:simpleType name="couchbaseTemplateRef">
<xsd:annotation>
<xsd:appinfo>
<tool:annotation kind="ref">
<tool:assignable-to type="org.springframework.data.couchbase.core.CouchbaseTemplate"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
<xsd:union memberTypes="xsd:string"/>
</xsd:simpleType>

<xsd:simpleType name="couchbaseRef">
<xsd:annotation>
<xsd:appinfo>
<tool:annotation kind="ref">
<tool:assignable-to type="org.springframework.data.couchbase.core.CouchbaseFactoryBean"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
<xsd:union memberTypes="xsd:string"/>
</xsd:simpleType>

<xsd:attributeGroup name="couchbase-repository-attributes">
<xsd:attribute name="couchbase-template-ref" type="couchbaseTemplateRef" default="couchbaseTemplate">
<xsd:annotation>
<xsd:documentation>
The reference to a CouchbaseTemplate. Will default to 'couchbaseTemplate'.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:attributeGroup>

<xsd:complexType name="couchbaseType">
<xsd:attribute name="id" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
The name of the couchbase definition (by default "couchbase").]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="bucket" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
Expand All @@ -45,6 +158,13 @@ The password of the bucket to connect to. Default is "" (empty).
]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="host" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation><![CDATA[
The host to connect to a Couchbase server. Default is localhost.
]]></xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>


Expand Down

0 comments on commit 2ed710c

Please sign in to comment.