001/*
002 * Copyright 2002-2012 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.lookup;
018
019import javax.sql.DataSource;
020
021/**
022 * Strategy interface for looking up DataSources by name.
023 *
024 * <p>Used, for example, to resolve data source names in JPA
025 * {@code persistence.xml} files.
026 *
027 * @author Costin Leau
028 * @author Juergen Hoeller
029 * @since 2.0
030 * @see org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager#setDataSourceLookup
031 */
032public interface DataSourceLookup {
033
034        /**
035         * Retrieve the DataSource identified by the given name.
036         * @param dataSourceName the name of the DataSource
037         * @return the DataSource (never {@code null})
038         * @throws DataSourceLookupFailureException if the lookup failed
039         */
040        DataSource getDataSource(String dataSourceName) throws DataSourceLookupFailureException;
041
042}