io.micronaut.configuration.jdbc.tomcat.DatasourceConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-jdbc-tomcat Show documentation
Projects to support SQL Database access in Micronaut
There is a newer version: 2.2.6
Show newest version
/*
 * Copyright 2017-2020 original 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 io.micronaut.configuration.jdbc.tomcat;

import io.micronaut.context.annotation.EachProperty;
import io.micronaut.context.annotation.Parameter;
import io.micronaut.core.convert.format.MapFormat;
import io.micronaut.core.naming.conventions.StringConvention;
import io.micronaut.jdbc.BasicJdbcConfiguration;
import io.micronaut.jdbc.CalculatedSettings;
import org.apache.tomcat.jdbc.pool.PoolProperties;

import javax.annotation.PostConstruct;
import java.util.Map;
import java.util.Properties;

/**
 * Allows the configuration of Tomcat JDBC data sources. All properties on
 * {@link PoolProperties} are available to be configured.
 *
 * If the url, driver class, username, or password are missing, sensible defaults
 * will be provided when possible. If no configuration beyond the datasource name
 * is provided, an in memory datasource will be configured based on the available
 * drivers on the classpath.
 *
 * @author James Kleeh
 * @since 1.0
 */
@EachProperty(value = BasicJdbcConfiguration.PREFIX, primary = "default")
public class DatasourceConfiguration extends PoolProperties implements BasicJdbcConfiguration {

    private CalculatedSettings calculatedSettings;

    /**
     * Constructor.
     * @param name name that comes from properties
     */
    public DatasourceConfiguration(@Parameter String name) {
        super();
        this.setName(name);
        this.calculatedSettings = new CalculatedSettings(this);
    }

    /**
     * After construction of the bean, call the getters.
     */
    @PostConstruct
    void postConstruct() {
        getDriverClassName();
        getUrl();
        getUsername();
        getPassword();
        getValidationQuery();
    }

    @Override
    public void setDbProperties(@MapFormat(keyFormat = StringConvention.UNDER_SCORE_SEPARATED) Properties dbProperties) {
        super.setDbProperties(dbProperties);
    }

    /**
     * @return The calculated driver class name
     */
    @Override
    public String getDriverClassName() {
        return calculatedSettings.getDriverClassName();
    }

    /**
     * @return The configured driver class name
     */
    @Override
    public String getConfiguredDriverClassName() {
        return super.getDriverClassName();
    }

    /**
     * @return The calculated URL
     */
    @Override
    public String getUrl() {
        return calculatedSettings.getUrl();
    }

    /**
     * @return The configured URL
     */
    @Override
    public String getConfiguredUrl() {
        return super.getUrl();
    }

    /**
     * @return The calculated username
     */
    @Override
    public String getUsername() {
        return calculatedSettings.getUsername();
    }

    /**
     * @return The configured username
     */
    @Override
    public String getConfiguredUsername() {
        return super.getUsername();
    }

    /**
     * @return The calculated password
     */
    @Override
    public String getPassword() {
        return calculatedSettings.getPassword();
    }

    /**
     * @return The configured password
     */
    @Override
    public String getConfiguredPassword() {
        return super.getPassword();
    }

    /**
     * @return The calculated validation query
     */
    @Override
    public String getValidationQuery() {
        return calculatedSettings.getValidationQuery();
    }

    @Override
    public void setDataSourceProperties(@MapFormat(transformation = MapFormat.MapTransformation.FLAT, keyFormat = StringConvention.RAW) Map dsProperties) {
        if (dsProperties != null) {
            Properties properties = new Properties();
            properties.putAll(dsProperties);
            setDbProperties(properties);
        }
    }

    /**
     * @return The configured validation query
     */
    @Override
    public String getConfiguredValidationQuery() {
        return super.getValidationQuery();
    }

    /**
     * @return The JNDI name
     */
    public String getJndiName() {
        return getDataSourceJNDI();
    }

    /**
     * @param jndiName Set the JDNI name
     */
    public void setJndiName(String jndiName) {
        setDataSourceJNDI(jndiName);
    }
}