Class FBAbstractCommonDataSource
- java.lang.Object
- 
- org.firebirdsql.ds.RootCommonDataSource
- 
- org.firebirdsql.ds.FBAbstractCommonDataSource
 
 
- 
- All Implemented Interfaces:
- javax.sql.CommonDataSource,- FirebirdConnectionProperties
 - Direct Known Subclasses:
- FBConnectionPoolDataSource,- FBXADataSource
 
 public abstract class FBAbstractCommonDataSource extends RootCommonDataSource implements FirebirdConnectionProperties Abstract class for properties and behaviour common to DataSources, XADataSources and ConnectionPoolDataSources- Since:
- 2.2
- Author:
- Mark Rotteveel
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected java.lang.Objectlockprotected static java.lang.StringREF_DATABASE_NAMEprotected static java.lang.StringREF_DESCRIPTIONprotected static java.lang.StringREF_PORT_NUMBERprotected static java.lang.StringREF_PROPERTIESprotected static java.lang.StringREF_SERVER_NAME
 - 
Constructor SummaryConstructors Constructor Description FBAbstractCommonDataSource()
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected abstract voidcheckNotStarted()Method to check if this DataSource has not yet started.java.lang.StringgetAuthPlugins()Get the list of authentication plugins to try.intgetBlobBufferSize()intgetBuffersNumber()java.lang.StringgetCharSet()protected FBConnectionPropertiesgetConnectionProperties()intgetConnectTimeout()Get the current connect timeout.java.lang.StringgetDatabase()Deprecated.java.lang.StringgetDatabaseName()DatabaseParameterBuffergetDatabaseParameterBuffer()Get the database parameter buffer corresponding to the current connection request information.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()java.lang.StringgetEncoding()java.lang.StringgetGeneratedKeysEnabled()Get thegeneratedKeysEnabledconfiguration.intgetLoginTimeout()java.lang.StringgetNonStandardProperty(java.lang.String key)Method to get the value of properties which are not exposed through JavaBeans-style setters.java.lang.StringgetPassword()intgetPortNumber()java.lang.StringgetRoleName()java.lang.StringgetServerName()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()java.lang.StringgetUserName()Deprecated.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.voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.voidsetBlobBufferSize(int bufferSize)voidsetBuffersNumber(int buffersNumber)voidsetCharSet(java.lang.String charSet)protected voidsetConnectionProperties(FBConnectionProperties connectionProperties)voidsetConnectTimeout(int connectTimeout)Set the connect timeout.protected voidsetDatabase()Sets the database property of connectionProperties.voidsetDatabase(java.lang.String database)Deprecated.voidsetDatabaseName(java.lang.String databaseName)Sets the databaseName of this datasource.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)voidsetEncoding(java.lang.String encoding)voidsetGeneratedKeysEnabled(java.lang.String generatedKeysEnabled)Sets thegeneratedKeysEnabledconfiguration.voidsetIgnoreProcedureType(boolean ignoreProcedureType)Sets the valueignoreProcedureType.voidsetLoginTimeout(int seconds)voidsetNonStandardProperty(java.lang.String propertyMapping)Method that allows setting non-standard property in the form "key=value" form.voidsetNonStandardProperty(java.lang.String key, java.lang.String value)Method to set properties which are not exposed through JavaBeans-style setters.voidsetPassword(java.lang.String password)voidsetPortNumber(int portNumber)voidsetRoleName(java.lang.String roleName)voidsetServerName(java.lang.String serverName)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)voidsetUserName(java.lang.String userName)Deprecated.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.protected static voidupdateReference(javax.naming.Reference ref, FBAbstractCommonDataSource instance)Updates the supplied reference with RefAddr properties relevant to this class.- 
Methods inherited from class org.firebirdsql.ds.RootCommonDataSourcegetLogWriter, getParentLogger, setLogWriter
 
- 
 
- 
- 
- 
Field Detail- 
REF_DATABASE_NAMEprotected static final java.lang.String REF_DATABASE_NAME - See Also:
- Constant Field Values
 
 - 
REF_PORT_NUMBERprotected static final java.lang.String REF_PORT_NUMBER - See Also:
- Constant Field Values
 
 - 
REF_SERVER_NAMEprotected static final java.lang.String REF_SERVER_NAME - See Also:
- Constant Field Values
 
 - 
REF_DESCRIPTIONprotected static final java.lang.String REF_DESCRIPTION - See Also:
- Constant Field Values
 
 - 
REF_PROPERTIESprotected static final java.lang.String REF_PROPERTIES - See Also:
- Constant Field Values
 
 - 
lockprotected final java.lang.Object lock 
 
- 
 - 
Method Detail- 
checkNotStartedprotected abstract void checkNotStarted() throws java.lang.IllegalStateExceptionMethod to check if this DataSource has not yet started.Implementations should throw IllegalStateException when the DataSource is already in use and modifying properties is not allowed. - Throws:
- java.lang.IllegalStateException- When the DataSource is already in use
 
 - 
getDescriptionpublic java.lang.String getDescription() 
 - 
setDescriptionpublic void setDescription(java.lang.String description) 
 - 
getServerNamepublic final java.lang.String getServerName() 
 - 
setServerNamepublic final void setServerName(java.lang.String serverName) 
 - 
getPortNumberpublic final int getPortNumber() 
 - 
setPortNumberpublic final void setPortNumber(int portNumber) 
 - 
getDatabaseNamepublic final java.lang.String getDatabaseName() 
 - 
setDatabaseNamepublic final void setDatabaseName(java.lang.String databaseName) Sets the databaseName of this datasource.The databaseName is the filepath or alias of the database only, so it should not include serverName and portNumber. - Parameters:
- databaseName- Database name (filepath or alias)
 
 - 
getTypepublic final 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 final 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.
 
 - 
getUserpublic java.lang.String getUser() 
 - 
setUserpublic void setUser(java.lang.String user) 
 - 
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.
 
 - 
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.
 
 - 
getCharSetpublic final java.lang.String getCharSet() - Specified by:
- getCharSetin interface- FirebirdConnectionProperties
- Returns:
- Character set for the connection.
- See Also:
- FirebirdConnectionProperties.setCharSet(String)
 
 - 
setCharSetpublic final 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 final java.lang.String getEncoding() - Specified by:
- getEncodingin interface- FirebirdConnectionProperties
- Returns:
- Character encoding for the connection.
- See Also:
- FirebirdConnectionProperties.setEncoding(String)
 
 - 
setEncodingpublic final void setEncoding(java.lang.String encoding) - Specified by:
- setEncodingin interface- FirebirdConnectionProperties
- Parameters:
- encoding- Firebird name of the character encoding for the connection. See Firebird documentation for more information.
 
 - 
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
 
 - 
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)
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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.
 
 - 
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')
 
 - 
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 final void setNonStandardProperty(java.lang.String propertyMapping) Method that allows setting non-standard property in the form "key=value" form. This method is needed by some containers to specify properties in the configuration.- Specified by:
- setNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- propertyMapping- mapping between property name (key) and its value. Name and value are separated with "=", ":" or whitespace character. Whitespace characters on the beginning of the string and between key and value are ignored. No escaping is possible: "\n" is backslash-en, not a new line mark.
- See Also:
- setNonStandardProperty(String, String)
 
 - 
setNonStandardPropertypublic final void setNonStandardProperty(java.lang.String key, java.lang.String value)Method to set properties which are not exposed through JavaBeans-style setters.- Specified by:
- setNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- key- Name of the property (see Jaybird releasenotes)
- value- Value of the property
- See Also:
- setNonStandardProperty(String)
 
 - 
getNonStandardPropertypublic final java.lang.String getNonStandardProperty(java.lang.String key) Method to get the value of properties which are not exposed through JavaBeans-style setters.- Specified by:
- getNonStandardPropertyin interface- FirebirdConnectionProperties
- Parameters:
- key- Name of the property (see Jaybird releasenotes)
- Returns:
- Value of the property
- See Also:
- setNonStandardProperty(String),- setNonStandardProperty(String, String)
 
 - 
setDatabaseprotected final void setDatabase() Sets the database property of connectionProperties.
 - 
setConnectionPropertiesprotected final void setConnectionProperties(FBConnectionProperties connectionProperties) 
 - 
getConnectionPropertiesprotected final FBConnectionProperties getConnectionProperties() 
 - 
updateReferenceprotected static void updateReference(javax.naming.Reference ref, FBAbstractCommonDataSource instance)Updates the supplied reference with RefAddr properties relevant to this class.- Parameters:
- ref- Reference to update
- instance- Instance of this class to obtain values
 
 
- 
 
-