001/*
002 * Copyright 2002-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 *      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;
018
019import java.sql.Connection;
020
021/**
022 * Subinterface of {@link java.sql.Connection} to be implemented by
023 * Connection proxies. Allows access to the underlying target Connection.
024 *
025 * <p>This interface can be checked when there is a need to cast to a
026 * native JDBC Connection such as Oracle's OracleConnection. Spring's
027 * {@link org.springframework.jdbc.support.nativejdbc.NativeJdbcExtractorAdapter}
028 * automatically detects such proxies before delegating to the actual
029 * unwrapping for a specific connection pool. Alternatively, all such
030 * connections also support JDBC 4.0's {@link Connection#unwrap}.
031 *
032 * @author Juergen Hoeller
033 * @since 1.1
034 * @see TransactionAwareDataSourceProxy
035 * @see LazyConnectionDataSourceProxy
036 * @see DataSourceUtils#getTargetConnection(java.sql.Connection)
037 */
038public interface ConnectionProxy extends Connection {
039
040        /**
041         * Return the target Connection of this proxy.
042         * <p>This will typically be the native driver Connection
043         * or a wrapper from a connection pool.
044         * @return the underlying Connection (never {@code null})
045         */
046        Connection getTargetConnection();
047
048}