Class FBConnectionProperties
- java.lang.Object
- 
- org.firebirdsql.jdbc.FBConnectionProperties
 
- 
- All Implemented Interfaces:
- java.io.Serializable,- java.lang.Cloneable,- FirebirdConnectionProperties
 
 public class FBConnectionProperties extends java.lang.Object implements FirebirdConnectionProperties, java.io.Serializable, java.lang.Cloneable - See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringAUTH_PLUGINSstatic java.lang.StringBLOB_BUFFER_SIZE_PROPERTYstatic java.lang.StringBUFFERS_NUMBER_PROPERTYstatic java.lang.StringCONNECT_TIMEOUTstatic java.lang.StringDATA_TYPE_BINDstatic java.lang.StringDATABASE_PROPERTYstatic java.lang.StringDB_CRYPT_CONFIGstatic java.lang.StringDEFAULT_HOLDABLE_RS_PROPERTYstatic java.lang.StringDEFAULT_ISOLATION_PROPERTYstatic java.lang.StringENCODING_PROPERTYstatic java.lang.StringGENERATED_KEYS_ENABLEDstatic java.lang.StringIGNORE_PROCEDURE_TYPEstatic java.lang.StringISOLATION_PROPERTYstatic java.lang.StringLOCAL_ENCODING_PROPERTYstatic java.lang.StringPASSWORD_PROPERTYstatic java.lang.StringROLE_NAME_PROPERTYstatic java.lang.StringSESSION_TIME_ZONEstatic java.lang.StringSO_TIMEOUTstatic java.lang.StringSOCKET_BUFFER_SIZE_PROPERTYstatic java.lang.StringSQL_DIALECT_PROPERTYstatic java.lang.StringTIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTYstatic java.lang.StringTYPE_PROPERTYstatic java.lang.StringUSE_FIREBIRD_AUTOCOMMITstatic java.lang.StringUSE_STANDARD_UDF_PROPERTYstatic java.lang.StringUSE_STREAM_BLOBS_PROPERTYstatic java.lang.StringUSER_NAME_PROPERTYstatic java.lang.StringWIRE_COMPRESSIONstatic java.lang.StringWIRE_CRYPT_LEVEL
 - 
Constructor SummaryConstructors Constructor Description FBConnectionProperties()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Objectclone()booleanequals(java.lang.Object obj)java.lang.StringgetAuthPlugins()Get the list of authentication plugins to try.intgetBlobBufferSize()intgetBuffersNumber()java.lang.StringgetCharSet()intgetConnectTimeout()Get the current connect timeout.java.lang.StringgetDatabase()DatabaseParameterBuffergetDatabaseParameterBuffer()Deprecated.TODO Usage of this method should be removed or revised as current use of default encoding is not correct.java.lang.StringgetDataTypeBind()Get thedataTypeBindconfiguration.java.lang.StringgetDbCryptConfig()Get the database encryption plugin configuration.java.lang.StringgetDefaultIsolation()Get the default transaction isolation level as string.intgetDefaultTransactionIsolation()Get the default transaction isolation level.java.lang.StringgetEncoding()java.lang.StringgetGeneratedKeysEnabled()Get thegeneratedKeysEnabledconfiguration.FBTpbMappergetMapper()java.lang.StringgetNonStandardProperty(java.lang.String key)Get the property that does not have corresponding getter method by its name.java.lang.StringgetPassword()java.lang.StringgetRoleName()java.lang.StringgetSessionTimeZone()Get thesessionTimeZone.intgetSocketBufferSize()intgetSoTimeout()Get the current Socket blocking timeout (SoTimeout).java.lang.StringgetSqlDialect()java.lang.StringgetTpbMapping()Get the used TPB mapping.TransactionParameterBuffergetTransactionParameters(int isolation)Get the transaction parameter buffer corresponding to the current connection request information.java.lang.StringgetType()java.lang.StringgetUserName()java.lang.StringgetWireCrypt()Get the wire encryption level value.inthashCode()booleanisDefaultResultSetHoldable()Get the default ResultSet holdability.booleanisIgnoreProcedureType()Get the value forignoreProcedureType.booleanisTimestampUsesLocalTimezone()booleanisUseFirebirdAutocommit()Get whether to use Firebird autocommit (experimental).booleanisUseStandardUdf()booleanisUseStreamBlobs()booleanisWireCompression()Get if wire compression should be enabled.voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.voidsetBlobBufferSize(int bufferSize)voidsetBuffersNumber(int buffersNumber)voidsetCharSet(java.lang.String charSet)voidsetConnectTimeout(int connectTimeout)Set the connect timeout.voidsetDatabase(java.lang.String database)voidsetDataTypeBind(java.lang.String dataTypeBind)Sets thedataTypeBindconfiguration.voidsetDbCryptConfig(java.lang.String dbCryptConfig)Sets the database encryption plugin configuration.voidsetDefaultIsolation(java.lang.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(java.lang.String encoding)voidsetGeneratedKeysEnabled(java.lang.String generatedKeysEnabled)Sets thegeneratedKeysEnabledconfiguration.voidsetIgnoreProcedureType(boolean ignoreProcedureType)Sets the valueignoreProcedureType.voidsetNonStandardProperty(java.lang.String propertyMapping)Set the property that does not have corresponding setter method.voidsetNonStandardProperty(java.lang.String key, java.lang.String value)Set the property that does not have corresponding setter method.voidsetPassword(java.lang.String password)voidsetRoleName(java.lang.String roleName)voidsetSessionTimeZone(java.lang.String sessionTimeZone)Sets thesessionTimeZone.voidsetSocketBufferSize(int socketBufferSize)voidsetSoTimeout(int soTimeout)Set the Socket blocking timeout (SoTimeout).voidsetSqlDialect(java.lang.String sqlDialect)voidsetTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone)voidsetTpbMapping(java.lang.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.voidsetType(java.lang.String type)voidsetUseFirebirdAutocommit(boolean useFirebirdAutocommit)Set whether to use Firebird autocommit (experimental).voidsetUserName(java.lang.String userName)voidsetUseStandardUdf(boolean useStandardUdf)voidsetUseStreamBlobs(boolean useStreamBlobs)voidsetWireCompression(boolean wireCompression)Sets if the connection should try to enable wire compression.voidsetWireCrypt(java.lang.String wireCrypt)Sets the wire encryption level.
 
- 
- 
- 
Field Detail- 
DATABASE_PROPERTYpublic static final java.lang.String DATABASE_PROPERTY - See Also:
- Constant Field Values
 
 - 
TYPE_PROPERTYpublic static final java.lang.String TYPE_PROPERTY - See Also:
- Constant Field Values
 
 - 
ISOLATION_PROPERTYpublic static final java.lang.String ISOLATION_PROPERTY - See Also:
- Constant Field Values
 
 - 
DEFAULT_ISOLATION_PROPERTYpublic static final java.lang.String DEFAULT_ISOLATION_PROPERTY - See Also:
- Constant Field Values
 
 - 
BLOB_BUFFER_SIZE_PROPERTYpublic static final java.lang.String BLOB_BUFFER_SIZE_PROPERTY - See Also:
- Constant Field Values
 
 - 
LOCAL_ENCODING_PROPERTYpublic static final java.lang.String LOCAL_ENCODING_PROPERTY - See Also:
- Constant Field Values
 
 - 
ENCODING_PROPERTYpublic static final java.lang.String ENCODING_PROPERTY - See Also:
- Constant Field Values
 
 - 
ROLE_NAME_PROPERTYpublic static final java.lang.String ROLE_NAME_PROPERTY - See Also:
- Constant Field Values
 
 - 
SQL_DIALECT_PROPERTYpublic static final java.lang.String SQL_DIALECT_PROPERTY - See Also:
- Constant Field Values
 
 - 
USE_STREAM_BLOBS_PROPERTYpublic static final java.lang.String USE_STREAM_BLOBS_PROPERTY - See Also:
- Constant Field Values
 
 - 
USE_STANDARD_UDF_PROPERTYpublic static final java.lang.String USE_STANDARD_UDF_PROPERTY - See Also:
- Constant Field Values
 
 - 
SOCKET_BUFFER_SIZE_PROPERTYpublic static final java.lang.String SOCKET_BUFFER_SIZE_PROPERTY - See Also:
- Constant Field Values
 
 - 
TIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTYpublic static final java.lang.String TIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTY - See Also:
- Constant Field Values
 
 - 
USER_NAME_PROPERTYpublic static final java.lang.String USER_NAME_PROPERTY - See Also:
- Constant Field Values
 
 - 
PASSWORD_PROPERTYpublic static final java.lang.String PASSWORD_PROPERTY - See Also:
- Constant Field Values
 
 - 
BUFFERS_NUMBER_PROPERTYpublic static final java.lang.String BUFFERS_NUMBER_PROPERTY - See Also:
- Constant Field Values
 
 - 
DEFAULT_HOLDABLE_RS_PROPERTYpublic static final java.lang.String DEFAULT_HOLDABLE_RS_PROPERTY - See Also:
- Constant Field Values
 
 - 
SO_TIMEOUTpublic static final java.lang.String SO_TIMEOUT - See Also:
- Constant Field Values
 
 - 
CONNECT_TIMEOUTpublic static final java.lang.String CONNECT_TIMEOUT - See Also:
- Constant Field Values
 
 - 
USE_FIREBIRD_AUTOCOMMITpublic static final java.lang.String USE_FIREBIRD_AUTOCOMMIT - See Also:
- Constant Field Values
 
 - 
WIRE_CRYPT_LEVELpublic static final java.lang.String WIRE_CRYPT_LEVEL - See Also:
- Constant Field Values
 
 - 
DB_CRYPT_CONFIGpublic static final java.lang.String DB_CRYPT_CONFIG - See Also:
- Constant Field Values
 
 - 
AUTH_PLUGINSpublic static final java.lang.String AUTH_PLUGINS - See Also:
- Constant Field Values
 
 - 
GENERATED_KEYS_ENABLEDpublic static final java.lang.String GENERATED_KEYS_ENABLED - See Also:
- Constant Field Values
 
 - 
DATA_TYPE_BINDpublic static final java.lang.String DATA_TYPE_BIND - See Also:
- Constant Field Values
 
 - 
SESSION_TIME_ZONEpublic static final java.lang.String SESSION_TIME_ZONE - See Also:
- Constant Field Values
 
 - 
IGNORE_PROCEDURE_TYPEpublic static final java.lang.String IGNORE_PROCEDURE_TYPE - See Also:
- Constant Field Values
 
 - 
WIRE_COMPRESSIONpublic static final java.lang.String WIRE_COMPRESSION - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
clonepublic java.lang.Object clone() - Overrides:
- clonein class- java.lang.Object
 
 - 
getDatabasepublic java.lang.String getDatabase() - Specified by:
- getDatabasein interface- FirebirdConnectionProperties
- Returns:
- path to the database including the server name and the port, if needed.
 
 - 
setDatabasepublic void setDatabase(java.lang.String database) - Specified by:
- setDatabasein interface- FirebirdConnectionProperties
- Parameters:
- database- path to the database including the server name and the port, if needed.
 
 - 
getTypepublic java.lang.String getType() - Specified by:
- getTypein interface- FirebirdConnectionProperties
- Returns:
- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
 
 - 
setTypepublic void setType(java.lang.String type) - Specified by:
- setTypein interface- FirebirdConnectionProperties
- Parameters:
- type- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
 
 - 
getBlobBufferSizepublic int getBlobBufferSize() - Specified by:
- getBlobBufferSizein interface- FirebirdConnectionProperties
- Returns:
- BLOB buffer size in bytes.
 
 - 
setBlobBufferSizepublic void setBlobBufferSize(int bufferSize) - Specified by:
- setBlobBufferSizein interface- FirebirdConnectionProperties
- Parameters:
- bufferSize- size of the BLOB buffer in bytes.
 
 - 
getCharSetpublic java.lang.String getCharSet() - Specified by:
- getCharSetin interface- FirebirdConnectionProperties
- Returns:
- Character set for the connection.
- See Also:
- FirebirdConnectionProperties.setCharSet(String)
 
 - 
setCharSetpublic void setCharSet(java.lang.String charSet) - Specified by:
- setCharSetin interface- FirebirdConnectionProperties
- Parameters:
- charSet- Character set for the connection. Similar to- encodingproperty, but accepts Java names instead of Firebird ones.
 
 - 
getEncodingpublic java.lang.String getEncoding() - Specified by:
- getEncodingin interface- FirebirdConnectionProperties
- Returns:
- Character encoding for the connection.
- See Also:
- FirebirdConnectionProperties.setEncoding(String)
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) - Specified by:
- setEncodingin interface- FirebirdConnectionProperties
- Parameters:
- encoding- Character encoding for the connection. See Firebird documentation for more information.
 
 - 
getRoleNamepublic java.lang.String getRoleName() - Specified by:
- getRoleNamein interface- FirebirdConnectionProperties
- Returns:
- SQL role to use.
 
 - 
setRoleNamepublic void setRoleName(java.lang.String roleName) - Specified by:
- setRoleNamein interface- FirebirdConnectionProperties
- Parameters:
- roleName- SQL role to use.
 
 - 
getSqlDialectpublic java.lang.String getSqlDialect() - Specified by:
- getSqlDialectin interface- FirebirdConnectionProperties
- Returns:
- SQL dialect of the client.
 
 - 
setSqlDialectpublic void setSqlDialect(java.lang.String sqlDialect) - Specified by:
- setSqlDialectin interface- FirebirdConnectionProperties
- Parameters:
- sqlDialect- SQL dialect of the client.
 
 - 
isUseStreamBlobspublic boolean isUseStreamBlobs() - Specified by:
- isUseStreamBlobsin interface- FirebirdConnectionProperties
- Returns:
- trueif stream blobs should be created, otherwise- false.
 
 - 
setUseStreamBlobspublic void setUseStreamBlobs(boolean useStreamBlobs) - Specified by:
- setUseStreamBlobsin interface- FirebirdConnectionProperties
- Parameters:
- useStreamBlobs-- trueif stream blobs should be created, otherwise- false.
 
 - 
isUseStandardUdfpublic boolean isUseStandardUdf() - Specified by:
- isUseStandardUdfin interface- FirebirdConnectionProperties
- Returns:
- trueif driver should assume that standard UDF are installed.
 
 - 
setUseStandardUdfpublic void setUseStandardUdf(boolean useStandardUdf) - Specified by:
- setUseStandardUdfin interface- FirebirdConnectionProperties
- Parameters:
- useStandardUdf-- trueif driver should assume that standard UDF are installed.
 
 - 
getSocketBufferSizepublic int getSocketBufferSize() - Specified by:
- getSocketBufferSizein interface- FirebirdConnectionProperties
- Returns:
- socket buffer size in bytes, or -1 is not specified.
 
 - 
setSocketBufferSizepublic void setSocketBufferSize(int socketBufferSize) - Specified by:
- setSocketBufferSizein interface- FirebirdConnectionProperties
- Parameters:
- socketBufferSize- socket buffer size in bytes.
 
 - 
isTimestampUsesLocalTimezonepublic boolean isTimestampUsesLocalTimezone() - Specified by:
- isTimestampUsesLocalTimezonein interface- FirebirdConnectionProperties
- Returns:
- trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
 
 - 
setTimestampUsesLocalTimezonepublic void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone) - Specified by:
- setTimestampUsesLocalTimezonein interface- FirebirdConnectionProperties
- Parameters:
- timestampUsesLocalTimezone-- trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
 
 - 
getUserNamepublic java.lang.String getUserName() - Specified by:
- getUserNamein interface- FirebirdConnectionProperties
- Returns:
- name of the user that will be used when connecting to the database.
 
 - 
setUserNamepublic void setUserName(java.lang.String userName) - Specified by:
- setUserNamein interface- FirebirdConnectionProperties
- Parameters:
- userName- name of the user that will be used when connecting to the database.
 
 - 
getPasswordpublic java.lang.String getPassword() - Specified by:
- getPasswordin interface- FirebirdConnectionProperties
- Returns:
- password corresponding to the specified user name.
 
 - 
setPasswordpublic void setPassword(java.lang.String password) - Specified by:
- setPasswordin interface- FirebirdConnectionProperties
- Parameters:
- password- password corresponding to the specified user name.
 
 - 
getBuffersNumberpublic int getBuffersNumber() - Specified by:
- getBuffersNumberin interface- FirebirdConnectionProperties
- 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.
 
 - 
setBuffersNumberpublic void setBuffersNumber(int buffersNumber) - Specified by:
- setBuffersNumberin interface- FirebirdConnectionProperties
- 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.
 
 - 
getNonStandardPropertypublic java.lang.String getNonStandardProperty(java.lang.String key) Description copied from interface:FirebirdConnectionPropertiesGet the property that does not have corresponding getter method by its name.- Specified by:
- getNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- key- name of the property to get.
- Returns:
- value of the property.
 
 - 
setNonStandardPropertypublic void setNonStandardProperty(java.lang.String key, java.lang.String value)Description copied from interface:FirebirdConnectionPropertiesSet the property that does not have corresponding setter method.- Specified by:
- setNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- key- name of the property to set.
- value- value of the property.
 
 - 
isDefaultResultSetHoldablepublic boolean isDefaultResultSetHoldable() Description copied from interface:FirebirdConnectionPropertiesGet the default ResultSet holdability.- Specified by:
- isDefaultResultSetHoldablein interface- FirebirdConnectionProperties
- Returns:
- truewhen ResultSets are holdable by default,- falsenot holdable.
 
 - 
setDefaultResultSetHoldablepublic void setDefaultResultSetHoldable(boolean isHoldable) Description copied from interface:FirebirdConnectionPropertiesSets the default ResultSet holdability.- Specified by:
- setDefaultResultSetHoldablein interface- FirebirdConnectionProperties
- Parameters:
- isHoldable-- truewhen ResultSets are holdable by default,- falsenot holdable.
 
 - 
getSoTimeoutpublic int getSoTimeout() Description copied from interface:FirebirdConnectionPropertiesGet the current Socket blocking timeout (SoTimeout).- Specified by:
- getSoTimeoutin interface- FirebirdConnectionProperties
- Returns:
- The socket blocking timeout in milliseconds (0 is 'infinite')
 
 - 
setSoTimeoutpublic void setSoTimeout(int soTimeout) Description copied from interface:FirebirdConnectionPropertiesSet the Socket blocking timeout (SoTimeout).- Specified by:
- setSoTimeoutin interface- FirebirdConnectionProperties
- Parameters:
- soTimeout- Timeout in milliseconds (0 is 'infinite')
 
 - 
getConnectTimeoutpublic int getConnectTimeout() Description copied from interface:FirebirdConnectionPropertiesGet the current connect timeout.- Specified by:
- getConnectTimeoutin interface- FirebirdConnectionProperties
- Returns:
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
 
 - 
setConnectTimeoutpublic void setConnectTimeout(int connectTimeout) Description copied from interface:FirebirdConnectionPropertiesSet the connect timeout.- Specified by:
- setConnectTimeoutin interface- FirebirdConnectionProperties
- Parameters:
- connectTimeout- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
 
 - 
isUseFirebirdAutocommitpublic boolean isUseFirebirdAutocommit() Description copied from interface:FirebirdConnectionPropertiesGet whether to use Firebird autocommit (experimental).- Specified by:
- isUseFirebirdAutocommitin interface- FirebirdConnectionProperties
- Returns:
- trueuse Firebird autocommit
 
 - 
setUseFirebirdAutocommitpublic void setUseFirebirdAutocommit(boolean useFirebirdAutocommit) Description copied from interface:FirebirdConnectionPropertiesSet whether to use Firebird autocommit (experimental).- Specified by:
- setUseFirebirdAutocommitin interface- FirebirdConnectionProperties
- Parameters:
- useFirebirdAutocommit-- trueUse Firebird autocommit
 
 - 
getWireCryptpublic java.lang.String getWireCrypt() Description copied from interface:FirebirdConnectionPropertiesGet the wire encryption level value.- Specified by:
- getWireCryptin interface- FirebirdConnectionProperties
- Returns:
- Wire encryption level (nullimpliesDEFAULT)
 
 - 
setWireCryptpublic void setWireCrypt(java.lang.String wireCrypt) 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 interface- FirebirdConnectionProperties
- Parameters:
- wireCrypt- Wire encryption level
 
 - 
getDbCryptConfigpublic java.lang.String getDbCryptConfig() Description copied from interface:FirebirdConnectionPropertiesGet the database encryption plugin configuration.- Specified by:
- getDbCryptConfigin interface- FirebirdConnectionProperties
- Returns:
- Database encryption plugin configuration, meaning plugin specific
 
 - 
setDbCryptConfigpublic void setDbCryptConfig(java.lang.String dbCryptConfig) Description copied from interface:FirebirdConnectionPropertiesSets the database encryption plugin configuration.- Specified by:
- setDbCryptConfigin interface- FirebirdConnectionProperties
- Parameters:
- dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
 
 - 
getAuthPluginspublic java.lang.String getAuthPlugins() Description copied from interface:FirebirdConnectionPropertiesGet the list of authentication plugins to try.- Specified by:
- getAuthPluginsin interface- FirebirdConnectionProperties
- Returns:
- comma-separated list of authentication plugins, or nullfor driver default
 
 - 
setAuthPluginspublic void setAuthPlugins(java.lang.String authPlugins) Description copied from interface:FirebirdConnectionPropertiesSets the authentication plugins to try.Invalid names are skipped during authentication. - Specified by:
- setAuthPluginsin interface- FirebirdConnectionProperties
- Parameters:
- authPlugins- comma-separated list of authentication plugins, or- nullfor driver default
 
 - 
getGeneratedKeysEnabledpublic java.lang.String getGeneratedKeysEnabled() Description copied from interface:FirebirdConnectionPropertiesGet thegeneratedKeysEnabledconfiguration.- Specified by:
- getGeneratedKeysEnabledin interface- FirebirdConnectionProperties
- Returns:
- configuration value for generatedKeysEnabled, ornullfor driver default
 
 - 
setGeneratedKeysEnabledpublic void setGeneratedKeysEnabled(java.lang.String generatedKeysEnabled) Description copied from interface:FirebirdConnectionPropertiesSets thegeneratedKeysEnabledconfiguration.- Specified by:
- setGeneratedKeysEnabledin interface- FirebirdConnectionProperties
- 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)
 
 - 
getDataTypeBindpublic java.lang.String getDataTypeBind() Description copied from interface:FirebirdConnectionPropertiesGet thedataTypeBindconfiguration.- Specified by:
- getDataTypeBindin interface- FirebirdConnectionProperties
- Returns:
- configuration value for dataTypeBind, ornullfor driver default
 
 - 
setDataTypeBindpublic void setDataTypeBind(java.lang.String dataTypeBind) 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 interface- FirebirdConnectionProperties
- Parameters:
- dataTypeBind- Firebird 4+ data type bind configuration, a semicolon-separated list of- <from-type> TO <to-type>
 
 - 
getSessionTimeZonepublic java.lang.String getSessionTimeZone() Description copied from interface:FirebirdConnectionPropertiesGet thesessionTimeZone.- Specified by:
- getSessionTimeZonein interface- FirebirdConnectionProperties
- Returns:
- value for sessionTimeZone, ornullfor driver default (JVM default time zone)
 
 - 
setSessionTimeZonepublic void setSessionTimeZone(java.lang.String sessionTimeZone) Description copied from interface:FirebirdConnectionPropertiesSets thesessionTimeZone.- Specified by:
- setSessionTimeZonein interface- FirebirdConnectionProperties
- 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)
 
 - 
isIgnoreProcedureTypepublic boolean isIgnoreProcedureType() Description copied from interface:FirebirdConnectionPropertiesGet the value forignoreProcedureType.- Specified by:
- isIgnoreProcedureTypein interface- FirebirdConnectionProperties
- Returns:
- value for ignoreProcedureType
 
 - 
setIgnoreProcedureTypepublic 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 interface- FirebirdConnectionProperties
- Parameters:
- ignoreProcedureType-- trueIgnore procedure type
 
 - 
isWireCompressionpublic 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 interface- FirebirdConnectionProperties
- Returns:
- truewire compression enabled
 
 - 
setWireCompressionpublic void setWireCompression(boolean wireCompression) Description copied from interface:FirebirdConnectionPropertiesSets if the connection should try to enable wire compression.- Specified by:
- setWireCompressionin interface- FirebirdConnectionProperties
- Parameters:
- wireCompression-- trueenable wire compression,- falsedisable wire compression (the default)
- See Also:
- FirebirdConnectionProperties.isWireCompression()
 
 - 
setNonStandardPropertypublic void setNonStandardProperty(java.lang.String propertyMapping) Description copied from interface:FirebirdConnectionPropertiesSet the property that does not have corresponding setter method.- Specified by:
- setNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- propertyMapping- parameter value in the ?propertyName[=propertyValue]? form, this allows setting non-standard parameters using configuration files.
 
 - 
getDatabaseParameterBuffer@Deprecated public DatabaseParameterBuffer getDatabaseParameterBuffer() throws java.sql.SQLException 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 interface- FirebirdConnectionProperties
- Returns:
- instance of DatabaseParameterBuffer.
- Throws:
- java.sql.SQLException- if database parameter buffer cannot be created.
 
 - 
getTpbMappingpublic java.lang.String getTpbMapping() Description copied from interface:FirebirdConnectionPropertiesGet the used TPB mapping.- Specified by:
- getTpbMappingin interface- FirebirdConnectionProperties
- Returns:
- path to the TPB mapping.
- See Also:
- FirebirdConnectionProperties.setTpbMapping(String)
 
 - 
setTpbMappingpublic void setTpbMapping(java.lang.String tpbMapping) 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 interface- FirebirdConnectionProperties
- Parameters:
- tpbMapping- path to the properties file.
 
 - 
getDefaultTransactionIsolationpublic 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 interface- FirebirdConnectionProperties
- Returns:
- default transaction isolation level.
 
 - 
setDefaultTransactionIsolationpublic void setDefaultTransactionIsolation(int defaultIsolationLevel) Description copied from interface:FirebirdConnectionPropertiesSet the default transaction isolation level.- Specified by:
- setDefaultTransactionIsolationin interface- FirebirdConnectionProperties
- Parameters:
- defaultIsolationLevel- default transaction isolation level.
 
 - 
getDefaultIsolationpublic java.lang.String 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 interface- FirebirdConnectionProperties
- Returns:
- default transaction isolation as string.
- See Also:
- FirebirdConnectionProperties.setDefaultIsolation(String)
 
 - 
setDefaultIsolationpublic void setDefaultIsolation(java.lang.String isolation) 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 interface- FirebirdConnectionProperties
- Parameters:
- isolation- string constant representing a default isolation level.
 
 - 
getTransactionParameterspublic TransactionParameterBuffer getTransactionParameters(int isolation) Description copied from interface:FirebirdConnectionPropertiesGet the transaction parameter buffer corresponding to the current connection request information.- Specified by:
- getTransactionParametersin interface- FirebirdConnectionProperties
- Parameters:
- isolation- transaction isolation level for which TPB should be returned.
- Returns:
- instance of TransactionParameterBuffer.
 
 - 
setTransactionParameterspublic void setTransactionParameters(int isolation, TransactionParameterBuffer tpb)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 interface- FirebirdConnectionProperties
- Parameters:
- isolation- transaction isolation level.
- tpb- instance of- TransactionParameterBuffercontaining transaction parameters.
 
 - 
getMapperpublic FBTpbMapper getMapper() throws FBResourceException - Throws:
- FBResourceException
 
 
- 
 
-