001/*
002 * Copyright 2002-2014 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jdbc.datasource.embedded;
018
019import javax.sql.DataSource;
020
021/**
022 * {@code DataSourceFactory} encapsulates the creation of a particular
023 * {@link DataSource} implementation such as a
024 * {@link org.springframework.jdbc.datasource.SimpleDriverDataSource
025 * SimpleDriverDataSource} or a connection pool such as Apache DBCP or C3P0.
026 *
027 * <p>Call {@link #getConnectionProperties()} to configure normalized
028 * {@code DataSource} properties before calling {@link #getDataSource()} to
029 * actually get the configured {@code DataSource} instance.
030 *
031 * @author Keith Donald
032 * @author Sam Brannen
033 * @since 3.0
034 */
035public interface DataSourceFactory {
036
037        /**
038         * Get the {@linkplain ConnectionProperties connection properties} of the
039         * {@link #getDataSource DataSource} to be configured.
040         */
041        ConnectionProperties getConnectionProperties();
042
043        /**
044         * Get the {@link DataSource} with the {@linkplain #getConnectionProperties
045         * connection properties} applied.
046         */
047        DataSource getDataSource();
048
049}