org.firebirdsql.gds.ng.FbAttachment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 6.0.0-beta-1
/*
 * 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.
 */
package org.firebirdsql.gds.ng;

import org.firebirdsql.encodings.Encoding;
import org.firebirdsql.encodings.IEncodingFactory;
import org.firebirdsql.gds.impl.GDSServerVersion;
import org.firebirdsql.gds.ng.listeners.ExceptionListenable;

import java.sql.SQLException;

/**
 * Connection to a Firebird server (to a database or service).
 * 
 * All methods defined in this interface and the direct descendants {@link FbDatabase} and {@link FbService} are
 * required to notify all {@code SQLException} thrown from the methods defined in this interface, and those exceptions
 * notified by all {@link ExceptionListenable} implementations created from them.
 * 
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public interface FbAttachment extends AutoCloseable, ExceptionListenable {

    /**
     * Attach to the attachment type.
     */
    void attach() throws SQLException;

    /**
     * Detaches and closes the connection.
     *
     * @throws SQLException
     *         If not currently connected, or another problem occurred detaching.
     */
    @Override
    void close() throws SQLException;

    /**
     * Forces the connection to close without proper detach or cleanup.
     * 
     * If a given implementation does not support this, then this method should call {@link #close()}.
     * 
     *
     * @throws SQLException For problems closing the connection.
     */
    void forceClose() throws SQLException;

    /**
     * @return The attachment handle value
     */
    int getHandle();

    /**
     * @return Firebird version string
     */
    GDSServerVersion getServerVersion();

    /**
     * Current attachment status.
     *
     * @return {@code true} if connected to the server and attached to a database or service, {@code false} otherwise.
     */
    boolean isAttached();

    /**
     * @return The {@link IEncodingFactory} for this connection
     */
    IEncodingFactory getEncodingFactory();

    /**
     * @return The connection encoding (should be the same as returned from calling
     * {@link IEncodingFactory#getDefaultEncoding()} on the result of {@link #getEncodingFactory()}).
     */
    Encoding getEncoding();

    /**
     * @return The {@link DatatypeCoder} for this database implementation.
     */
    DatatypeCoder getDatatypeCoder();

    /**
     * Sets the network timeout for this attachment.
     *
     * @param milliseconds
     *         Timeout in milliseconds; 0 means no timeout. If the attachment doesn't support milliseconds, it should
     *         round up to the nearest second.
     * @throws SQLException
     *         If this attachment is closed, the value of {@code milliseconds} is smaller than 0, or if setting the
     *         timeout fails.
     * @throws java.sql.SQLFeatureNotSupportedException
     *         If this attachment doesn't support (changing) the network timeout.
     */
    void setNetworkTimeout(int milliseconds) throws SQLException;

    /**
     * Gets the current network timeout for this attachment.
     *
     * @return Timeout in milliseconds, 0 means no timeout
     * @throws SQLException
     *         If this attachment is closed
     * @throws java.sql.SQLFeatureNotSupportedException
     *         If this attachment doesn't support network timeout
     */
    int getNetworkTimeout() throws SQLException;

    /**
     * Locks the lock with {@link java.util.concurrent.locks.Lock#lock()} (or equivalent).
     * 
     * The returned {@code LockClosable} can be used to unlock, preferably for use in a try-with-resources.
     * 
     *
     * @return lock closeable which unlocks the lock on close
     */
    LockCloseable withLock();

    /**
     * Queries if the lock is held by the current thread.
     *
     * @return {@code true} if current thread holds this lock and {@code false} otherwise
     * @see java.util.concurrent.locks.ReentrantLock#isHeldByCurrentThread()
     */
    boolean isLockedByCurrentThread();

}