Class AbstractConnectionPropertiesDataSource
- java.lang.Object
- 
- org.firebirdsql.ds.RootCommonDataSource
- 
- org.firebirdsql.ds.AbstractConnectionPropertiesDataSource
 
 
- 
- All Implemented Interfaces:
- javax.sql.CommonDataSource,- AttachmentProperties,- BaseProperties,- DatabaseConnectionProperties,- FirebirdConnectionProperties
 - Direct Known Subclasses:
- FBAbstractCommonDataSource,- FBSimpleDataSource
 
 public abstract class AbstractConnectionPropertiesDataSource extends RootCommonDataSource implements FirebirdConnectionProperties Abstract implementation ofFirebirdConnectionPropertiesto ensure subclasses can be introspected as beans.- Since:
- 5
- Author:
- Mark Rotteveel
 
- 
- 
Constructor SummaryConstructors Constructor Description AbstractConnectionPropertiesDataSource()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetAuthPlugins()Get the list of authentication plugins to try.intgetBlobBufferSize()intgetBuffersNumber()Deprecated.java.lang.StringgetCharSet()Java character set configured for the connection.intgetConnectTimeout()Get the connect timeout in seconds.java.lang.StringgetDatabase()Deprecated.java.lang.StringgetDatabaseName()Gets the database of the connection.java.lang.StringgetDataTypeBind()Get thedataTypeBindconfiguration.java.lang.StringgetDbCryptConfig()Get the database encryption plugin configuration.java.lang.StringgetDecfloatRound()java.lang.StringgetDecfloatTraps()java.lang.StringgetDefaultIsolation()Get the default transaction isolation level as string.intgetDefaultTransactionIsolation()Get the default transaction isolation level.java.lang.StringgetEncoding()Firebird character set configured for the connection.java.lang.StringgetGeneratedKeysEnabled()Get thegeneratedKeysEnabledconfiguration.intgetLoginTimeout()intgetMaxBlobCacheSize()intgetMaxInlineBlobSize()intgetPageCacheSize()Get the page cache size.intgetParallelWorkers()java.lang.StringgetPassword()intgetPortNumber()Get the port number of the server.java.lang.IntegergetProcessId()java.lang.StringgetProcessName()java.lang.StringgetRoleName()java.lang.StringgetScrollableCursor()intgetServerBatchBufferSize()java.lang.StringgetServerName()Get the hostname or IP address of the Firebird server.java.lang.StringgetSessionTimeZone()Get thesessionTimeZone.intgetSocketBufferSize()Get the socket buffer size.intgetSoTimeout()Get the initial Socket blocking timeout (SoTimeout).intgetSqlDialect()java.lang.StringgetTpbMapping()Get the used TPB mapping.java.lang.StringgetType()java.lang.StringgetUser()java.lang.StringgetUserName()Deprecated.java.lang.StringgetWireCrypt()Get the wire encryption level.booleanisColumnLabelForName()Gets the current setting ofcolumnLabelForNamebooleanisDefaultResultSetHoldable()Get whether ResultSets are holdable by default.booleanisExtendedMetadata()booleanisIgnoreProcedureType()Get the value forignoreProcedureType.booleanisTimestampUsesLocalTimezone()Deprecated.booleanisUseFirebirdAutocommit()Get whether to use Firebird autocommit (experimental).booleanisUseServerBatch()booleanisUseStreamBlobs()booleanisWireCompression()Get if wire compression should be enabled.voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.voidsetBlobBufferSize(int blobBufferSize)voidsetBuffersNumber(int buffersNumber)Deprecated.voidsetCharSet(java.lang.String charSet)Set the Java character set for the connection.voidsetColumnLabelForName(boolean columnLabelForName)Set ifResultSetMetaData.getColumnName(int)returns thecolumnLabelinstead of thecolumnName.voidsetConnectTimeout(int connectTimeout)Set the connect timeout in seconds.voidsetDatabase(java.lang.String database)Deprecated.voidsetDatabaseName(java.lang.String databaseName)Sets the database of the connectionvoidsetDataTypeBind(java.lang.String dataTypeBind)Sets thedataTypeBindconfiguration.voidsetDbCryptConfig(java.lang.String dbCryptConfig)Sets the database encryption plugin configuration.voidsetDecfloatRound(java.lang.String decfloatRound)Sets theDECFLOATrounding modevoidsetDecfloatTraps(java.lang.String decfloatTraps)Sets theDECFLOATerror traps.voidsetDefaultIsolation(java.lang.String isolation)Set the default transaction isolation level as string.voidsetDefaultResultSetHoldable(boolean defaultResultSetHoldable)Set ifResultSetshould beResultSet.HOLD_CURSORS_OVER_COMMITby default.voidsetDefaultTransactionIsolation(int defaultIsolationLevel)Set the default transaction isolation level.voidsetEncoding(java.lang.String encoding)Set the Firebird character set for the connection.voidsetExtendedMetadata(boolean extendedMetadata)Sets if certain metadata classes will perform additional queries to enrich the information for certain types.voidsetGeneratedKeysEnabled(java.lang.String generatedKeysEnabled)Sets thegeneratedKeysEnabledconfiguration.voidsetIgnoreProcedureType(boolean ignoreProcedureType)Sets the valueignoreProcedureType.voidsetLoginTimeout(int seconds)voidsetMaxBlobCacheSize(int maxBlobCacheSize)Sets the maximum inline blob cache size.voidsetMaxInlineBlobSize(int maxInlineBlobSize)Sets the maximum inline blob size.voidsetPageCacheSize(int pageCacheSize)Set the page cache size.voidsetParallelWorkers(int parallelWorkers)Sets the number of parallel workers of the connection.voidsetPassword(java.lang.String password)voidsetPortNumber(int portNumber)Set the port number of the server.voidsetProcessId(java.lang.Integer processId)Sets a custom process id to send to Firebird on attach.voidsetProcessName(java.lang.String processName)Sets a custom process name to send to Firebird on attachvoidsetRoleName(java.lang.String roleName)voidsetScrollableCursor(java.lang.String scrollableCursor)Sets the type of scrollable cursor.voidsetServerBatchBufferSize(int serverBatchBufferSize)Sets the server batch buffer size (if server batch is supported and enabled).voidsetServerName(java.lang.String serverName)Set the hostname or IP address of the Firebird server.voidsetSessionTimeZone(java.lang.String sessionTimeZone)Sets thesessionTimeZone.voidsetSocketBufferSize(int socketBufferSize)Set the socket buffer size.voidsetSoTimeout(int soTimeout)Set the initial Socket blocking timeout (SoTimeout).voidsetSqlDialect(int sqlDialect)voidsetTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone)Deprecated.voidsetTpbMapping(java.lang.String tpbMapping)Set path to the properties file with the TPB mapping.voidsetType(java.lang.String type)voidsetUseFirebirdAutocommit(boolean useFirebirdAutocommit)Set whether to use Firebird autocommit (experimental).voidsetUser(java.lang.String user)voidsetUserName(java.lang.String userName)Deprecated.voidsetUseServerBatch(boolean useServerBatch)Sets whether to use server-side batch support, if available.voidsetUseStreamBlobs(boolean useStreamBlobs)voidsetWireCompression(boolean wireCompression)Sets if the connection should try to enable wire compression.voidsetWireCrypt(java.lang.String wireCrypt)Set the wire encryption level.- 
Methods inherited from class org.firebirdsql.ds.RootCommonDataSourcegetLogWriter, getParentLogger, setLogWriter
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.firebirdsql.jaybird.props.BasePropertiesconnectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setProperty
 - 
Methods inherited from interface org.firebirdsql.jdbc.FirebirdConnectionPropertiesgetNonStandardProperty, getTransactionParameters, setNonStandardProperty, setNonStandardProperty, setTransactionParameters
 
- 
 
- 
- 
- 
Method Detail- 
getServerNamepublic java.lang.String getServerName() Description copied from interface:AttachmentPropertiesGet the hostname or IP address of the Firebird server.- Specified by:
- getServerNamein interface- AttachmentProperties
- Returns:
- Hostname or IP address of the server
- See Also:
- AttachmentProperties.setServerName(String)
 
 - 
setServerNamepublic void setServerName(java.lang.String serverName) Description copied from interface:AttachmentPropertiesSet the hostname or IP address of the Firebird server.When set to null(the default), thedatabaseNameorserviceNameis used as the full identification of the database host, port and database path/alias. Protocol implementations, for examplePURE_JAVA, may default tolocalhostwhen this property isnull, butdatabaseName/serviceNamedoes not (seem to) contain a host name.- Specified by:
- setServerNamein interface- AttachmentProperties
- Parameters:
- serverName- Hostname or IP address of the server
 
 - 
getPortNumberpublic int getPortNumber() Description copied from interface:AttachmentPropertiesGet the port number of the server.- Specified by:
- getPortNumberin interface- AttachmentProperties
- Returns:
- Port number of the server
- See Also:
- AttachmentProperties.setPortNumber(int)
 
 - 
setPortNumberpublic void setPortNumber(int portNumber) Description copied from interface:AttachmentPropertiesSet the port number of the server.Defaults to 3050. This property value will be ignored ifserverNameisnull, unless the protocol implementation needs a hostname, but cannot find a hostname indatabaseName/serviceName.- Specified by:
- setPortNumberin interface- AttachmentProperties
- Parameters:
- portNumber- Port number of the server
- See Also:
- AttachmentProperties.setServerName(String)
 
 - 
getDatabaseNamepublic java.lang.String getDatabaseName() Description copied from interface:DatabaseConnectionPropertiesGets the database of the connection.- Specified by:
- getDatabaseNamein interface- DatabaseConnectionProperties
- Returns:
- database name
- See Also:
- DatabaseConnectionProperties.setDatabaseName(String)
 
 - 
setDatabaseNamepublic void setDatabaseName(java.lang.String databaseName) Description copied from interface:DatabaseConnectionPropertiesSets the database of the connectionWhen serverNameisnull, the value is taken as the URL of the database, and exact interpretation depends on the protocol implementation (type). Basically, the URL would be the JDBC URL, but without thejdbc:firebird[sql]:[subprotocol:]prefix and without connection properties. Examples:- //localhost/employee — PURE_JAVA, OOREMOTE, NATIVE (for NATIVE, this format is parsed and transformed to the next example)
- localhost:employee — NATIVE, PURE_JAVA, OOREMOTE
- //localhost:3051/employee — PURE_JAVA, OOREMOTE, NATIVE (for NATIVE, this format is parsed and transformed to the next example)
- localhost/3051:employee — NATIVE, PURE_JAVA, OOREMOTE
- /path/to/your.fdb — NATIVE, EMBEDDED, PURE_JAVA, OOREMOTE (PURE_JAVA and OOREMOTE will use localhost
 as serverName, depending on the Firebird version and platform, NATIVE may use Firebird Embedded)
- C:\path\to\your.fdb — NATIVE, EMBEDDED (protocols like PURE_JAVA may attempt to connect to a server
 called C, depending on the Firebird version and platform, NATIVE may use Firebird Embedded)
- C:/path/to/your.fdb — NATIVE, EMBEDDED (protocols like PURE_JAVA may attempt to connect to a server
 called C, depending on the Firebird version and platform, NATIVE may use Firebird Embedded)
- xnet://employee — NATIVE (EMBEDDED will behave as NATIVE, protocols like PURE_JAVA may
 attempt to connect to a server called xnet)
- other Firebird fbclientconnection URLs — NATIVE (EMBEDDED will behave as NATIVE, protocols like PURE_JAVA may interpret the protocol name as a host name
- Custom typeimplementations may support other URL formats
 Some protocols, for example PURE_JAVA, when serverNameis not set, butdatabaseNamedoesn't seem to contain a host name, may default to attempting to connect to localhost withdatabaseNameas the database path or alias.When serverNameis set, the value is taken as the database path or alias. Examples:- employee
- /path/to/your.fdb
- C:\path\to\your.fdb
- C:/path/to/your.fdb
- relative/path/to/your.fdb — not recommended
 - Specified by:
- setDatabaseNamein interface- DatabaseConnectionProperties
- Parameters:
- databaseName- database name
 
 - 
getDatabase@Deprecated public java.lang.String getDatabase() Deprecated.- Specified by:
- getDatabasein interface- FirebirdConnectionProperties
- Returns:
- path to the database including the server name and the port, if needed.
 
 - 
setDatabase@Deprecated public void setDatabase(java.lang.String database) Deprecated.- 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- AttachmentProperties
- Returns:
- type of the connection, for example, "PURE_JAVA", "NATIVE", "EMBEDDED", depends on the GDS implementations installed in the system.
 
 - 
setTypepublic void setType(java.lang.String type) - Specified by:
- setTypein interface- AttachmentProperties
- Parameters:
- type- type of the connection, for example, "PURE_JAVA", "NATIVE", "EMBEDDED", depends on the GDS implementations installed in the system.
 
 - 
getUserpublic java.lang.String getUser() - Specified by:
- getUserin interface- AttachmentProperties
- Returns:
- Name of the user to authenticate to the server.
 
 - 
setUserpublic void setUser(java.lang.String user) - Specified by:
- setUserin interface- AttachmentProperties
- Parameters:
- user- Name of the user to authenticate to the server.
 
 - 
getPasswordpublic java.lang.String getPassword() - Specified by:
- getPasswordin interface- AttachmentProperties
- Returns:
- Password to authenticate to the server.
 
 - 
setPasswordpublic void setPassword(java.lang.String password) - Specified by:
- setPasswordin interface- AttachmentProperties
- Parameters:
- password- Password to authenticate to the server.
 
 - 
getRoleNamepublic java.lang.String getRoleName() - Specified by:
- getRoleNamein interface- AttachmentProperties
- Returns:
- SQL role to use.
 
 - 
setRoleNamepublic void setRoleName(java.lang.String roleName) - Specified by:
- setRoleNamein interface- AttachmentProperties
- Parameters:
- roleName- SQL role to use.
 
 - 
getCharSetpublic java.lang.String getCharSet() Description copied from interface:AttachmentPropertiesJava character set configured for the connection.After connect, the actual Java character set applied can be obtained from FbAttachment.getEncoding()(propertycharsetName), orFbAttachment.getEncodingFactory()(propertiesdefaultEncoding.charsetNameor {code defaultEncodingDefinition.javaCharset}).- Specified by:
- getCharSetin interface- AttachmentProperties
- Returns:
- Java character set for the connection (nullwhen not explicitly configured).
 
 - 
setCharSetpublic void setCharSet(java.lang.String charSet) Description copied from interface:AttachmentPropertiesSet the Java character set for the connection.It is possible to set both the charSetandencodingto achieve a character set conversion effect, but in general only one of both properties should be set.- Specified by:
- setCharSetin interface- AttachmentProperties
- Parameters:
- charSet- Character set for the connection. Similar to- encodingproperty, but accepts Java names instead of Firebird ones.
- See Also:
- AttachmentProperties.setEncoding(String)
 
 - 
getEncodingpublic java.lang.String getEncoding() Description copied from interface:AttachmentPropertiesFirebird character set configured for the connection.After connect, the actual Firebird character set applied can be obtained from FbAttachment.getEncodingFactory(), propertydefaultEncodingDefinition.firebirdEncodingName.- Specified by:
- getEncodingin interface- AttachmentProperties
- Returns:
- Firebird character encoding for the connection (nullwhen not explicitly configured).
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) Description copied from interface:AttachmentPropertiesSet the Firebird character set for the connection.It is possible to set both the charSetandencodingto achieve a character set conversion effect, but in general only one of both properties should be set.- Specified by:
- setEncodingin interface- AttachmentProperties
- Parameters:
- encoding- Firebird character encoding for the connection. See Firebird documentation for more information.
- See Also:
- AttachmentProperties.setCharSet(String)
 
 - 
getProcessIdpublic java.lang.Integer getProcessId() - Specified by:
- getProcessIdin interface- AttachmentProperties
- Returns:
- Custom process id sent to Firebird on attach; nullmeans the default is applied (read from system propertyorg.firebirdsql.jdbc.pid, future versions may also determine the actual process id)
 
 - 
setProcessIdpublic void setProcessId(java.lang.Integer processId) Description copied from interface:AttachmentPropertiesSets a custom process id to send to Firebird on attach.- Specified by:
- setProcessIdin interface- AttachmentProperties
- Parameters:
- processId- The process id to send;- nullto apply the default behaviour (see- AttachmentProperties.getProcessId())
 
 - 
getProcessNamepublic java.lang.String getProcessName() - Specified by:
- getProcessNamein interface- AttachmentProperties
- Returns:
- Custom process name sent to Firebird on attach; nullmeans the default is applied (read from system propertyorg.firebirdsql.jdbc.processName)
 
 - 
setProcessNamepublic void setProcessName(java.lang.String processName) Description copied from interface:AttachmentPropertiesSets a custom process name to send to Firebird on attach- Specified by:
- setProcessNamein interface- AttachmentProperties
- Parameters:
- processName- The process name to send;- nullto apply the default behaviour (see- AttachmentProperties.getProcessName())
 
 - 
getSocketBufferSizepublic int getSocketBufferSize() Description copied from interface:AttachmentPropertiesGet the socket buffer size.- Specified by:
- getSocketBufferSizein interface- AttachmentProperties
- Returns:
- socket buffer size in bytes, or -1if not set
 
 - 
setSocketBufferSizepublic void setSocketBufferSize(int socketBufferSize) Description copied from interface:AttachmentPropertiesSet the socket buffer size.- Specified by:
- setSocketBufferSizein interface- AttachmentProperties
- Parameters:
- socketBufferSize- socket buffer size in bytes.
 
 - 
getSoTimeoutpublic int getSoTimeout() Description copied from interface:AttachmentPropertiesGet the initial Socket blocking timeout (SoTimeout).- Specified by:
- getSoTimeoutin interface- AttachmentProperties
- Returns:
- The initial socket blocking timeout in milliseconds (0 is 'infinite'), or -1if not set
 
 - 
setSoTimeoutpublic void setSoTimeout(int soTimeout) Description copied from interface:AttachmentPropertiesSet the initial Socket blocking timeout (SoTimeout).- Specified by:
- setSoTimeoutin interface- AttachmentProperties
- Parameters:
- soTimeout- Timeout in milliseconds (0 is 'infinite')
 
 - 
getConnectTimeoutpublic int getConnectTimeout() Description copied from interface:AttachmentPropertiesGet the connect timeout in seconds.- Specified by:
- getConnectTimeoutin interface- AttachmentProperties
- Returns:
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout), or -1if not set
 
 - 
setConnectTimeoutpublic void setConnectTimeout(int connectTimeout) Description copied from interface:AttachmentPropertiesSet the connect timeout in seconds.- Specified by:
- setConnectTimeoutin interface- AttachmentProperties
- Parameters:
- connectTimeout- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
 
 - 
getLoginTimeoutpublic int getLoginTimeout() throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property. - Specified by:
- getLoginTimeoutin interface- javax.sql.CommonDataSource
- Throws:
- java.sql.SQLException
 
 - 
setLoginTimeoutpublic void setLoginTimeout(int seconds) throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property. - Specified by:
- setLoginTimeoutin interface- javax.sql.CommonDataSource
- Throws:
- java.sql.SQLException
 
 - 
getWireCryptpublic java.lang.String getWireCrypt() Description copied from interface:AttachmentPropertiesGet the wire encryption level.- Specified by:
- getWireCryptin interface- AttachmentProperties
- Returns:
- Wire encryption level
 
 - 
setWireCryptpublic void setWireCrypt(java.lang.String wireCrypt) Description copied from interface:AttachmentPropertiesSet the wire encryption level.Values are defined by WireCrypt, values are handled case insensitive. Invalid values will throw an exception.- Specified by:
- setWireCryptin interface- AttachmentProperties
- Parameters:
- wireCrypt- Wire encryption level (- nullnot allowed)
 
 - 
getDbCryptConfigpublic java.lang.String getDbCryptConfig() Description copied from interface:AttachmentPropertiesGet the database encryption plugin configuration.- Specified by:
- getDbCryptConfigin interface- AttachmentProperties
- Returns:
- Database encryption plugin configuration, meaning plugin specific
 
 - 
setDbCryptConfigpublic void setDbCryptConfig(java.lang.String dbCryptConfig) Description copied from interface:AttachmentPropertiesSets the database encryption plugin configuration.- Specified by:
- setDbCryptConfigin interface- AttachmentProperties
- Parameters:
- dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
 
 - 
getAuthPluginspublic java.lang.String getAuthPlugins() Description copied from interface:AttachmentPropertiesGet the list of authentication plugins to try.- Specified by:
- getAuthPluginsin interface- AttachmentProperties
- Returns:
- comma-separated list of authentication plugins
 
 - 
setAuthPluginspublic void setAuthPlugins(java.lang.String authPlugins) Description copied from interface:AttachmentPropertiesSets the authentication plugins to try.Invalid names are skipped during authentication. - Specified by:
- setAuthPluginsin interface- AttachmentProperties
- Parameters:
- authPlugins- comma-separated list of authentication plugins
 
 - 
isWireCompressionpublic boolean isWireCompression() Description copied from interface:AttachmentPropertiesGet 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- AttachmentProperties
- Returns:
- truewire compression enabled
 
 - 
setWireCompressionpublic void setWireCompression(boolean wireCompression) Description copied from interface:AttachmentPropertiesSets if the connection should try to enable wire compression.- Specified by:
- setWireCompressionin interface- AttachmentProperties
- Parameters:
- wireCompression-- trueenable wire compression,- falsedisable wire compression (the default)
- See Also:
- AttachmentProperties.isWireCompression()
 
 - 
getSqlDialectpublic int getSqlDialect() - Specified by:
- getSqlDialectin interface- DatabaseConnectionProperties
- Returns:
- SQL dialect of the client connection
 
 - 
setSqlDialectpublic void setSqlDialect(int sqlDialect) - Specified by:
- setSqlDialectin interface- DatabaseConnectionProperties
- Parameters:
- sqlDialect- SQL dialect of the client connection.
 
 - 
getPageCacheSizepublic int getPageCacheSize() Description copied from interface:DatabaseConnectionPropertiesGet the page cache size.A value of 0indicates that the value is not set, and that the server default is used.This option is only relevant for Firebird implementations with per connection cache (eg Classic) NOTE: Implementer should take care to return 0if the value hasn't been set yet.- Specified by:
- getPageCacheSizein interface- DatabaseConnectionProperties
- Returns:
- size of cache in pages for this connection, can be specified for Classic and SuperClassic instances, ignored for SuperServer as the cache is shared; 0 when not set
 
 - 
setPageCacheSizepublic void setPageCacheSize(int pageCacheSize) Description copied from interface:DatabaseConnectionPropertiesSet the page cache size.A value of 0indicates that the value is not set, and that the server default is used.This option is only relevant for Firebird implementations with per connection cache (eg Classic). - Specified by:
- setPageCacheSizein interface- DatabaseConnectionProperties
- Parameters:
- pageCacheSize- size of cache in pages for this connection, can be specified for Classic and SuperClassic instances ignored for SuperServer as the cache is shared.
 
 - 
getDataTypeBindpublic java.lang.String getDataTypeBind() Description copied from interface:DatabaseConnectionPropertiesGet thedataTypeBindconfiguration.- Specified by:
- getDataTypeBindin interface- DatabaseConnectionProperties
- Returns:
- configuration value for dataTypeBind, ornullfor driver default
 
 - 
setDataTypeBindpublic void setDataTypeBind(java.lang.String dataTypeBind) Description copied from interface:DatabaseConnectionPropertiesSets 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- DatabaseConnectionProperties
- 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:DatabaseConnectionPropertiesGet thesessionTimeZone.- Specified by:
- getSessionTimeZonein interface- DatabaseConnectionProperties
- Returns:
- value for sessionTimeZone, ornullfor driver default (JVM default time zone)
 
 - 
setSessionTimeZonepublic void setSessionTimeZone(java.lang.String sessionTimeZone) Description copied from interface:DatabaseConnectionPropertiesSets thesessionTimeZone.- Specified by:
- setSessionTimeZonein interface- DatabaseConnectionProperties
- 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)
 
 - 
getBlobBufferSizepublic int getBlobBufferSize() - Specified by:
- getBlobBufferSizein interface- DatabaseConnectionProperties
- Returns:
- BLOB buffer size in bytes; if the configured value is less than an implementation-specific minimum, that minimum is returned
 
 - 
setBlobBufferSizepublic void setBlobBufferSize(int blobBufferSize) - Specified by:
- setBlobBufferSizein interface- DatabaseConnectionProperties
- Parameters:
- blobBufferSize- size of the BLOB buffer in bytes
 
 - 
isUseStreamBlobspublic boolean isUseStreamBlobs() - Specified by:
- isUseStreamBlobsin interface- DatabaseConnectionProperties
- Returns:
- trueif stream blobs should be created, otherwise- false.
 
 - 
setUseStreamBlobspublic void setUseStreamBlobs(boolean useStreamBlobs) - Specified by:
- setUseStreamBlobsin interface- DatabaseConnectionProperties
- Parameters:
- useStreamBlobs-- trueif stream blobs should be created, otherwise- false.
 
 - 
isDefaultResultSetHoldablepublic boolean isDefaultResultSetHoldable() Description copied from interface:DatabaseConnectionPropertiesGet whether ResultSets are holdable by default.- Specified by:
- isDefaultResultSetHoldablein interface- DatabaseConnectionProperties
- Returns:
- trueResultSets by default are- ResultSet.HOLD_CURSORS_OVER_COMMIT,- false(default), ResultSets are- ResultSet.CLOSE_CURSORS_AT_COMMIT
 
 - 
setDefaultResultSetHoldablepublic void setDefaultResultSetHoldable(boolean defaultResultSetHoldable) Description copied from interface:DatabaseConnectionPropertiesSet ifResultSetshould beResultSet.HOLD_CURSORS_OVER_COMMITby default.- Specified by:
- setDefaultResultSetHoldablein interface- DatabaseConnectionProperties
- Parameters:
- defaultResultSetHoldable-- trueResultSets are holdable,- false(default) ResultSets are- ResultSet.CLOSE_CURSORS_AT_COMMIT
 
 - 
isUseFirebirdAutocommitpublic boolean isUseFirebirdAutocommit() Description copied from interface:DatabaseConnectionPropertiesGet whether to use Firebird autocommit (experimental).- Specified by:
- isUseFirebirdAutocommitin interface- DatabaseConnectionProperties
- Returns:
- trueuse Firebird autocommit
 
 - 
setUseFirebirdAutocommitpublic void setUseFirebirdAutocommit(boolean useFirebirdAutocommit) Description copied from interface:DatabaseConnectionPropertiesSet whether to use Firebird autocommit (experimental).- Specified by:
- setUseFirebirdAutocommitin interface- DatabaseConnectionProperties
- Parameters:
- useFirebirdAutocommit-- trueUse Firebird autocommit
 
 - 
isColumnLabelForNamepublic boolean isColumnLabelForName() Description copied from interface:DatabaseConnectionPropertiesGets the current setting ofcolumnLabelForName- Specified by:
- isColumnLabelForNamein interface- DatabaseConnectionProperties
- Returns:
- falseJDBC compliant behavior (- columnNameis returned),- truecompatibility option (- columnLabelis returned)
- See Also:
- DatabaseConnectionProperties.setColumnLabelForName(boolean)
 
 - 
setColumnLabelForNamepublic void setColumnLabelForName(boolean columnLabelForName) Description copied from interface:DatabaseConnectionPropertiesSet ifResultSetMetaData.getColumnName(int)returns thecolumnLabelinstead of thecolumnName.The default behaviour (with columnLabelForName=falseis JDBC-compliant. The behavior for valuetrueis to provide compatibility with tools with a wrong expectation.- Specified by:
- setColumnLabelForNamein interface- DatabaseConnectionProperties
- Parameters:
- columnLabelForName-- falseJDBC compliant behavior (- columnNameis returned),- truecompatibility option (- columnLabelis returned)
 
 - 
getGeneratedKeysEnabledpublic java.lang.String getGeneratedKeysEnabled() Description copied from interface:DatabaseConnectionPropertiesGet thegeneratedKeysEnabledconfiguration.- Specified by:
- getGeneratedKeysEnabledin interface- DatabaseConnectionProperties
- Returns:
- configuration value for generatedKeysEnabled, ornullfor driver default
 
 - 
setGeneratedKeysEnabledpublic void setGeneratedKeysEnabled(java.lang.String generatedKeysEnabled) Description copied from interface:DatabaseConnectionPropertiesSets thegeneratedKeysEnabledconfiguration.- Specified by:
- setGeneratedKeysEnabledin interface- DatabaseConnectionProperties
- 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)
 
 - 
isIgnoreProcedureTypepublic boolean isIgnoreProcedureType() Description copied from interface:DatabaseConnectionPropertiesGet the value forignoreProcedureType.- Specified by:
- isIgnoreProcedureTypein interface- DatabaseConnectionProperties
- Returns:
- value for ignoreProcedureType
 
 - 
setIgnoreProcedureTypepublic void setIgnoreProcedureType(boolean ignoreProcedureType) Description copied from interface:DatabaseConnectionPropertiesSets 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- DatabaseConnectionProperties
- Parameters:
- ignoreProcedureType-- trueIgnore procedure type
 
 - 
getDecfloatRoundpublic java.lang.String getDecfloatRound() - Specified by:
- getDecfloatRoundin interface- DatabaseConnectionProperties
- Returns:
- the server-side DECFLOATrounding mode,nullapplies the Firebird server default
 
 - 
setDecfloatRoundpublic void setDecfloatRound(java.lang.String decfloatRound) Description copied from interface:DatabaseConnectionPropertiesSets theDECFLOATrounding mode- Specified by:
- setDecfloatRoundin interface- DatabaseConnectionProperties
- Parameters:
- decfloatRound- Firebird 4+ server-side- DECFLOATrounding mode (- ceiling, up, half_up, half_even, half_down, down, floor, reround);- nullto apply the Firebird server default (- half_upin Firebird 4)
 
 - 
getDecfloatTrapspublic java.lang.String getDecfloatTraps() - Specified by:
- getDecfloatTrapsin interface- DatabaseConnectionProperties
- Returns:
- the server-side DECFLOATerror traps,nullapplies the Firebird server default
 
 - 
setDecfloatTrapspublic void setDecfloatTraps(java.lang.String decfloatTraps) Description copied from interface:DatabaseConnectionPropertiesSets theDECFLOATerror traps.- Specified by:
- setDecfloatTrapsin interface- DatabaseConnectionProperties
- Parameters:
- decfloatTraps- Firebird 4+ server-side- DECFLOATerror traps; comma-separated list with options- Division_by_zero, Inexact, Invalid_operation, Overflow, Underflow;- nullto apply Firebird server default (- Division_by_zero,Invalid_operation,Overflowin Firebird 4)
 
 - 
getTpbMappingpublic java.lang.String getTpbMapping() Description copied from interface:DatabaseConnectionPropertiesGet the used TPB mapping.- Specified by:
- getTpbMappingin interface- DatabaseConnectionProperties
- Returns:
- path to the TPB mapping
- See Also:
- DatabaseConnectionProperties.setTpbMapping(String)
 
 - 
setTpbMappingpublic void setTpbMapping(java.lang.String tpbMapping) Description copied from interface:DatabaseConnectionPropertiesSet 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 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- DatabaseConnectionProperties
- Parameters:
- tpbMapping- path to the properties file
 
 - 
getDefaultTransactionIsolationpublic int getDefaultTransactionIsolation() Description copied from interface:DatabaseConnectionPropertiesGet the default transaction isolation level. This is the transaction isolation level for the newly created connections.- Specified by:
- getDefaultTransactionIsolationin interface- DatabaseConnectionProperties
- Returns:
- default transaction isolation level.
 
 - 
setDefaultTransactionIsolationpublic void setDefaultTransactionIsolation(int defaultIsolationLevel) Description copied from interface:DatabaseConnectionPropertiesSet the default transaction isolation level.- Specified by:
- setDefaultTransactionIsolationin interface- DatabaseConnectionProperties
- Parameters:
- defaultIsolationLevel- default transaction isolation level.
 
 - 
getDefaultIsolationpublic java.lang.String getDefaultIsolation() Description copied from interface:DatabaseConnectionPropertiesGet the default transaction isolation level as string. This method is complementary toDatabaseConnectionProperties.getDefaultTransactionIsolation(), however it returns a string name instead of a numeric constant.- Specified by:
- getDefaultIsolationin interface- DatabaseConnectionProperties
- Returns:
- default transaction isolation as string.
- See Also:
- DatabaseConnectionProperties.setDefaultIsolation(String)
 
 - 
setDefaultIsolationpublic void setDefaultIsolation(java.lang.String isolation) Description copied from interface:DatabaseConnectionPropertiesSet the default transaction isolation level as string. This method is complementary toDatabaseConnectionProperties.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.
- Integer string values matching the isolation levels
 - Specified by:
- setDefaultIsolationin interface- DatabaseConnectionProperties
- Parameters:
- isolation- string constant representing a default isolation level.
 
 - 
getScrollableCursorpublic java.lang.String getScrollableCursor() - Specified by:
- getScrollableCursorin interface- DatabaseConnectionProperties
- Returns:
- Configuration of scrollable cursors, either EMULATED(default) orSERVER(case-insensitive)
- See Also:
- DatabaseConnectionProperties.setScrollableCursor(String)
 
 - 
setScrollableCursorpublic void setScrollableCursor(java.lang.String scrollableCursor) Description copied from interface:DatabaseConnectionPropertiesSets the type of scrollable cursor.Possible values are (case-insensitive): - EMULATED(default) - emulate scrollable cursors in memory by fetching all rows
- SERVER- user server-side scrollable cursor (requires Firebird 5.0 and pure-java connection). Falls back to- EMULATEDbehaviour when server-side support is not available, or when holdable cursors are requested
 - Specified by:
- setScrollableCursorin interface- DatabaseConnectionProperties
- Parameters:
- scrollableCursor- Scrollable cursor type, one of- EMULATEDor- SERVER(case-insensitive)
 
 - 
isUseServerBatchpublic boolean isUseServerBatch() - Specified by:
- isUseServerBatchin interface- DatabaseConnectionProperties
- Returns:
- true(default) use server-side batch if supported by server,- falsealways use emulated batch
- See Also:
- DatabaseConnectionProperties.setUseServerBatch(boolean)
 
 - 
setUseServerBatchpublic void setUseServerBatch(boolean useServerBatch) Description copied from interface:DatabaseConnectionPropertiesSets whether to use server-side batch support, if available.Currently, server-side batch is only supported with Firebird 4.0 or higher, with a pure Java connection, using a PreparedStatement, but not aCallableStatement, and only when not requesting generated keys.The implementation will fall back to emulated batches if either the server version doesn't support batches, or if the statement cannot be executed using the server-side batch mechanism for other reasons (e.g. requesting generated keys). - Specified by:
- setUseServerBatchin interface- DatabaseConnectionProperties
- Parameters:
- useServerBatch-- true, use server-side batch support if possible,- falsealways use emulated batch
 
 - 
getServerBatchBufferSizepublic int getServerBatchBufferSize() - Specified by:
- getServerBatchBufferSizein interface- DatabaseConnectionProperties
- Returns:
- batch buffer size in bytes, < 0to use server-side default (16MB as of Firebird 4.0),0(default) to use server-side maximum (256MB as of Firebird 4.0), values exceeding server-side maximum will set server-side maximum
- See Also:
- DatabaseConnectionProperties.setServerBatchBufferSize(int)
 
 - 
setServerBatchBufferSizepublic void setServerBatchBufferSize(int serverBatchBufferSize) Description copied from interface:DatabaseConnectionPropertiesSets the server batch buffer size (if server batch is supported and enabled).- Specified by:
- setServerBatchBufferSizein interface- DatabaseConnectionProperties
- Parameters:
- serverBatchBufferSize- server batch buffer size in bytes, use- < 0to set server-side default (16MB as of Firebird 4.0), use- 0to use server-side maximum (256MB as of Firebird 4.0), values exceeding server-side maximum will set server-side maximum
 
 - 
getParallelWorkerspublic int getParallelWorkers() - Specified by:
- getParallelWorkersin interface- AttachmentProperties
- Returns:
- number of parallel workers, -1means no value was set (or it was explicitly set to-1)
 
 - 
setParallelWorkerspublic void setParallelWorkers(int parallelWorkers) Description copied from interface:AttachmentPropertiesSets the number of parallel workers of the connection.Requires Firebird 5.0 or higher, and a Firebird server configured with MaxParallelWorkershigher than specified byparallelWorkers.NOTE: For service attachments, this property controls behaviour only for specific operations, and requires Jaybird to explicitly set the parallel workers for that operation. - Specified by:
- setParallelWorkersin interface- AttachmentProperties
- Parameters:
- parallelWorkers- number of parallel workers
 
 - 
isExtendedMetadatapublic boolean isExtendedMetadata() - Specified by:
- isExtendedMetadatain interface- DatabaseConnectionProperties
- Returns:
- true(default) if metadata (e.g.- ResultSetMetaData) will perform additional queries for more detailed information,- falseif only the available bind information will be used
- See Also:
- DatabaseConnectionProperties.setExtendedMetadata(boolean)
 
 - 
setExtendedMetadatapublic void setExtendedMetadata(boolean extendedMetadata) Description copied from interface:DatabaseConnectionPropertiesSets if certain metadata classes will perform additional queries to enrich the information for certain types.Currently this is used only by ResultSetMetaDatafor itsgetPrecisionandisAutoIncrementmethods. If disabled, these methods will return an estimated precision, orfalsefor auto-increment instead of actual precision and identity column state information.Disabling this setting may improve performance of querying metadata information, in exchange for less precise information. - Specified by:
- setExtendedMetadatain interface- DatabaseConnectionProperties
- Parameters:
- extendedMetadata-- true(default) - metadata (e.g.- ResultSetMetaData) will perform additional queries for more detailed information,- false- only the available bind information will be used
 
 - 
isTimestampUsesLocalTimezone@Deprecated public boolean isTimestampUsesLocalTimezone() Deprecated.- Specified by:
- isTimestampUsesLocalTimezonein interface- DatabaseConnectionProperties
- Returns:
- trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
 
 - 
getMaxInlineBlobSizepublic int getMaxInlineBlobSize() - Specified by:
- getMaxInlineBlobSizein interface- DatabaseConnectionProperties
- Returns:
- the maximum inline blob size (native connections will use their own default if it was not explicitly set)
- See Also:
- DatabaseConnectionProperties.setMaxInlineBlobSize(int)
 
 - 
setMaxInlineBlobSizepublic void setMaxInlineBlobSize(int maxInlineBlobSize) Description copied from interface:DatabaseConnectionPropertiesSets the maximum inline blob size. This controls the maximum size of a blob (including segment lengths) that Firebird will send inline on fetch or execute.This only applies to Firebird 5.0.3 or higher. Default value is 64 KiB. Native connections will use their own default if it was not explicitly set. The default value can be overridden by setting system property org.firebirdsql.jdbc.defaultMaxInlineBlobSize.- Specified by:
- setMaxInlineBlobSizein interface- DatabaseConnectionProperties
- Parameters:
- maxInlineBlobSize- maximum inline blob size, a value of- 0will disable sending inline blobs, values greater than 65535 will be effectively ignored (this is not enforced, so if Firebird introduces support for larger values, it will work); negative values will set- 0.
 
 - 
getMaxBlobCacheSizepublic int getMaxBlobCacheSize() - Specified by:
- getMaxBlobCacheSizein interface- DatabaseConnectionProperties
- Returns:
- the maximum blob cache size in bytes (native connections will use their own default if it was not explicitly set)
- See Also:
- DatabaseConnectionProperties.setMaxBlobCacheSize(int)
 
 - 
setMaxBlobCacheSizepublic void setMaxBlobCacheSize(int maxBlobCacheSize) Description copied from interface:DatabaseConnectionPropertiesSets the maximum inline blob cache size. This controls the size of the cache to store inline blobs. Only the actual blob length counts towards the cache size.This only applies to Firebird 5.0.3 or higher. Default value is 10 MiB. Native connections will use their own default if it was not explicitly set. The default value can be overridden by setting system property org.firebirdsql.jdbc.defaultMaxBlobCacheSize.Disabling the cache by setting it to 0will not disable inline blobs; make sure you also setDatabaseConnectionProperties.setMaxInlineBlobSize(int)to0to avoid unnecessary data transfer.- Specified by:
- setMaxBlobCacheSizein interface- DatabaseConnectionProperties
- Parameters:
- maxBlobCacheSize- the maximum blob cache size in bytes, a value of- 0will disable the cache; negative values will set- 0
 
 - 
setTimestampUsesLocalTimezone@Deprecated public void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone) Deprecated.Description copied from interface:DatabaseConnectionPropertiesSets the valuetimestampUsesLocalTimezone.- Specified by:
- setTimestampUsesLocalTimezonein interface- DatabaseConnectionProperties
- Parameters:
- timestampUsesLocalTimezone-- trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
 
 - 
getUserName@Deprecated public java.lang.String getUserName() Deprecated.- Specified by:
- getUserNamein interface- FirebirdConnectionProperties
- Returns:
- name of the user that will be used when connecting to the database.
 
 - 
setUserName@Deprecated public void setUserName(java.lang.String userName) Deprecated.- Specified by:
- setUserNamein interface- FirebirdConnectionProperties
- Parameters:
- userName- name of the user that will be used when connecting to the database.
 
 - 
getBuffersNumber@Deprecated public int getBuffersNumber() Deprecated.- 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.
 
 - 
setBuffersNumber@Deprecated public void setBuffersNumber(int buffersNumber) Deprecated.- 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.
 
 
- 
 
-