View Javadoc

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