View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at 
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software 
11   * distributed under the License is distributed on an "AS IS" BASIS, 
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License.
15   */
16  
17  /*
18   * JDOConnection.java
19   *
20   */
21   
22  package javax.jdo.datastore;
23  
24  import javax.jdo.PersistenceManager;
25  
26  /***
27   * The underlying connection that is being used by a 
28   * {@link PersistenceManager}. 
29   * @version 2.0
30   * @since 2.0
31   */
32  public interface JDOConnection {
33  
34      /***
35       * Returns the native, datastore-specific connection that this
36       * connection wraps. In general, it is not recommended that this
37       * native connection be used directly, since the JDO
38       * implementation has no way to intercept calls to it, so it is
39       * quite possible to put the <code>PersistenceManager</code>'s
40       * connection into an invalid state.
41       * @return the native connection
42       * @since 2.0
43       */
44      Object getNativeConnection ();
45      
46      /***
47       * Returns this connection to the JDO implementation.
48       * The object must be returned to the JDO implementation prior to
49       * calling any JDO method or performing any action on any persistent
50       * instance that might require the JDO implementation to use a
51       * connection. If the object has not been returned and the JDO
52       * implementation needs a connection, a <code>JDOUserException</code>
53       * is thrown.
54       * @since 2.0
55       */
56      void close();
57  }