org.firebirdsql.gds.ng.IConnectionProperties 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.jaybird.props.DatabaseConnectionProperties;
import org.firebirdsql.jaybird.props.PropertyConstants;

/**
 * Connection properties for the Firebird connection.
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public interface IConnectionProperties extends IAttachProperties, DatabaseConnectionProperties {

    /**
     * Value for {@code sessionTimeZone} that indicates the session time zone should not be set and use server default.
     *
     * @deprecated will be removed in Jaybird 6, use {@link org.firebirdsql.jaybird.props.PropertyConstants#SESSION_TIME_ZONE_SERVER}
     */
    @Deprecated
    String SESSION_TIME_ZONE_SERVER = PropertyConstants.SESSION_TIME_ZONE_SERVER;
    @Deprecated
    short DEFAULT_DIALECT = PropertyConstants.DEFAULT_DIALECT;
    @Deprecated
    int DEFAULT_BUFFERS_NUMBER = PropertyConstants.DEFAULT_PAGE_CACHE_SIZE;

    /**
     * Get the dialect of the client connection
     * 
     * NOTE: Implementer should take care to return {@link IConnectionProperties#DEFAULT_DIALECT} if
     * the value hasn't been set yet.
     * 
     *
     * @return SQL dialect of the client.
     * @deprecated Use {@link #getSqlDialect()}; will be removed in Jaybird 6
     */
    @Deprecated
    default short getConnectionDialect() {
        return (short) getSqlDialect();
    }

    /**
     * Set the dialect of the client connection
     * 
     * NOTE: Implementer should take care to use {@link #DEFAULT_DIALECT} if the
     * value hasn't been set yet.
     * 
     *
     * @param connectionDialect
     *         SQL dialect of the client.
     * @deprecated Use {@link #setSqlDialect(int)}; will be removed in Jaybird 6
     */
    @Deprecated
    default void setConnectionDialect(short connectionDialect) {
        setSqlDialect(connectionDialect);
    }

    /**
     * @return An immutable version of this instance as an implementation of {@link IConnectionProperties}
     */
    @Override
    IConnectionProperties asImmutable();

    /**
     * @return A new, mutable, instance as an implementation of {@link IConnectionProperties} with all properties
     * copied.
     */
    @Override
    IConnectionProperties asNewMutable();
}