org.firebirdsql.jdbc.FirebirdConnectionProperties Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk17 Show documentation
Show all versions of jaybird-jdk17 Show documentation
JDBC Driver for the Firebird RDBMS
/*
* Firebird Open Source JavaEE Connector - JDBC Driver
*
* Distributable under LGPL license.
* You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* LGPL License for more details.
*
* This file was created by members of the firebird development team.
* All individual contributions remain the Copyright (C) of those
* individuals. Contributors to this file are either listed here or
* can be obtained from a source control history command.
*
* All rights reserved.
*/
package org.firebirdsql.jdbc;
import org.firebirdsql.gds.DatabaseParameterBuffer;
import org.firebirdsql.gds.TransactionParameterBuffer;
import org.firebirdsql.gds.ng.WireCrypt;
import java.sql.SQLException;
/**
* Connection properties for the Firebird connection. Main part of this
* interface corresponds to the Database Parameter Buffer, but also contains
* properties to specify default transaction parameters.
*/
public interface FirebirdConnectionProperties {
/**
* @return path to the database including the server name and the port,
* if needed.
*/
String getDatabase();
/**
* @param database
* path to the database including the server name and the
* port, if needed.
*/
void setDatabase(String database);
/**
* @return type of the connection, for example, "PURE_JAVA", "LOCAL",
* "EMBEDDED", depends on the GDS implementations installed in the system.
*/
String getType();
/**
* @param type
* type of the connection, for example, "PURE_JAVA", "LOCAL",
* "EMBEDDED", depends on the GDS implementations installed in the system.
*/
void setType(String type);
/**
* @return BLOB buffer size in bytes.
*/
int getBlobBufferSize();
/**
* @param bufferSize
* size of the BLOB buffer in bytes.
*/
void setBlobBufferSize(int bufferSize);
/**
* @return Character set for the connection.
* @see #setCharSet(String)
*/
String getCharSet();
/**
* @param charSet
* Character set for the connection. Similar to
* encoding property, but accepts Java names
* instead of Firebird ones.
*/
void setCharSet(String charSet);
/**
* @return Character encoding for the connection.
* @see #setEncoding(String)
*/
String getEncoding();
/**
* @param encoding
* Character encoding for the connection. See Firebird
* documentation for more information.
*/
void setEncoding(String encoding);
/**
* @return SQL role to use.
*/
String getRoleName();
/**
* @param roleName
* SQL role to use.
*/
void setRoleName(String roleName);
/**
* @return SQL dialect of the client.
*/
String getSqlDialect();
/**
* @param sqlDialect
* SQL dialect of the client.
*/
void setSqlDialect(String sqlDialect);
/**
* @return path to the character translation table.
* @deprecated To be removed in Jaybird 4
*/
@Deprecated
String getUseTranslation();
/**
* @param translationPath
* path to the character translation table.
* @deprecated To be removed in Jaybird 4
*/
@Deprecated
void setUseTranslation(String translationPath);
/**
* @return true if stream blobs should be created, otherwise
* false.
*/
boolean isUseStreamBlobs();
/**
* @param useStreamBlobs
* true if stream blobs should be created,
* otherwise false.
*/
void setUseStreamBlobs(boolean useStreamBlobs);
/**
* @return true if driver should assume that standard UDF are
* installed.
*/
boolean isUseStandardUdf();
/**
* @param useStandardUdf
* true if driver should assume that standard UDF
* are installed.
*/
void setUseStandardUdf(boolean useStandardUdf);
/**
* @return socket buffer size in bytes, or -1 is not specified.
*/
int getSocketBufferSize();
/**
* @param socketBufferSize
* socket buffer size in bytes.
*/
void setSocketBufferSize(int socketBufferSize);
/**
* @return true if the Jaybird 1.0 handling of the calendar
* in corresponding setters. This is also compatible with MySQL
* calendar treatment.
*/
boolean isTimestampUsesLocalTimezone();
/**
* @param timestampUsesLocalTimezone
* true if the Jaybird 1.0 handling of the
* calendar in corresponding setters. This is also compatible
* with MySQL calendar treatment.
*/
void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone);
/**
* @return name of the user that will be used when connecting to the database.
*/
String getUserName();
/**
* @param userName
* name of the user that will be used when connecting to the database.
*/
void setUserName(String userName);
/**
* @return password corresponding to the specified user name.
*/
String getPassword();
/**
* @param password
* password corresponding to the specified user name.
*/
void setPassword(String password);
/**
* @return number of cache buffers that should be allocated for this
* connection, should be specified for ClassicServer instances,
* SuperServer has a server-wide configuration parameter.
*/
int getBuffersNumber();
/**
* @param buffersNumber
* number of cache buffers that should be allocated for this
* connection, should be specified for ClassicServer instances,
* SuperServer has a server-wide configuration parameter.
*/
void setBuffersNumber(int buffersNumber);
/**
* Get the property that does not have corresponding getter method by its
* name.
*
* @param key
* name of the property to get.
* @return value of the property.
*/
String getNonStandardProperty(String key);
/**
* Set the property that does not have corresponding setter method.
*
* @param key
* name of the property to set.
* @param value
* value of the property.
*/
void setNonStandardProperty(String key, String value);
/**
* Set the property that does not have corresponding setter method.
*
* @param propertyMapping
* parameter value in the ?propertyName[=propertyValue]? form,
* this allows setting non-standard parameters using
* configuration files.
*/
void setNonStandardProperty(String propertyMapping);
/**
* Get the database parameter buffer corresponding to the current connection
* request information.
*
* @return instance of {@link DatabaseParameterBuffer}.
* @throws SQLException
* if database parameter buffer cannot be created.
*/
DatabaseParameterBuffer getDatabaseParameterBuffer() throws SQLException;
/**
* Get the used TPB mapping.
*
* @return path to the TPB mapping.
* @see #setTpbMapping(String)
*/
String getTpbMapping();
/**
* Set path to the properties file with the TPB mapping. The path begins
* with the protocol specification followed by the path to the resource. A
* special protocol "res:" should be used to specify resource
* in the classpath.
*
* For the compatibility reasons, if no protocol is specified, classpath is
* used by default.
*
* Properties file contains a mapping between the transaction isolation
* level (name of the constant in the {@link java.sql.Connection} interface
* and a comma-separated list of TPB parameters.
*
* @param tpbMapping
* path to the properties file.
*/
void setTpbMapping(String tpbMapping);
/**
* Get the default transaction isolation level. This is the transaction
* isolation level for the newly created connections.
*
* @return default transaction isolation level.
*/
int getDefaultTransactionIsolation();
/**
* Set the default transaction isolation level.
*
* @param defaultIsolationLevel
* default transaction isolation level.
*/
void setDefaultTransactionIsolation(int defaultIsolationLevel);
/**
* Get the default transaction isolation level as string. This method is
* complementary to the {@link #getDefaultTransactionIsolation()}, however
* it takes a string as parameter instead of a numeric constant.
*
* @return default transaction isolation as string.
* @see #setDefaultIsolation(String)
*/
String getDefaultIsolation();
/**
* Set the default transaction isolation level as string. This method is
* complementary to the {@link #setDefaultTransactionIsolation(int)},
* however it takes a string as parameter instead of a numeric constant.
*
* Following strings are allowed:
*
* "TRANSACTION_READ_COMMITTED" for a READ COMMITTED
* isolation level.
* "TRANSACTION_REPEATABLE_READ" for a REPEATABLE READ
* isolation level.
* "TRANSACTION_SERIALIZABLE" for a SERIALIZABLE
* isolation level.
*
*
* @param isolation
* string constant representing a default isolation level.
*/
void setDefaultIsolation(String isolation);
/**
* Get the transaction parameter buffer corresponding to the current
* connection request information.
*
* @param isolation
* transaction isolation level for which TPB should be returned.
* @return instance of {@link TransactionParameterBuffer}.
*/
TransactionParameterBuffer getTransactionParameters(int isolation);
/**
* Set transaction parameters for the specified transaction isolation level.
* The specified TPB is used as a default mapping for the specified
* isolation level.
*
* @param isolation
* transaction isolation level.
* @param tpb
* instance of {@link TransactionParameterBuffer} containing
* transaction parameters.
*/
void setTransactionParameters(int isolation, TransactionParameterBuffer tpb);
/**
* Get the default ResultSet holdability.
*
* @return true when ResultSets are holdable by default, false not holdable.
*/
boolean isDefaultResultSetHoldable();
/**
* Sets the default ResultSet holdability.
*
* @param isHoldable
* true when ResultSets are holdable by default, false not holdable.
*/
void setDefaultResultSetHoldable(boolean isHoldable);
/**
* Get the current Socket blocking timeout (SoTimeout).
*
* @return The socket blocking timeout in milliseconds (0 is 'infinite')
*/
int getSoTimeout();
/**
* Set the Socket blocking timeout (SoTimeout).
*
* @param soTimeout
* Timeout in milliseconds (0 is 'infinite')
*/
void setSoTimeout(int soTimeout);
/**
* Get the current connect timeout.
*
* @return Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
*/
int getConnectTimeout();
/**
* Set the connect timeout.
*
* @param connectTimeout
* Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
*/
void setConnectTimeout(int connectTimeout);
/**
* Get whether to use Firebird autocommit (experimental).
*
* @return {@code true} use Firebird autocommit
*/
boolean isUseFirebirdAutocommit();
/**
* Set whether to use Firebird autocommit (experimental).
*
* @param useFirebirdAutocommit
* {@code true} Use Firebird autocommit
*/
void setUseFirebirdAutocommit(boolean useFirebirdAutocommit);
/**
* Get the wire encryption level value.
*
* @return Wire encryption level ({@code null} implies {@code DEFAULT})
* @since 3.0.4
*/
String getWireCrypt();
/**
* Sets the wire encryption level.
*
* Values are defined by {@link WireCrypt}, values are handled case insensitive.
* Invalid values are accepted, but will cause an error when a connection is established.
*
*
* @param wireCrypt Wire encryption level
* @since 3.0.4
*/
void setWireCrypt(String wireCrypt);
/**
* Get the database encryption plugin configuration.
*
* @return Database encryption plugin configuration, meaning plugin specific
* @since 3.0.4
*/
String getDbCryptConfig();
/**
* Sets the database encryption plugin configuration.
*
* @param dbCryptConfig Database encryption plugin configuration, meaning plugin specific
* @since 3.0.4
*/
void setDbCryptConfig(String dbCryptConfig);
}