org.fabric3.datasource.spi.DataSourceRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-datasource Show documentation
Support for configuring, deploying, and accessing datasources
The newest version!
/*
* Fabric3
* Copyright (c) 2009-2013 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see .
*/
package org.fabric3.datasource.spi;

import java.util.Map;
import javax.sql.DataSource;

/**
 * A registry of datasources.
 */
public interface DataSourceRegistry {

    /**
     * Gets a named datasource from the registry.
     *
     * @param name the name of the datasource.
     * @return Named datasource.
     */
    DataSource getDataSource(String name);

    /**
     * Returns all registered datasources.
     *
     * @return all registered datasources
     */
    Map getDataSources();

    /**
     * Registers a datasource by name.
     *
     * @param name       the ame of the datasource.
     * @param dataSource the datasource to be registered.
     */
    void register(String name, DataSource dataSource);

    /**
     * Unregisters a datasource.
     *
     * @param name the datasource name
     * @return the unregistered datasource or null if not found
     */
    DataSource unregister(String name);
}