001/*
002 * Copyright 2012-2017 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 *      http://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.boot.jdbc.metadata;
018
019import javax.sql.DataSource;
020
021/**
022 * Provide a {@link DataSourcePoolMetadata} based on a {@link DataSource}.
023 *
024 * @author Stephane Nicoll
025 * @since 2.0.0
026 */
027@FunctionalInterface
028public interface DataSourcePoolMetadataProvider {
029
030        /**
031         * Return the {@link DataSourcePoolMetadata} instance able to manage the specified
032         * {@link DataSource} or {@code null} if the given data source could not be handled.
033         * @param dataSource the data source
034         * @return the data source pool metadata
035         */
036        DataSourcePoolMetadata getDataSourcePoolMetadata(DataSource dataSource);
037
038}