org.springframework.jdbc.config.EmbeddedDatabaseBeanDefinitionParser Maven / Gradle / Ivy
/*
* Copyright 2002-2017 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.jdbc.config;
import org.w3c.dom.Element;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactoryBean;
import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
import org.springframework.util.StringUtils;
/**
* {@link org.springframework.beans.factory.xml.BeanDefinitionParser} that
* parses an {@code embedded-database} element and creates a {@link BeanDefinition}
* for an {@link EmbeddedDatabaseFactoryBean}.
*
* Picks up nested {@code script} elements and configures a
* {@link ResourceDatabasePopulator} for each of them.
*
* @author Oliver Gierke
* @author Juergen Hoeller
* @author Sam Brannen
* @since 3.0
* @see DatabasePopulatorConfigUtils
*/
class EmbeddedDatabaseBeanDefinitionParser extends AbstractBeanDefinitionParser {
/**
* Constant for the "database-name" attribute.
*/
static final String DB_NAME_ATTRIBUTE = "database-name";
/**
* Constant for the "generate-name" attribute.
*/
static final String GENERATE_NAME_ATTRIBUTE = "generate-name";
@Override
protected AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) {
BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(EmbeddedDatabaseFactoryBean.class);
setGenerateUniqueDatabaseNameFlag(element, builder);
setDatabaseName(element, builder);
setDatabaseType(element, builder);
DatabasePopulatorConfigUtils.setDatabasePopulator(element, builder);
builder.getRawBeanDefinition().setSource(parserContext.extractSource(element));
return builder.getBeanDefinition();
}
@Override
protected boolean shouldGenerateIdAsFallback() {
return true;
}
private void setGenerateUniqueDatabaseNameFlag(Element element, BeanDefinitionBuilder builder) {
String generateName = element.getAttribute(GENERATE_NAME_ATTRIBUTE);
if (StringUtils.hasText(generateName)) {
builder.addPropertyValue("generateUniqueDatabaseName", generateName);
}
}
private void setDatabaseName(Element element, BeanDefinitionBuilder builder) {
// 1) Check for an explicit database name
String name = element.getAttribute(DB_NAME_ATTRIBUTE);
// 2) Fall back to an implicit database name based on the ID
if (!StringUtils.hasText(name)) {
name = element.getAttribute(ID_ATTRIBUTE);
}
if (StringUtils.hasText(name)) {
builder.addPropertyValue("databaseName", name);
}
// else, let EmbeddedDatabaseFactory use the default "testdb" name
}
private void setDatabaseType(Element element, BeanDefinitionBuilder builder) {
String type = element.getAttribute("type");
if (StringUtils.hasText(type)) {
builder.addPropertyValue("databaseType", type);
}
}
}