Class FBSimpleDataSource
- java.lang.Object
- 
- org.firebirdsql.ds.RootCommonDataSource
- 
- org.firebirdsql.ds.FBSimpleDataSource
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable,- java.sql.Wrapper,- javax.naming.Referenceable,- javax.resource.Referenceable,- javax.sql.CommonDataSource,- javax.sql.DataSource,- FirebirdConnectionProperties
 
 public class FBSimpleDataSource extends RootCommonDataSource implements javax.sql.DataSource, java.io.Serializable, javax.resource.Referenceable, FirebirdConnectionProperties This is a simple implementation ofDataSourceinterface. Connections are physically opened inDataSource.getConnection()method and physically closed inConnection.close()method.- Version:
- 1.0
- Author:
- Roman Rokytskyy, David Jencks
- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected java.lang.Stringdescriptionprotected FBDataSourcedsprotected javax.naming.ReferencejndiReferenceprotected FBManagedConnectionFactorymcf
 - 
Constructor SummaryConstructors Constructor Description FBSimpleDataSource()Create instance of this class.FBSimpleDataSource(GDSType type)Create instance of this class.
 - 
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.java.lang.IntegergetBlobBufferLength()Get buffer length for the BLOB fields.intgetBlobBufferSize()intgetBuffersNumber()java.lang.StringgetCharSet()java.sql.ConnectiongetConnection()Get JDBC connection with default credentials.java.sql.ConnectiongetConnection(java.lang.String username, java.lang.String password)Get JDBC connection with the specified credentials.intgetConnectTimeout()Get the current connect timeout.java.lang.StringgetDatabase()Get name of the database.java.lang.StringgetDatabaseName()Deprecated.usegetDatabase()instead for the sake of naming compatibility.DatabaseParameterBuffergetDatabaseParameterBuffer()Get the database parameter buffer corresponding to the current connection request information.protected javax.sql.DataSourcegetDataSource()Get underlying connection factory (in our case instance ofFBDataSourceclass) that will provide JDBC connections.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.StringgetDescription()Get description of this datasource.java.lang.StringgetEncoding()Get encoding for connections produced by this data source.java.lang.StringgetGeneratedKeysEnabled()Get thegeneratedKeysEnabledconfiguration.intgetLoginTimeout()java.lang.StringgetNonStandardProperty(java.lang.String key)Get the property that does not have corresponding getter method by its name.java.lang.StringgetPassword()Get password used ingetConnection()method.javax.naming.ReferencegetReference()Get previously set JNDI reference.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.StringgetUser()Deprecated.usegetUserName()instead for the sake of naming compatibility.java.lang.StringgetUserName()Get user name that is used ingetConnection()method.java.lang.StringgetWireCrypt()Get the wire encryption level value.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.booleanisWrapperFor(java.lang.Class<?> iface)voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.voidsetBlobBufferLength(java.lang.Integer length)Set BLOB buffer length.voidsetBlobBufferSize(int bufferSize)voidsetBuffersNumber(int buffersNumber)voidsetCharSet(java.lang.String charSet)voidsetConnectTimeout(int connectTimeout)Set the connect timeout.voidsetDatabase(java.lang.String name)Set database name.voidsetDatabaseName(java.lang.String name)Deprecated.usesetDatabase(String)instead for the sake of naming compatibility.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.voidsetDescription(java.lang.String description)Set description of this datasource.voidsetEncoding(java.lang.String encoding)Set encoding for connections produced by this data source.voidsetGeneratedKeysEnabled(java.lang.String generatedKeysEnabled)Sets thegeneratedKeysEnabledconfiguration.voidsetIgnoreProcedureType(boolean ignoreProcedureType)Sets the valueignoreProcedureType.voidsetLoginTimeout(int loginTimeout)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)Set password that will be used in thegetConnection()method.voidsetReference(javax.naming.Reference reference)Set JNDI reference for this data source.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).voidsetUser(java.lang.String user)Deprecated.usesetUserName(String)instead for the sake of naming compatibility.voidsetUserName(java.lang.String userName)Set user name that will be used ingetConnection()method.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.<T> Tunwrap(java.lang.Class<T> iface)- 
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
 
- 
 
- 
- 
- 
Field Detail- 
mcfprotected FBManagedConnectionFactory mcf 
 - 
dsprotected transient FBDataSource ds 
 - 
jndiReferenceprotected javax.naming.Reference jndiReference 
 - 
descriptionprotected java.lang.String description 
 
- 
 - 
Constructor Detail- 
FBSimpleDataSourcepublic FBSimpleDataSource() Create instance of this class.
 - 
FBSimpleDataSourcepublic FBSimpleDataSource(GDSType type) Create instance of this class.
 
- 
 - 
Method Detail- 
getBlobBufferLengthpublic java.lang.Integer getBlobBufferLength() Get buffer length for the BLOB fields.- Returns:
- length of BLOB buffer.
 
 - 
setBlobBufferLengthpublic void setBlobBufferLength(java.lang.Integer length) Set BLOB buffer length. This value influences the performance when working with BLOB fields.- Parameters:
- length- new length of the BLOB buffer.
 
 - 
getDatabaseName@Deprecated public java.lang.String getDatabaseName() Deprecated.usegetDatabase()instead for the sake of naming compatibility.Get name of the database.- Returns:
- database name, value is equal to the part of full JDBC URL without
 the jdbc:firebirdsql:part.
 
 - 
setDatabaseName@Deprecated public void setDatabaseName(java.lang.String name) Deprecated.usesetDatabase(String)instead for the sake of naming compatibility.Set database name.- Parameters:
- name- connection URL without- "jdbc:firebirdsql:"prefix (- "//localhost:3050/c:/database/employee.fdb") for example).
 
 - 
getDatabasepublic java.lang.String getDatabase() Get name of the database.- Specified by:
- getDatabasein interface- FirebirdConnectionProperties
- Returns:
- database name, value is equal to the part of full JDBC URL without
 the jdbc:firebirdsql:part.
 
 - 
setDatabasepublic void setDatabase(java.lang.String name) Set database name.- Specified by:
- setDatabasein interface- FirebirdConnectionProperties
- Parameters:
- name- connection URL without- "jdbc:firebirdsql:"prefix (- "//localhost:3050/c:/database/employee.fdb") for example).
 
 - 
getUser@Deprecated public java.lang.String getUser() Deprecated.usegetUserName()instead for the sake of naming compatibility.Get user name that is used ingetConnection()method.- Returns:
- default user name.
 
 - 
setUser@Deprecated public void setUser(java.lang.String user) Deprecated.usesetUserName(String)instead for the sake of naming compatibility.Set user name that will be used ingetConnection()method.- Parameters:
- user- default user name.
 
 - 
getUserNamepublic java.lang.String getUserName() Get user name that is used ingetConnection()method.- Specified by:
- getUserNamein interface- FirebirdConnectionProperties
- Returns:
- default user name.
 
 - 
setUserNamepublic void setUserName(java.lang.String userName) Set user name that will be used ingetConnection()method.- Specified by:
- setUserNamein interface- FirebirdConnectionProperties
- Parameters:
- userName- default user name.
 
 - 
getPasswordpublic java.lang.String getPassword() Get password used ingetConnection()method.- Specified by:
- getPasswordin interface- FirebirdConnectionProperties
- Returns:
- password corresponding to the user name returned by 
 getUserName().
 
 - 
setPasswordpublic void setPassword(java.lang.String password) Set password that will be used in thegetConnection()method.- Specified by:
- setPasswordin interface- FirebirdConnectionProperties
- Parameters:
- password- password corresponding to the user name set in- setUserName(String).
 
 - 
getEncodingpublic java.lang.String getEncoding() Get encoding for connections produced by this data source.- Specified by:
- getEncodingin interface- FirebirdConnectionProperties
- Returns:
- encoding for the connection.
- See Also:
- FirebirdConnectionProperties.setEncoding(String)
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) Set encoding for connections produced by this data source.- Specified by:
- setEncodingin interface- FirebirdConnectionProperties
- Parameters:
- encoding- encoding for the connection.
 
 - 
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.
 
 - 
getBlobBufferSizepublic int getBlobBufferSize() - Specified by:
- getBlobBufferSizein interface- FirebirdConnectionProperties
- Returns:
- BLOB buffer size in bytes.
 
 - 
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.
 
 - 
getCharSetpublic java.lang.String getCharSet() - Specified by:
- getCharSetin interface- FirebirdConnectionProperties
- Returns:
- Character set for the connection.
- See Also:
- FirebirdConnectionProperties.setCharSet(String)
 
 - 
getDatabaseParameterBufferpublic DatabaseParameterBuffer getDatabaseParameterBuffer() throws java.sql.SQLException 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.
 
 - 
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)
 
 - 
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.
 
 - 
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.
 
 - 
getRoleNamepublic java.lang.String getRoleName() - Specified by:
- getRoleNamein interface- FirebirdConnectionProperties
- Returns:
- SQL role to use.
 
 - 
getSocketBufferSizepublic int getSocketBufferSize() - Specified by:
- getSocketBufferSizein interface- FirebirdConnectionProperties
- Returns:
- socket buffer size in bytes, or -1 is not specified.
 
 - 
getSqlDialectpublic java.lang.String getSqlDialect() - Specified by:
- getSqlDialectin interface- FirebirdConnectionProperties
- Returns:
- SQL dialect of the client.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
isUseStandardUdfpublic boolean isUseStandardUdf() - Specified by:
- isUseStandardUdfin interface- FirebirdConnectionProperties
- Returns:
- trueif driver should assume that standard UDF are installed.
 
 - 
isUseStreamBlobspublic boolean isUseStreamBlobs() - Specified by:
- isUseStreamBlobsin interface- FirebirdConnectionProperties
- Returns:
- trueif stream blobs should be created, otherwise- false.
 
 - 
setBlobBufferSizepublic void setBlobBufferSize(int bufferSize) - Specified by:
- setBlobBufferSizein interface- FirebirdConnectionProperties
- Parameters:
- bufferSize- size of the BLOB buffer in bytes.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
setRoleNamepublic void setRoleName(java.lang.String roleName) - Specified by:
- setRoleNamein interface- FirebirdConnectionProperties
- Parameters:
- roleName- SQL role to use.
 
 - 
setSocketBufferSizepublic void setSocketBufferSize(int socketBufferSize) - Specified by:
- setSocketBufferSizein interface- FirebirdConnectionProperties
- Parameters:
- socketBufferSize- socket buffer size in bytes.
 
 - 
setSqlDialectpublic void setSqlDialect(java.lang.String sqlDialect) - Specified by:
- setSqlDialectin interface- FirebirdConnectionProperties
- Parameters:
- sqlDialect- SQL dialect of the client.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
setUseStandardUdfpublic void setUseStandardUdf(boolean useStandardUdf) - Specified by:
- setUseStandardUdfin interface- FirebirdConnectionProperties
- Parameters:
- useStandardUdf-- trueif driver should assume that standard UDF are installed.
 
 - 
setUseStreamBlobspublic void setUseStreamBlobs(boolean useStreamBlobs) - Specified by:
- setUseStreamBlobsin interface- FirebirdConnectionProperties
- Parameters:
- useStreamBlobs-- trueif stream blobs should be created, otherwise- false.
 
 - 
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()
 
 - 
getReferencepublic javax.naming.Reference getReference() throws javax.naming.NamingExceptionGet previously set JNDI reference.- Specified by:
- getReferencein interface- javax.naming.Referenceable
- Returns:
- instance of Referenceset previously.
- Throws:
- javax.naming.NamingException- if something went wrong.
 
 - 
setReferencepublic void setReference(javax.naming.Reference reference) Set JNDI reference for this data source.- Specified by:
- setReferencein interface- javax.resource.Referenceable
- Parameters:
- reference- reference to set.
 
 - 
getConnectionpublic java.sql.Connection getConnection() throws java.sql.SQLExceptionGet JDBC connection with default credentials.- Specified by:
- getConnectionin interface- javax.sql.DataSource
- Returns:
- new JDBC connection.
- Throws:
- java.sql.SQLException- if something went wrong.
 
 - 
getConnectionpublic java.sql.Connection getConnection(java.lang.String username, java.lang.String password) throws java.sql.SQLExceptionGet JDBC connection with the specified credentials.- Specified by:
- getConnectionin interface- javax.sql.DataSource
- Parameters:
- username- user name for the connection.
- password- password for the connection.
- Returns:
- new JDBC connection.
- Throws:
- java.sql.SQLException- if something went wrong.
 
 - 
getLoginTimeoutpublic int getLoginTimeout() throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property. - Specified by:
- getLoginTimeoutin interface- javax.sql.CommonDataSource
- Specified by:
- getLoginTimeoutin interface- javax.sql.DataSource
- Throws:
- java.sql.SQLException
 
 - 
setLoginTimeoutpublic void setLoginTimeout(int loginTimeout) throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property. - Specified by:
- setLoginTimeoutin interface- javax.sql.CommonDataSource
- Specified by:
- setLoginTimeoutin interface- javax.sql.DataSource
- Throws:
- java.sql.SQLException
 
 - 
getDescriptionpublic java.lang.String getDescription() Get description of this datasource.- Returns:
- description of this datasource.
 
 - 
setDescriptionpublic void setDescription(java.lang.String description) Set description of this datasource.- Parameters:
- description- description of this datasource.
 
 - 
getDataSourceprotected javax.sql.DataSource getDataSource() throws java.sql.SQLExceptionGet underlying connection factory (in our case instance ofFBDataSourceclass) that will provide JDBC connections.- Returns:
- JDBC connection factory.
- Throws:
- java.sql.SQLException- if something went wrong.
 
 - 
isWrapperForpublic boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException- Specified by:
- isWrapperForin interface- java.sql.Wrapper
- Throws:
- java.sql.SQLException
 
 - 
unwrappublic <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException- Specified by:
- unwrapin interface- java.sql.Wrapper
- Throws:
- java.sql.SQLException
 
 
- 
 
-