1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.orchestra.connectionManager;
20
21 import java.sql.Connection;
22
23 /**
24 * The interface for objects returned by the getConnection method of ConnectionManagerDataSource.
25 * <p>
26 * Implementations of this interface are expected to hold a reference to an underlying Connection.
27 */
28 public interface DisconnectableConnection extends Connection
29 {
30 /**
31 * Close the underlying connection object.
32 * <p>
33 * Note that if methods are called on this object that require a connection, then a
34 * fresh connection will transparently be allocated and cached.
35 */
36 public void disconnect();
37
38 /**
39 * Get the real underlying Connection object.
40 * <p>
41 * If this object is not currently connected, then null will be returned. Note that
42 * a call to any proxied method that needs a connection will then allocate one.
43 */
44 public Connection getConnection();
45 }