NucleusConnection.java

/**********************************************************************
Copyright (c) 2007 Erik Bengtson and others. All rights reserved. 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. 
 

Contributors:
    ...
**********************************************************************/
package org.datanucleus.store;

/**
 * Access to the underlying DataStore Connection.
 */
public interface NucleusConnection
{
    /**
     * Accessor for the underlying connection.
     * @return The native connection
     */
    public Object getNativeConnection();

    /**
     * Method to close the connection, handing it back to DataNucleus.
     */
    public void close();

    /**
     * Accessor for whether the connection is available.
     * @return Whether it is available
     */
    public boolean isAvailable();
}