org.firebirdsql.gds.IscDbHandle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk15 Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 2.2.7
/*
 * Public Firebird Java API.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright notice, 
 *       this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution. 
 *    3. The name of the author may not be used to endorse or promote products 
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * The Original Code is the Firebird Java GDS implementation.
 *
 * The Initial Developer of the Original Code is Alejandro Alberola.
 * Portions created by Alejandro Alberola are Copyright (C) 2001
 * Boix i Oltra, S.L. All Rights Reserved.
 */

package org.firebirdsql.gds;

import java.util.List;

/**
 * The interface isc_db_handle represents a socket connection
 * to the database server.
 *
 * @author Alejandro Alberola
 * @author David Jencks
 * @version 1.0
 */
public interface IscDbHandle {

    /**
     * Get list of warnings that were returned by the server.
     * 
     * @return instance of {@link List} containing instances of 
     * {@link GDSException} representing server warnings (method 
     * {@link GDSException#isWarning()} returns true).
     */
    List getWarnings();
    
    /**
     * Add a warning from the server to this connection.
     * 
     * @param warning {@link GDSException} representing a server warning
     */
    void addWarning(GDSException warning);
    
    /**
     * Clear warning list associated with this connection.
     */
    void clearWarnings();
    
    /**
     * Get the major version number of the database product to which this
     * handle is attached.
     *
     * @return The major product version number
     */
    int getDatabaseProductMajorVersion();

    /**
     * Get the minor version number of the database product to which this
     * handle is attached.
     *
     * @return The minor product version number
     */
    int getDatabaseProductMinorVersion();

    /**
     * Get the product name for the database to which this handle is attached.
     *
     * @return The product name of the database
     */
    String getDatabaseProductName();

    /**
     * Get the product version for the database to which this handle 
     * is attached.
     *
     * @return The product version of the database
     */
    String getDatabaseProductVersion();

    /**
     * Get the Firebird dialect that is being used with this handle.
     *
     * @return The dialect being used
     */
    int getDialect();
    
    void setDialect(int value);
    
    /**
     * Get the Firebird protocol version that is used for this handle
     * 
     * @return Protocol version number
     */
    int getProtocol();

    /**
     * @return the major ODS version of the database. 
     */
    int getODSMajorVersion();
    
    void setODSMajorVersion(int value);

    /**
     * @return the minor ODS version of the database.
     */
    int getODSMinorVersion();
    
    void setODSMinorVersion(int value);

    /**
     * @return database server version.
     */
    String getVersion();
    
    /**
     * 
     * @param version Version string
     * @throws GDSException For failures to parse or process the version string
     */
    void setVersion(String version) throws GDSException;

    /**
     * Retrieve whether this handle is valid.
     *
     * @return true if this handle is valid, 
     *         false otherwise
     */
    boolean isValid();
}