org.bridje.jdbc.config.DataSourceConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Bridje Framework.
 *
 * 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.bridje.jdbc.config;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;

/**
 * Represents the configuration parameters needed to initialize a DataSource
 * object in the JdbcService. The changes to this object will not have any
 * effects once the DataSource is created.
 */
@XmlAccessorType(XmlAccessType.FIELD)
public class DataSourceConfig
{
    private String name;

    private String driver;

    private String url;

    private String user;

    private String password;

    private int maxConnections;

    private long idleTime;

    private int minConnections;

    private int reconnectTime;

    /**
     * Gets the name of the DataSource object that will be found by the
     * {@link org.bridje.jdbc.JdbcService#getDataSource} method.
     *
     * @return The name of the DataSource.
     */
    public String getName()
    {
        return name;
    }

    /**
     * Sets the name of the DataSource object that will be found by the
     * {@link org.bridje.jdbc.JdbcService#getDataSource} method.
     *
     * @param name The name of the DataSource.
     */
    public void setName(String name)
    {
        this.name = name;
    }

    /**
     * Gets the driver to be used for connecting the database. It must be a
     * valid jdbc driver class name. (ex: com.mysql.jdbc.Driver for MySQL
     * server).
     *
     * @return The jdbc driver for this DataSource.
     */
    public String getDriver()
    {
        return driver;
    }

    /**
     * Sets the driver to be use for connecting the database. It must be a valid
     * jdbc driver class name. (ex: com.mysql.jdbc.Driver for MySQL server).
     *
     * @param driver The jdbc driver for this DataSource.
     */
    public void setDriver(String driver)
    {
        this.driver = driver;
    }

    /**
     * Gets the jdbc url to connect to by this DataSource. It must be a valid
     * jdbc url connection string like (ex: jdbc:mysql://localhost:3306/books).
     *
     * @return The jdbc connection string to be use by this DataSource.
     */
    public String getUrl()
    {
        return url;
    }

    /**
     * Sets the jdbc url to connect to by this DataSource. It must be a valid
     * jdbc url connection string like (ex: jdbc:mysql://localhost:3306/books).
     *
     * @param url The jdbc connection string to be use by this DataSource.
     */
    public void setUrl(String url)
    {
        this.url = url;
    }

    /**
     * Gets the username to be used to authenticate to the database server.
     *
     * @return The username for the database server authentication.
     */
    public String getUser()
    {
        return user;
    }

    /**
     * Sets the username to be used to authenticate to the database server.
     *
     * @param user The username for the database server authentication.
     */
    public void setUser(String user)
    {
        this.user = user;
    }

    /**
     * Gets the password to be used to authenticate to the database server.
     *
     * @return The password for the database server authentication.
     */
    public String getPassword()
    {
        return password;
    }

    /**
     * Sets the password to be used to authenticate to the database server.
     *
     * @param password The password for the database server authentication.
     */
    public void setPassword(String password)
    {
        this.password = password;
    }

    /**
     * Gets the maximum number of configurations allowed in the datasource. If
     * the current total connections in the datasource reach this number, new
     * requests will have to wait for a new connection to be released.
     *
     * @return The maximum number of connections in the datasource.
     */
    public int getMaxConnections()
    {
        if (maxConnections <= 0)
        {
            maxConnections = 8;
        }
        return maxConnections;
    }

    /**
     * Sets the maximum number of configurations allowed in the datasource. If
     * the current total connections in the datasource reach this number, new
     * requests will have to wait for a new connection to be released.
     *
     * @param maxConnections The maximum number of connections in the datasource.
     */
    public void setMaxConnections(int maxConnections)
    {
        this.maxConnections = maxConnections;
    }

    /**
     * Gets the minimum time in seconds that a connection is unused in the
     * datasource to be considered idle and released.
     *
     * @return The minimum amount of seconds a connection can be unused before
     *         it is released.
     */
    public long getIdleTime()
    {
        if (idleTime <= 0)
        {
            idleTime = 600;
        }
        return idleTime;
    }

    /**
     * Sets the minimum time in seconds that a connection is unused in the
     * datasource to be considered idle and released.
     *
     * @param idleTime The minimum amount of seconds a connection can be unused
     *                 before it is released.
     */
    public void setIdleTime(long idleTime)
    {
        this.idleTime = idleTime;
    }

    /**
     * Gets the minimum amount of connections to keep in the datasource when
     * idle connections are released. Idle connections will be released from
     * the datasource but not all, a number of connections equals to this
     * parameter will be keep even if they are idle.
     *
     * @return The number of connections to keep in the datasource even if they
     *         are idle.
     */
    public int getMinConnections()
    {
        if (minConnections <= 0)
        {
            return 3;
        }
        return minConnections;
    }

    /**
     * Sets the minimum amount of connections to keep in the datasource when
     * idle connections are released. Idle connections will be released from
     * the datasource but not all, a number of connections equals to this
     * parameter will be keep even if they are idle.
     *
     * @param minConnections The number of connections to keep in the datasource
     *                       even if they are idle.
     */
    public void setMinConnections(int minConnections)
    {
        this.minConnections = minConnections;
    }

    /**
     * The time in seconds before the connection is tested to be discarded as
     * idle, and the framework tries to reconnect it again.
     *
     * @return An integer representing the time in seconds.
     */
    public int getReconnectTime()
    {
        if (reconnectTime <= 0)
        {
            return 600;
        }
        return reconnectTime;
    }

    /**
     * The time in seconds before the connection is tested to be discarded as
     * idle, and the framework tries to reconnect it again.
     *
     * @param reconnectTime An integer representing the time in seconds.
     */
    public void setReconnectTime(int reconnectTime)
    {
        this.reconnectTime = reconnectTime;
    }
}