org.springframework.data.couchbase.config

Class CouchbaseClusterParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

org.springframework.data.couchbase.config.CouchbaseClusterParser

All Implemented Interfaces:

BeanDefinitionParser

public class CouchbaseClusterParser
extends AbstractSingleBeanDefinitionParser

The XML parser for a Cluster definition. Such a definition can be tuned by either referencing a CouchbaseEnvironment via the "env-ref" attribute or define a custom environment inline via the <"env"> tag (not recommended, environments should be shared as possible). If no environment reference or inline description is provided, the default environment reference is used. To bootstrap the connection, one can provide IPs or hostnames of nodes to connect to via 1 or more <"node"> tags.

Author:

Simon Baslé

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_ENVIRONMENT_REF The <env-ref> attribute allows to use a reference to an CouchbaseEnvironment to tune the connection.
static String	CLUSTER_ENVIRONMENT_TAG The unique <env> element in a cluster definition define the environment customizations.
static String	CLUSTER_NODE_TAG The <node> elements in a cluster definition define the bootstrap hosts to use

Fields inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CouchbaseClusterParser()

Method Summary

Modifier and Type	Method and Description
protected void	doParse(Element element, BeanDefinitionBuilder bean) Parse the bean definition and build up the bean.
protected Class	getBeanClass(Element element) Defines the bean class that will be constructed.
protected void	injectEnvElement(BeanDefinitionBuilder clusterBuilder, Element envElement)
protected void	injectEnvReference(BeanDefinitionBuilder clusterBuilder, String envRef)
protected boolean	parseEnvironment(BeanDefinitionBuilder clusterBuilder, Element clusterElement)
protected String	resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext) Resolve the bean ID and assign a default if not set.

Methods inherited from class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse, getBeanClassName, getParentName, parseInternal

Methods inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

parse, postProcessComponentDefinition, registerBeanDefinition, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback, shouldParseNameAsAliases

Methods inherited from class java.lang.Object

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

Field Detail

CLUSTER_NODE_TAG

public static final String CLUSTER_NODE_TAG

The <node> elements in a cluster definition define the bootstrap hosts to use

See Also:

Constant Field Values

CLUSTER_ENVIRONMENT_TAG

public static final String CLUSTER_ENVIRONMENT_TAG

The unique <env> element in a cluster definition define the environment customizations.

See Also:

CouchbaseEnvironmentParser for the possible fields., CLUSTER_ENVIRONMENT_REF as an alternative (giving a reference to an env instead of inline description, lower precedence), Constant Field Values

CLUSTER_ENVIRONMENT_REF

public static final String CLUSTER_ENVIRONMENT_REF

The <env-ref> attribute allows to use a reference to an CouchbaseEnvironment to tune the connection.

See Also:

CLUSTER_ENVIRONMENT_TAG for an inline alternative (which takes priority over this reference), Constant Field Values

Constructor Detail

CouchbaseClusterParser

public CouchbaseClusterParser()

Method Detail

resolveId

protected String resolveId(Element element,
                           AbstractBeanDefinition definition,
                           ParserContext parserContext)

Resolve the bean ID and assign a default if not set.

Overrides:

resolveId in class AbstractBeanDefinitionParser

Parameters:

element - the XML element which contains the attributes.

definition - the bean definition to work with.

parserContext - encapsulates the parsing state and configuration.

Returns:

the ID to work with.

getBeanClass

protected Class getBeanClass(Element element)

Defines the bean class that will be constructed.

Overrides:

getBeanClass in class AbstractSingleBeanDefinitionParser

Parameters:

element - the XML element which contains the attributes.

Returns:

the class type to instantiate.

doParse

protected void doParse(Element element,
                       BeanDefinitionBuilder bean)

Parse the bean definition and build up the bean.

Overrides:

doParse in class AbstractSingleBeanDefinitionParser

Parameters:

element - the XML element which contains the attributes.

bean - the builder which builds the bean.

parseEnvironment

protected boolean parseEnvironment(BeanDefinitionBuilder clusterBuilder,
                                   Element clusterElement)

Returns:

true if a custom environment was parsed and injected (either reference or inline), false if the default environment reference was used.

injectEnvElement

protected void injectEnvElement(BeanDefinitionBuilder clusterBuilder,
                                Element envElement)

injectEnvReference

protected void injectEnvReference(BeanDefinitionBuilder clusterBuilder,
                                  String envRef)