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 Summary
Fields 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 Summary
Constructors Constructor Description FBAbstractCommonDataSource()
-
Method Summary
All 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.RootCommonDataSource
getLogWriter, getParentLogger, setLogWriter
-
-
-
-
Field Detail
-
REF_DATABASE_NAME
protected static final java.lang.String REF_DATABASE_NAME
- See Also:
- Constant Field Values
-
REF_PORT_NUMBER
protected static final java.lang.String REF_PORT_NUMBER
- See Also:
- Constant Field Values
-
REF_SERVER_NAME
protected static final java.lang.String REF_SERVER_NAME
- See Also:
- Constant Field Values
-
REF_DESCRIPTION
protected static final java.lang.String REF_DESCRIPTION
- See Also:
- Constant Field Values
-
REF_PROPERTIES
protected static final java.lang.String REF_PROPERTIES
- See Also:
- Constant Field Values
-
lock
protected final java.lang.Object lock
-
-
Method Detail
-
checkNotStarted
protected 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
-
getDescription
public java.lang.String getDescription()
-
setDescription
public void setDescription(java.lang.String description)
-
getServerName
public final java.lang.String getServerName()
-
setServerName
public final void setServerName(java.lang.String serverName)
-
getPortNumber
public final int getPortNumber()
-
setPortNumber
public final void setPortNumber(int portNumber)
-
getDatabaseName
public final java.lang.String getDatabaseName()
-
setDatabaseName
public 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)
-
getType
public final java.lang.String getType()
- Specified by:
getTypein interfaceFirebirdConnectionProperties- Returns:
- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
-
setType
public final void setType(java.lang.String type)
- Specified by:
setTypein interfaceFirebirdConnectionProperties- Parameters:
type- type of the connection, for example, "PURE_JAVA", "LOCAL", "EMBEDDED", depends on the GDS implementations installed in the system.
-
getUser
public java.lang.String getUser()
-
setUser
public void setUser(java.lang.String user)
-
getPassword
public java.lang.String getPassword()
- Specified by:
getPasswordin interfaceFirebirdConnectionProperties- Returns:
- password corresponding to the specified user name.
-
setPassword
public void setPassword(java.lang.String password)
- Specified by:
setPasswordin interfaceFirebirdConnectionProperties- Parameters:
password- password corresponding to the specified user name.
-
getRoleName
public java.lang.String getRoleName()
- Specified by:
getRoleNamein interfaceFirebirdConnectionProperties- Returns:
- SQL role to use.
-
setRoleName
public void setRoleName(java.lang.String roleName)
- Specified by:
setRoleNamein interfaceFirebirdConnectionProperties- Parameters:
roleName- SQL role to use.
-
getCharSet
public final java.lang.String getCharSet()
- Specified by:
getCharSetin interfaceFirebirdConnectionProperties- Returns:
- Character set for the connection.
- See Also:
FirebirdConnectionProperties.setCharSet(String)
-
setCharSet
public final void setCharSet(java.lang.String charSet)
- Specified by:
setCharSetin interfaceFirebirdConnectionProperties- Parameters:
charSet- Character set for the connection. Similar toencodingproperty, but accepts Java names instead of Firebird ones.
-
getEncoding
public final java.lang.String getEncoding()
- Specified by:
getEncodingin interfaceFirebirdConnectionProperties- Returns:
- Character encoding for the connection.
- See Also:
FirebirdConnectionProperties.setEncoding(String)
-
setEncoding
public final void setEncoding(java.lang.String encoding)
- Specified by:
setEncodingin interfaceFirebirdConnectionProperties- Parameters:
encoding- Firebird name of the character encoding for the connection. See Firebird documentation for more information.
-
getLoginTimeout
public int getLoginTimeout() throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property.
- Specified by:
getLoginTimeoutin interfacejavax.sql.CommonDataSource- Throws:
java.sql.SQLException
-
setLoginTimeout
public void setLoginTimeout(int seconds) throws java.sql.SQLExceptionThis property is an alias for the connectTimeout property.
- Specified by:
setLoginTimeoutin interfacejavax.sql.CommonDataSource- Throws:
java.sql.SQLException
-
getConnectTimeout
public int getConnectTimeout()
Description copied from interface:FirebirdConnectionPropertiesGet the current connect timeout.- Specified by:
getConnectTimeoutin interfaceFirebirdConnectionProperties- Returns:
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
-
setConnectTimeout
public void setConnectTimeout(int connectTimeout)
Description copied from interface:FirebirdConnectionPropertiesSet the connect timeout.- Specified by:
setConnectTimeoutin interfaceFirebirdConnectionProperties- Parameters:
connectTimeout- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
-
getDatabase
@Deprecated public java.lang.String getDatabase()
Deprecated.- Specified by:
getDatabasein interfaceFirebirdConnectionProperties- 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 interfaceFirebirdConnectionProperties- Parameters:
database- path to the database including the server name and the port, if needed.
-
getBlobBufferSize
public int getBlobBufferSize()
- Specified by:
getBlobBufferSizein interfaceFirebirdConnectionProperties- Returns:
- BLOB buffer size in bytes.
-
setBlobBufferSize
public void setBlobBufferSize(int bufferSize)
- Specified by:
setBlobBufferSizein interfaceFirebirdConnectionProperties- Parameters:
bufferSize- size of the BLOB buffer in bytes.
-
getSqlDialect
public java.lang.String getSqlDialect()
- Specified by:
getSqlDialectin interfaceFirebirdConnectionProperties- Returns:
- SQL dialect of the client.
-
setSqlDialect
public void setSqlDialect(java.lang.String sqlDialect)
- Specified by:
setSqlDialectin interfaceFirebirdConnectionProperties- Parameters:
sqlDialect- SQL dialect of the client.
-
isUseStreamBlobs
public boolean isUseStreamBlobs()
- Specified by:
isUseStreamBlobsin interfaceFirebirdConnectionProperties- Returns:
trueif stream blobs should be created, otherwisefalse.
-
setUseStreamBlobs
public void setUseStreamBlobs(boolean useStreamBlobs)
- Specified by:
setUseStreamBlobsin interfaceFirebirdConnectionProperties- Parameters:
useStreamBlobs-trueif stream blobs should be created, otherwisefalse.
-
isUseStandardUdf
public boolean isUseStandardUdf()
- Specified by:
isUseStandardUdfin interfaceFirebirdConnectionProperties- Returns:
trueif driver should assume that standard UDF are installed.
-
setUseStandardUdf
public void setUseStandardUdf(boolean useStandardUdf)
- Specified by:
setUseStandardUdfin interfaceFirebirdConnectionProperties- Parameters:
useStandardUdf-trueif driver should assume that standard UDF are installed.
-
getSocketBufferSize
public int getSocketBufferSize()
- Specified by:
getSocketBufferSizein interfaceFirebirdConnectionProperties- Returns:
- socket buffer size in bytes, or -1 is not specified.
-
setSocketBufferSize
public void setSocketBufferSize(int socketBufferSize)
- Specified by:
setSocketBufferSizein interfaceFirebirdConnectionProperties- Parameters:
socketBufferSize- socket buffer size in bytes.
-
isTimestampUsesLocalTimezone
public boolean isTimestampUsesLocalTimezone()
- Specified by:
isTimestampUsesLocalTimezonein interfaceFirebirdConnectionProperties- Returns:
trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
-
setTimestampUsesLocalTimezone
public void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone)
- Specified by:
setTimestampUsesLocalTimezonein interfaceFirebirdConnectionProperties- Parameters:
timestampUsesLocalTimezone-trueif the Jaybird 1.0 handling of the calendar in corresponding setters. This is also compatible with MySQL calendar treatment.
-
getUserName
@Deprecated public java.lang.String getUserName()
Deprecated.- Specified by:
getUserNamein interfaceFirebirdConnectionProperties- 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 interfaceFirebirdConnectionProperties- Parameters:
userName- name of the user that will be used when connecting to the database.
-
getBuffersNumber
public int getBuffersNumber()
- Specified by:
getBuffersNumberin interfaceFirebirdConnectionProperties- Returns:
- number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances, SuperServer has a server-wide configuration parameter.
-
setBuffersNumber
public void setBuffersNumber(int buffersNumber)
- Specified by:
setBuffersNumberin interfaceFirebirdConnectionProperties- Parameters:
buffersNumber- number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances, SuperServer has a server-wide configuration parameter.
-
getDatabaseParameterBuffer
public 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 interfaceFirebirdConnectionProperties- Returns:
- instance of
DatabaseParameterBuffer. - Throws:
java.sql.SQLException- if database parameter buffer cannot be created.
-
getTpbMapping
public java.lang.String getTpbMapping()
Description copied from interface:FirebirdConnectionPropertiesGet the used TPB mapping.- Specified by:
getTpbMappingin interfaceFirebirdConnectionProperties- Returns:
- path to the TPB mapping.
- See Also:
FirebirdConnectionProperties.setTpbMapping(String)
-
setTpbMapping
public 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 interfaceFirebirdConnectionProperties- Parameters:
tpbMapping- path to the properties file.
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()
Description copied from interface:FirebirdConnectionPropertiesGet the default transaction isolation level. This is the transaction isolation level for the newly created connections.- Specified by:
getDefaultTransactionIsolationin interfaceFirebirdConnectionProperties- Returns:
- default transaction isolation level.
-
setDefaultTransactionIsolation
public void setDefaultTransactionIsolation(int defaultIsolationLevel)
Description copied from interface:FirebirdConnectionPropertiesSet the default transaction isolation level.- Specified by:
setDefaultTransactionIsolationin interfaceFirebirdConnectionProperties- Parameters:
defaultIsolationLevel- default transaction isolation level.
-
getDefaultIsolation
public 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 interfaceFirebirdConnectionProperties- Returns:
- default transaction isolation as string.
- See Also:
FirebirdConnectionProperties.setDefaultIsolation(String)
-
setDefaultIsolation
public 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 interfaceFirebirdConnectionProperties- Parameters:
isolation- string constant representing a default isolation level.
-
getTransactionParameters
public TransactionParameterBuffer getTransactionParameters(int isolation)
Description copied from interface:FirebirdConnectionPropertiesGet the transaction parameter buffer corresponding to the current connection request information.- Specified by:
getTransactionParametersin interfaceFirebirdConnectionProperties- Parameters:
isolation- transaction isolation level for which TPB should be returned.- Returns:
- instance of
TransactionParameterBuffer.
-
setTransactionParameters
public 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 interfaceFirebirdConnectionProperties- Parameters:
isolation- transaction isolation level.tpb- instance ofTransactionParameterBuffercontaining transaction parameters.
-
isDefaultResultSetHoldable
public boolean isDefaultResultSetHoldable()
Description copied from interface:FirebirdConnectionPropertiesGet the default ResultSet holdability.- Specified by:
isDefaultResultSetHoldablein interfaceFirebirdConnectionProperties- Returns:
truewhen ResultSets are holdable by default,falsenot holdable.
-
setDefaultResultSetHoldable
public void setDefaultResultSetHoldable(boolean isHoldable)
Description copied from interface:FirebirdConnectionPropertiesSets the default ResultSet holdability.- Specified by:
setDefaultResultSetHoldablein interfaceFirebirdConnectionProperties- Parameters:
isHoldable-truewhen ResultSets are holdable by default,falsenot holdable.
-
getSoTimeout
public int getSoTimeout()
Description copied from interface:FirebirdConnectionPropertiesGet the current Socket blocking timeout (SoTimeout).- Specified by:
getSoTimeoutin interfaceFirebirdConnectionProperties- Returns:
- The socket blocking timeout in milliseconds (0 is 'infinite')
-
setSoTimeout
public void setSoTimeout(int soTimeout)
Description copied from interface:FirebirdConnectionPropertiesSet the Socket blocking timeout (SoTimeout).- Specified by:
setSoTimeoutin interfaceFirebirdConnectionProperties- Parameters:
soTimeout- Timeout in milliseconds (0 is 'infinite')
-
isUseFirebirdAutocommit
public boolean isUseFirebirdAutocommit()
Description copied from interface:FirebirdConnectionPropertiesGet whether to use Firebird autocommit (experimental).- Specified by:
isUseFirebirdAutocommitin interfaceFirebirdConnectionProperties- Returns:
trueuse Firebird autocommit
-
setUseFirebirdAutocommit
public void setUseFirebirdAutocommit(boolean useFirebirdAutocommit)
Description copied from interface:FirebirdConnectionPropertiesSet whether to use Firebird autocommit (experimental).- Specified by:
setUseFirebirdAutocommitin interfaceFirebirdConnectionProperties- Parameters:
useFirebirdAutocommit-trueUse Firebird autocommit
-
getWireCrypt
public java.lang.String getWireCrypt()
Description copied from interface:FirebirdConnectionPropertiesGet the wire encryption level value.- Specified by:
getWireCryptin interfaceFirebirdConnectionProperties- Returns:
- Wire encryption level (
nullimpliesDEFAULT)
-
setWireCrypt
public 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 interfaceFirebirdConnectionProperties- Parameters:
wireCrypt- Wire encryption level
-
getDbCryptConfig
public java.lang.String getDbCryptConfig()
Description copied from interface:FirebirdConnectionPropertiesGet the database encryption plugin configuration.- Specified by:
getDbCryptConfigin interfaceFirebirdConnectionProperties- Returns:
- Database encryption plugin configuration, meaning plugin specific
-
setDbCryptConfig
public void setDbCryptConfig(java.lang.String dbCryptConfig)
Description copied from interface:FirebirdConnectionPropertiesSets the database encryption plugin configuration.- Specified by:
setDbCryptConfigin interfaceFirebirdConnectionProperties- Parameters:
dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
-
getAuthPlugins
public java.lang.String getAuthPlugins()
Description copied from interface:FirebirdConnectionPropertiesGet the list of authentication plugins to try.- Specified by:
getAuthPluginsin interfaceFirebirdConnectionProperties- Returns:
- comma-separated list of authentication plugins, or
nullfor driver default
-
setAuthPlugins
public 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 interfaceFirebirdConnectionProperties- Parameters:
authPlugins- comma-separated list of authentication plugins, ornullfor driver default
-
getGeneratedKeysEnabled
public java.lang.String getGeneratedKeysEnabled()
Description copied from interface:FirebirdConnectionPropertiesGet thegeneratedKeysEnabledconfiguration.- Specified by:
getGeneratedKeysEnabledin interfaceFirebirdConnectionProperties- Returns:
- configuration value for
generatedKeysEnabled, ornullfor driver default
-
setGeneratedKeysEnabled
public void setGeneratedKeysEnabled(java.lang.String generatedKeysEnabled)
Description copied from interface:FirebirdConnectionPropertiesSets thegeneratedKeysEnabledconfiguration.- Specified by:
setGeneratedKeysEnabledin interfaceFirebirdConnectionProperties- Parameters:
generatedKeysEnabled- Generated keys support configuration:default(or null/empty),disabled,ignored, or a list of statement types to enable (possible values:insert,update,delete,update_or_insert,merge)
-
getDataTypeBind
public java.lang.String getDataTypeBind()
Description copied from interface:FirebirdConnectionPropertiesGet thedataTypeBindconfiguration.- Specified by:
getDataTypeBindin interfaceFirebirdConnectionProperties- Returns:
- configuration value for
dataTypeBind, ornullfor driver default
-
setDataTypeBind
public 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 interfaceFirebirdConnectionProperties- Parameters:
dataTypeBind- Firebird 4+ data type bind configuration, a semicolon-separated list of<from-type> TO <to-type>
-
getSessionTimeZone
public java.lang.String getSessionTimeZone()
Description copied from interface:FirebirdConnectionPropertiesGet thesessionTimeZone.- Specified by:
getSessionTimeZonein interfaceFirebirdConnectionProperties- Returns:
- value for
sessionTimeZone, ornullfor driver default (JVM default time zone)
-
setSessionTimeZone
public void setSessionTimeZone(java.lang.String sessionTimeZone)
Description copied from interface:FirebirdConnectionPropertiesSets thesessionTimeZone.- Specified by:
setSessionTimeZonein interfaceFirebirdConnectionProperties- Parameters:
sessionTimeZone- Firebird 4+ session time zone name (we strongly suggest to use Java compatible names only), use"server"to use server default time zone (note: conversion will use JVM default time zone)
-
isIgnoreProcedureType
public boolean isIgnoreProcedureType()
Description copied from interface:FirebirdConnectionPropertiesGet the value forignoreProcedureType.- Specified by:
isIgnoreProcedureTypein interfaceFirebirdConnectionProperties- Returns:
- value for
ignoreProcedureType
-
setIgnoreProcedureType
public void setIgnoreProcedureType(boolean ignoreProcedureType)
Description copied from interface:FirebirdConnectionPropertiesSets the valueignoreProcedureType.When set to true, the
CallableStatementimplementation in Jaybird will ignore metadata information about the stored procedure type and default to usingEXECUTE PROCEDURE, unless the type is explicitly set usingFirebirdCallableStatement.setSelectableProcedure(boolean). This can be useful in situations where a stored procedure is selectable, but tooling or code expects an executable stored procedure.- Specified by:
setIgnoreProcedureTypein interfaceFirebirdConnectionProperties- Parameters:
ignoreProcedureType-trueIgnore procedure type
-
isWireCompression
public boolean isWireCompression()
Description copied from interface:FirebirdConnectionPropertiesGet if wire compression should be enabled.Wire compression requires Firebird 3 or higher, and the server must have the zlib library. If compression cannot be negotiated, the connection will be made without wire compression.
This property will be ignored for native connections. For native connections, the configuration in
firebird.confread by the client library will be used.- Specified by:
isWireCompressionin interfaceFirebirdConnectionProperties- Returns:
truewire compression enabled
-
setWireCompression
public void setWireCompression(boolean wireCompression)
Description copied from interface:FirebirdConnectionPropertiesSets if the connection should try to enable wire compression.- Specified by:
setWireCompressionin interfaceFirebirdConnectionProperties- Parameters:
wireCompression-trueenable wire compression,falsedisable wire compression (the default)- See Also:
FirebirdConnectionProperties.isWireCompression()
-
setNonStandardProperty
public 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 interfaceFirebirdConnectionProperties- 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)
-
setNonStandardProperty
public 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 interfaceFirebirdConnectionProperties- Parameters:
key- Name of the property (see Jaybird releasenotes)value- Value of the property- See Also:
setNonStandardProperty(String)
-
getNonStandardProperty
public 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 interfaceFirebirdConnectionProperties- Parameters:
key- Name of the property (see Jaybird releasenotes)- Returns:
- Value of the property
- See Also:
setNonStandardProperty(String),setNonStandardProperty(String, String)
-
setDatabase
protected final void setDatabase()
Sets the database property of connectionProperties.
-
setConnectionProperties
protected final void setConnectionProperties(FBConnectionProperties connectionProperties)
-
getConnectionProperties
protected final FBConnectionProperties getConnectionProperties()
-
updateReference
protected static void updateReference(javax.naming.Reference ref, FBAbstractCommonDataSource instance)Updates the supplied reference with RefAddr properties relevant to this class.- Parameters:
ref- Reference to updateinstance- Instance of this class to obtain values
-
-