org.springframework.data.couchbase.config

Class CouchbaseBucketParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

org.springframework.data.couchbase.config.CouchbaseBucketParser

All Implemented Interfaces:

BeanDefinitionParser

public class CouchbaseBucketParser
extends AbstractSingleBeanDefinitionParser

The parser for XML definition of a Bucket, to be constructed from a Cluster reference. If no reference is given, the default reference is used. See attributes CLUSTER_REF_ATTR, BUCKETNAME_ATTR, USERNAME_ATTR and BUCKETPASSWORD_ATTR.

Author:

Simon Baslé

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKETNAME_ATTR The bucketName attribute in a bucket definition defines the name of the bucket to open.
static String	BUCKETPASSWORD_ATTR The bucketPassword attribute in a bucket definition defines the password of the bucket/user of the bucket to open.
static String	CLUSTER_REF_ATTR The cluster-ref attribute in a bucket definition defines the cluster to build from.
static String	USERNAME_ATTR

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

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CouchbaseBucketParser()

Method Summary

Modifier and Type	Method and Description
protected void	doParse(Element element, BeanDefinitionBuilder builder) Parse the bean definition and build up the bean.
protected Class	getBeanClass(Element element) Defines the bean class that will be constructed.
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_REF_ATTR

public static final String CLUSTER_REF_ATTR

The cluster-ref attribute in a bucket definition defines the cluster to build from.

See Also:

Constant Field Values

BUCKETNAME_ATTR

public static final String BUCKETNAME_ATTR

The bucketName attribute in a bucket definition defines the name of the bucket to open.

See Also:

Constant Field Values

USERNAME_ATTR

public static final String USERNAME_ATTR

See Also:

Constant Field Values

BUCKETPASSWORD_ATTR

public static final String BUCKETPASSWORD_ATTR

The bucketPassword attribute in a bucket definition defines the password of the bucket/user of the bucket to open.

See Also:

Constant Field Values

Constructor Detail

CouchbaseBucketParser

public CouchbaseBucketParser()

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 builder)

Parse the bean definition and build up the bean.

Overrides:

doParse in class AbstractSingleBeanDefinitionParser

Parameters:

element - the XML element which contains the attributes.

builder - the builder which builds the bean.