Class FBConnectionProperties
- All Implemented Interfaces:
Serializable,Cloneable,FirebirdConnectionProperties
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()booleanGet the list of authentication plugins to try.intintintGet the current connect timeout.Deprecated.TODO Usage of this method should be removed or revised as current use of default encoding is not correct.Get thedataTypeBindconfiguration.Get the database encryption plugin configuration.Get the default transaction isolation level as string.intGet the default transaction isolation level.Get thegeneratedKeysEnabledconfiguration.Get the property that does not have corresponding getter method by its name.Get thesessionTimeZone.intintGet the current Socket blocking timeout (SoTimeout).Get the used TPB mapping.getTransactionParameters(int isolation) Get the transaction parameter buffer corresponding to the current connection request information.getType()Get the wire encryption level value.inthashCode()booleanGet the default ResultSet holdability.booleanGet the value forignoreProcedureType.booleanbooleanGet whether to use Firebird autocommit (experimental).booleanbooleanbooleanGet if wire compression should be enabled.voidsetAuthPlugins(String authPlugins) Sets the authentication plugins to try.voidsetBlobBufferSize(int bufferSize) voidsetBuffersNumber(int buffersNumber) voidsetCharSet(String charSet) voidsetConnectTimeout(int connectTimeout) Set the connect timeout.voidsetDatabase(String database) voidsetDataTypeBind(String dataTypeBind) Sets thedataTypeBindconfiguration.voidsetDbCryptConfig(String dbCryptConfig) Sets the database encryption plugin configuration.voidsetDefaultIsolation(String isolation) Set the default transaction isolation level as string.voidsetDefaultResultSetHoldable(boolean isHoldable) Sets the default ResultSet holdability.voidsetDefaultTransactionIsolation(int defaultIsolationLevel) Set the default transaction isolation level.voidsetEncoding(String encoding) voidsetGeneratedKeysEnabled(String generatedKeysEnabled) Sets thegeneratedKeysEnabledconfiguration.voidsetIgnoreProcedureType(boolean ignoreProcedureType) Sets the valueignoreProcedureType.voidsetNonStandardProperty(String propertyMapping) Set the property that does not have corresponding setter method.voidsetNonStandardProperty(String key, String value) Set the property that does not have corresponding setter method.voidsetPassword(String password) voidsetRoleName(String roleName) voidsetSessionTimeZone(String sessionTimeZone) Sets thesessionTimeZone.voidsetSocketBufferSize(int socketBufferSize) voidsetSoTimeout(int soTimeout) Set the Socket blocking timeout (SoTimeout).voidsetSqlDialect(String sqlDialect) voidsetTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone) voidsetTpbMapping(String tpbMapping) Set path to the properties file with the TPB mapping.voidsetTransactionParameters(int isolation, TransactionParameterBuffer tpb) Set transaction parameters for the specified transaction isolation level.voidvoidsetUseFirebirdAutocommit(boolean useFirebirdAutocommit) Set whether to use Firebird autocommit (experimental).voidsetUserName(String userName) voidsetUseStandardUdf(boolean useStandardUdf) voidsetUseStreamBlobs(boolean useStreamBlobs) voidsetWireCompression(boolean wireCompression) Sets if the connection should try to enable wire compression.voidsetWireCrypt(String wireCrypt) Sets the wire encryption level.
-
Field Details
-
DATABASE_PROPERTY
- See Also:
-
TYPE_PROPERTY
- See Also:
-
ISOLATION_PROPERTY
- See Also:
-
DEFAULT_ISOLATION_PROPERTY
- See Also:
-
BLOB_BUFFER_SIZE_PROPERTY
- See Also:
-
LOCAL_ENCODING_PROPERTY
- See Also:
-
ENCODING_PROPERTY
- See Also:
-
ROLE_NAME_PROPERTY
- See Also:
-
SQL_DIALECT_PROPERTY
- See Also:
-
USE_STREAM_BLOBS_PROPERTY
- See Also:
-
USE_STANDARD_UDF_PROPERTY
- See Also:
-
SOCKET_BUFFER_SIZE_PROPERTY
- See Also:
-
TIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTY
- See Also:
-
USER_NAME_PROPERTY
- See Also:
-
PASSWORD_PROPERTY
- See Also:
-
BUFFERS_NUMBER_PROPERTY
- See Also:
-
DEFAULT_HOLDABLE_RS_PROPERTY
- See Also:
-
SO_TIMEOUT
- See Also:
-
CONNECT_TIMEOUT
- See Also:
-
USE_FIREBIRD_AUTOCOMMIT
- See Also:
-
WIRE_CRYPT_LEVEL
- See Also:
-
DB_CRYPT_CONFIG
- See Also:
-
AUTH_PLUGINS
- See Also:
-
GENERATED_KEYS_ENABLED
- See Also:
-
DATA_TYPE_BIND
- See Also:
-
SESSION_TIME_ZONE
- See Also:
-
IGNORE_PROCEDURE_TYPE
- See Also:
-
WIRE_COMPRESSION
- See Also:
-
-
Constructor Details
-
FBConnectionProperties
public FBConnectionProperties()
-
-
Method Details
-
hashCode
public int hashCode() -
equals
-
clone
-
getDatabase
- Specified by:
getDatabasein interfaceFirebirdConnectionProperties- Returns:
- path to the database including the server name and the port, if needed.
-
setDatabase
- Specified by:
setDatabasein interfaceFirebirdConnectionProperties- Parameters:
database- path to the database including the server name and the port, if needed.
-
getType
- Specified by:
getTypein interfaceFirebirdConnectionProperties- Returns:
- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
-
setType
- Specified by:
setTypein interfaceFirebirdConnectionProperties- Parameters:
type- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
-
getBlobBufferSize
public int getBlobBufferSize()- Specified by:
getBlobBufferSizein interfaceFirebirdConnectionProperties- Returns:
- BLOB buffer size in bytes.
-
setBlobBufferSize
public void setBlobBufferSize(int bufferSize) - Specified by:
setBlobBufferSizein interfaceFirebirdConnectionProperties- Parameters:
bufferSize- size of the BLOB buffer in bytes.
-
getCharSet
- Specified by:
getCharSetin interfaceFirebirdConnectionProperties- Returns:
- Character set for the connection.
- See Also:
-
setCharSet
- Specified by:
setCharSetin interfaceFirebirdConnectionProperties- Parameters:
charSet- Character set for the connection. Similar toencodingproperty, but accepts Java names instead of Firebird ones.
-
getEncoding
- Specified by:
getEncodingin interfaceFirebirdConnectionProperties- Returns:
- Character encoding for the connection.
- See Also:
-
setEncoding
- Specified by:
setEncodingin interfaceFirebirdConnectionProperties- Parameters:
encoding- Character encoding for the connection. See Firebird documentation for more information.
-
getRoleName
- Specified by:
getRoleNamein interfaceFirebirdConnectionProperties- Returns:
- SQL role to use.
-
setRoleName
- Specified by:
setRoleNamein interfaceFirebirdConnectionProperties- Parameters:
roleName- SQL role to use.
-
getSqlDialect
- Specified by:
getSqlDialectin interfaceFirebirdConnectionProperties- Returns:
- SQL dialect of the client.
-
setSqlDialect
- Specified by:
setSqlDialectin interfaceFirebirdConnectionProperties- Parameters:
sqlDialect- SQL dialect of the client.
-
isUseStreamBlobs
public boolean isUseStreamBlobs()- Specified by:
isUseStreamBlobsin interfaceFirebirdConnectionProperties- Returns:
trueif stream blobs should be created, otherwisefalse.
-
setUseStreamBlobs
public void setUseStreamBlobs(boolean useStreamBlobs) - Specified by:
setUseStreamBlobsin interfaceFirebirdConnectionProperties- Parameters:
useStreamBlobs-trueif stream blobs should be created, otherwisefalse.
-
isUseStandardUdf
public boolean isUseStandardUdf()- Specified by:
isUseStandardUdfin interfaceFirebirdConnectionProperties- Returns:
trueif driver should assume that standard UDF are installed.
-
setUseStandardUdf
public void setUseStandardUdf(boolean useStandardUdf) - Specified by:
setUseStandardUdfin interfaceFirebirdConnectionProperties- Parameters:
useStandardUdf-trueif driver should assume that standard UDF are installed.
-
getSocketBufferSize
public int getSocketBufferSize()- Specified by:
getSocketBufferSizein interfaceFirebirdConnectionProperties- Returns:
- socket buffer size in bytes, or -1 is not specified.
-
setSocketBufferSize
public void setSocketBufferSize(int socketBufferSize) - Specified by:
setSocketBufferSizein interfaceFirebirdConnectionProperties- Parameters:
socketBufferSize- socket buffer size in bytes.
-
isTimestampUsesLocalTimezone
public boolean isTimestampUsesLocalTimezone()- Specified by:
isTimestampUsesLocalTimezonein interfaceFirebirdConnectionProperties- Returns:
trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
-
setTimestampUsesLocalTimezone
public void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone) - Specified by:
setTimestampUsesLocalTimezonein interfaceFirebirdConnectionProperties- Parameters:
timestampUsesLocalTimezone-trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
-
getUserName
- Specified by:
getUserNamein interfaceFirebirdConnectionProperties- Returns:
- name of the user that will be used when connecting to the database.
-
setUserName
- Specified by:
setUserNamein interfaceFirebirdConnectionProperties- Parameters:
userName- name of the user that will be used when connecting to the database.
-
getPassword
- Specified by:
getPasswordin interfaceFirebirdConnectionProperties- Returns:
- password corresponding to the specified user name.
-
setPassword
- Specified by:
setPasswordin interfaceFirebirdConnectionProperties- Parameters:
password- password corresponding to the specified user name.
-
getBuffersNumber
public int getBuffersNumber()- Specified by:
getBuffersNumberin interfaceFirebirdConnectionProperties- Returns:
- number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances, SuperServer has a server-wide configuration parameter.
-
setBuffersNumber
public void setBuffersNumber(int buffersNumber) - Specified by:
setBuffersNumberin interfaceFirebirdConnectionProperties- Parameters:
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.
-
getNonStandardProperty
Description copied from interface:FirebirdConnectionPropertiesGet the property that does not have corresponding getter method by its name.- Specified by:
getNonStandardPropertyin interfaceFirebirdConnectionProperties- Parameters:
key- name of the property to get.- Returns:
- value of the property.
-
setNonStandardProperty
Description copied from interface:FirebirdConnectionPropertiesSet the property that does not have corresponding setter method.- Specified by:
setNonStandardPropertyin interfaceFirebirdConnectionProperties- Parameters:
key- name of the property to set.value- value of the property.
-
isDefaultResultSetHoldable
public boolean isDefaultResultSetHoldable()Description copied from interface:FirebirdConnectionPropertiesGet the default ResultSet holdability.- Specified by:
isDefaultResultSetHoldablein interfaceFirebirdConnectionProperties- Returns:
truewhen ResultSets are holdable by default,falsenot holdable.
-
setDefaultResultSetHoldable
public void setDefaultResultSetHoldable(boolean isHoldable) Description copied from interface:FirebirdConnectionPropertiesSets the default ResultSet holdability.- Specified by:
setDefaultResultSetHoldablein interfaceFirebirdConnectionProperties- Parameters:
isHoldable-truewhen ResultSets are holdable by default,falsenot holdable.
-
getSoTimeout
public int getSoTimeout()Description copied from interface:FirebirdConnectionPropertiesGet the current Socket blocking timeout (SoTimeout).- Specified by:
getSoTimeoutin interfaceFirebirdConnectionProperties- Returns:
- The socket blocking timeout in milliseconds (0 is 'infinite')
-
setSoTimeout
public void setSoTimeout(int soTimeout) Description copied from interface:FirebirdConnectionPropertiesSet the Socket blocking timeout (SoTimeout).- Specified by:
setSoTimeoutin interfaceFirebirdConnectionProperties- Parameters:
soTimeout- Timeout in milliseconds (0 is 'infinite')
-
getConnectTimeout
public int getConnectTimeout()Description copied from interface:FirebirdConnectionPropertiesGet the current connect timeout.- Specified by:
getConnectTimeoutin interfaceFirebirdConnectionProperties- Returns:
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
-
setConnectTimeout
public void setConnectTimeout(int connectTimeout) Description copied from interface:FirebirdConnectionPropertiesSet the connect timeout.- Specified by:
setConnectTimeoutin interfaceFirebirdConnectionProperties- Parameters:
connectTimeout- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
-
isUseFirebirdAutocommit
public boolean isUseFirebirdAutocommit()Description copied from interface:FirebirdConnectionPropertiesGet whether to use Firebird autocommit (experimental).- Specified by:
isUseFirebirdAutocommitin interfaceFirebirdConnectionProperties- Returns:
trueuse Firebird autocommit
-
setUseFirebirdAutocommit
public void setUseFirebirdAutocommit(boolean useFirebirdAutocommit) Description copied from interface:FirebirdConnectionPropertiesSet whether to use Firebird autocommit (experimental).- Specified by:
setUseFirebirdAutocommitin interfaceFirebirdConnectionProperties- Parameters:
useFirebirdAutocommit-trueUse Firebird autocommit
-
getWireCrypt
Description copied from interface:FirebirdConnectionPropertiesGet the wire encryption level value.- Specified by:
getWireCryptin interfaceFirebirdConnectionProperties- Returns:
- Wire encryption level (
nullimpliesDEFAULT)
-
setWireCrypt
Description copied from interface:FirebirdConnectionPropertiesSets the wire encryption level.Values are defined by
WireCrypt, values are handled case insensitive. Invalid values are accepted, but will cause an error when a connection is established.- Specified by:
setWireCryptin interfaceFirebirdConnectionProperties- Parameters:
wireCrypt- Wire encryption level
-
getDbCryptConfig
Description copied from interface:FirebirdConnectionPropertiesGet the database encryption plugin configuration.- Specified by:
getDbCryptConfigin interfaceFirebirdConnectionProperties- Returns:
- Database encryption plugin configuration, meaning plugin specific
-
setDbCryptConfig
Description copied from interface:FirebirdConnectionPropertiesSets the database encryption plugin configuration.- Specified by:
setDbCryptConfigin interfaceFirebirdConnectionProperties- Parameters:
dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
-
getAuthPlugins
Description copied from interface:FirebirdConnectionPropertiesGet the list of authentication plugins to try.- Specified by:
getAuthPluginsin interfaceFirebirdConnectionProperties- Returns:
- comma-separated list of authentication plugins, or
nullfor driver default
-
setAuthPlugins
Description copied from interface:FirebirdConnectionPropertiesSets the authentication plugins to try.Invalid names are skipped during authentication.
- Specified by:
setAuthPluginsin interfaceFirebirdConnectionProperties- Parameters:
authPlugins- comma-separated list of authentication plugins, ornullfor driver default
-
getGeneratedKeysEnabled
Description copied from interface:FirebirdConnectionPropertiesGet thegeneratedKeysEnabledconfiguration.- Specified by:
getGeneratedKeysEnabledin interfaceFirebirdConnectionProperties- Returns:
- configuration value for
generatedKeysEnabled, ornullfor driver default
-
setGeneratedKeysEnabled
Description copied from interface:FirebirdConnectionPropertiesSets thegeneratedKeysEnabledconfiguration.- Specified by:
setGeneratedKeysEnabledin interfaceFirebirdConnectionProperties- Parameters:
generatedKeysEnabled- Generated keys support configuration:default(or null/empty),disabled,ignored, or a list of statement types to enable (possible values:insert,update,delete,update_or_insert,merge)
-
getDataTypeBind
Description copied from interface:FirebirdConnectionPropertiesGet thedataTypeBindconfiguration.- Specified by:
getDataTypeBindin interfaceFirebirdConnectionProperties- Returns:
- configuration value for
dataTypeBind, ornullfor driver default
-
setDataTypeBind
Description copied from interface:FirebirdConnectionPropertiesSets thedataTypeBindconfiguration.If the value is explicitly set to a non-null value and the connected server is Firebird 4 or higher, this will configure the data type binding with the specified values using
isc_dpb_set_bind, which is equivalent to executingSET BINDstatements with the values.See also Firebird documentation for
SET BIND.- Specified by:
setDataTypeBindin interfaceFirebirdConnectionProperties- Parameters:
dataTypeBind- Firebird 4+ data type bind configuration, a semicolon-separated list of<from-type> TO <to-type>
-
getSessionTimeZone
Description copied from interface:FirebirdConnectionPropertiesGet thesessionTimeZone.- Specified by:
getSessionTimeZonein interfaceFirebirdConnectionProperties- Returns:
- value for
sessionTimeZone, ornullfor driver default (JVM default time zone)
-
setSessionTimeZone
Description copied from interface:FirebirdConnectionPropertiesSets thesessionTimeZone.- Specified by:
setSessionTimeZonein interfaceFirebirdConnectionProperties- Parameters:
sessionTimeZone- Firebird 4+ session time zone name (we strongly suggest to use Java compatible names only), use"server"to use server default time zone (note: conversion will use JVM default time zone)
-
isIgnoreProcedureType
public boolean isIgnoreProcedureType()Description copied from interface:FirebirdConnectionPropertiesGet the value forignoreProcedureType.- Specified by:
isIgnoreProcedureTypein interfaceFirebirdConnectionProperties- Returns:
- value for
ignoreProcedureType
-
setIgnoreProcedureType
public void setIgnoreProcedureType(boolean ignoreProcedureType) Description copied from interface:FirebirdConnectionPropertiesSets the valueignoreProcedureType.When set to true, the
CallableStatementimplementation in Jaybird will ignore metadata information about the stored procedure type and default to usingEXECUTE PROCEDURE, unless the type is explicitly set usingFirebirdCallableStatement.setSelectableProcedure(boolean). This can be useful in situations where a stored procedure is selectable, but tooling or code expects an executable stored procedure.- Specified by:
setIgnoreProcedureTypein interfaceFirebirdConnectionProperties- Parameters:
ignoreProcedureType-trueIgnore procedure type
-
isWireCompression
public boolean isWireCompression()Description copied from interface:FirebirdConnectionPropertiesGet if wire compression should be enabled.Wire compression requires Firebird 3 or higher, and the server must have the zlib library. If compression cannot be negotiated, the connection will be made without wire compression.
This property will be ignored for native connections. For native connections, the configuration in
firebird.confread by the client library will be used.- Specified by:
isWireCompressionin interfaceFirebirdConnectionProperties- Returns:
truewire compression enabled
-
setWireCompression
public void setWireCompression(boolean wireCompression) Description copied from interface:FirebirdConnectionPropertiesSets if the connection should try to enable wire compression.- Specified by:
setWireCompressionin interfaceFirebirdConnectionProperties- Parameters:
wireCompression-trueenable wire compression,falsedisable wire compression (the default)- See Also:
-
setNonStandardProperty
Description copied from interface:FirebirdConnectionPropertiesSet the property that does not have corresponding setter method.- Specified by:
setNonStandardPropertyin interfaceFirebirdConnectionProperties- Parameters:
propertyMapping- parameter value in the ?propertyName[=propertyValue]? form, this allows setting non-standard parameters using configuration files.
-
getDatabaseParameterBuffer
Deprecated.TODO Usage of this method should be removed or revised as current use of default encoding is not correct.Description copied from interface:FirebirdConnectionPropertiesGet the database parameter buffer corresponding to the current connection request information.- Specified by:
getDatabaseParameterBufferin interfaceFirebirdConnectionProperties- Returns:
- instance of
DatabaseParameterBuffer. - Throws:
SQLException- if database parameter buffer cannot be created.
-
getTpbMapping
Description copied from interface:FirebirdConnectionPropertiesGet the used TPB mapping.- Specified by:
getTpbMappingin interfaceFirebirdConnectionProperties- Returns:
- path to the TPB mapping.
- See Also:
-
setTpbMapping
Description copied from interface:FirebirdConnectionPropertiesSet 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 theConnectioninterface and a comma-separated list of TPB parameters.- Specified by:
setTpbMappingin interfaceFirebirdConnectionProperties- Parameters:
tpbMapping- path to the properties file.
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()Description copied from interface:FirebirdConnectionPropertiesGet the default transaction isolation level. This is the transaction isolation level for the newly created connections.- Specified by:
getDefaultTransactionIsolationin interfaceFirebirdConnectionProperties- Returns:
- default transaction isolation level.
-
setDefaultTransactionIsolation
public void setDefaultTransactionIsolation(int defaultIsolationLevel) Description copied from interface:FirebirdConnectionPropertiesSet the default transaction isolation level.- Specified by:
setDefaultTransactionIsolationin interfaceFirebirdConnectionProperties- Parameters:
defaultIsolationLevel- default transaction isolation level.
-
getDefaultIsolation
Description copied from interface:FirebirdConnectionPropertiesGet the default transaction isolation level as string. This method is complementary to theFirebirdConnectionProperties.getDefaultTransactionIsolation(), however it takes a string as parameter instead of a numeric constant.- Specified by:
getDefaultIsolationin interfaceFirebirdConnectionProperties- Returns:
- default transaction isolation as string.
- See Also:
-
setDefaultIsolation
Description copied from interface:FirebirdConnectionPropertiesSet the default transaction isolation level as string. This method is complementary to theFirebirdConnectionProperties.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.
- Specified by:
setDefaultIsolationin interfaceFirebirdConnectionProperties- Parameters:
isolation- string constant representing a default isolation level.
-
getTransactionParameters
Description copied from interface:FirebirdConnectionPropertiesGet the transaction parameter buffer corresponding to the current connection request information.- Specified by:
getTransactionParametersin interfaceFirebirdConnectionProperties- Parameters:
isolation- transaction isolation level for which TPB should be returned.- Returns:
- instance of
TransactionParameterBuffer.
-
setTransactionParameters
Description copied from interface:FirebirdConnectionPropertiesSet transaction parameters for the specified transaction isolation level. The specified TPB is used as a default mapping for the specified isolation level.- Specified by:
setTransactionParametersin interfaceFirebirdConnectionProperties- Parameters:
isolation- transaction isolation level.tpb- instance ofTransactionParameterBuffercontaining transaction parameters.
-
getMapper
- Throws:
FBResourceException
-