001/*
002 * Copyright 2002-2018 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 EmbeddedDatabaseConfigurer} encapsulates the configuration required to
023 * create, connect to, and shut down a specific type of embedded database such as
024 * HSQL, H2, or Derby.
025 *
026 * @author Keith Donald
027 * @author Sam Brannen
028 * @since 3.0
029 */
030public interface EmbeddedDatabaseConfigurer {
031
032        /**
033         * Configure the properties required to create and connect to the embedded database.
034         * @param properties connection properties to configure
035         * @param databaseName the name of the embedded database
036         */
037        void configureConnectionProperties(ConnectionProperties properties, String databaseName);
038
039        /**
040         * Shut down the embedded database instance that backs the supplied {@link DataSource}.
041         * @param dataSource the corresponding {@link DataSource}
042         * @param databaseName the name of the database being shut down
043         */
044        void shutdown(DataSource dataSource, String databaseName);
045
046}