Class FBConnectionProperties
- java.lang.Object
-
- org.firebirdsql.jdbc.FBConnectionProperties
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,AttachmentProperties,BaseProperties,DatabaseConnectionProperties,FirebirdConnectionProperties
public final class FBConnectionProperties extends java.lang.Object implements FirebirdConnectionProperties, java.io.Serializable, java.lang.Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringAUTH_PLUGINSDeprecated.static java.lang.StringBLOB_BUFFER_SIZE_PROPERTYDeprecated.static java.lang.StringBUFFERS_NUMBER_PROPERTYDeprecated.static java.lang.StringCONNECT_TIMEOUTDeprecated.static java.lang.StringDATA_TYPE_BINDDeprecated.static java.lang.StringDATABASE_PROPERTYDeprecated.static java.lang.StringDB_CRYPT_CONFIGDeprecated.static java.lang.StringDEFAULT_HOLDABLE_RS_PROPERTYDeprecated.static java.lang.StringDEFAULT_ISOLATION_PROPERTYDeprecated.static java.lang.StringENCODING_PROPERTYDeprecated.static java.lang.StringGENERATED_KEYS_ENABLEDDeprecated.static java.lang.StringIGNORE_PROCEDURE_TYPEDeprecated.static java.lang.StringISOLATION_PROPERTYDeprecated.static java.lang.StringLOCAL_ENCODING_PROPERTYDeprecated.static java.lang.StringPASSWORD_PROPERTYDeprecated.static java.lang.StringROLE_NAME_PROPERTYDeprecated.static java.lang.StringSESSION_TIME_ZONEDeprecated.static java.lang.StringSO_TIMEOUTDeprecated.static java.lang.StringSOCKET_BUFFER_SIZE_PROPERTYDeprecated.static java.lang.StringSQL_DIALECT_PROPERTYDeprecated.static java.lang.StringTIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTYDeprecated.static java.lang.StringTYPE_PROPERTYDeprecated.static java.lang.StringUSE_FIREBIRD_AUTOCOMMITDeprecated.static java.lang.StringUSE_STREAM_BLOBS_PROPERTYDeprecated.static java.lang.StringUSER_NAME_PROPERTYDeprecated.static java.lang.StringWIRE_COMPRESSIONDeprecated.static java.lang.StringWIRE_CRYPT_LEVELDeprecated.
-
Constructor Summary
Constructors Constructor Description FBConnectionProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IConnectionPropertiesasIConnectionProperties()java.lang.Objectclone()java.util.Map<ConnectionProperty,java.lang.Object>connectionPropertyValues()An unmodifiable view on the connection properties held by this BaseProperties implementation.booleanequals(java.lang.Object obj)java.lang.BooleangetBooleanProperty(java.lang.String name)Retrieves abooleanproperty value by name.java.lang.IntegergetIntProperty(java.lang.String name)Retrieves anintproperty value by name.FBTpbMappergetMapper()java.lang.StringgetProperty(java.lang.String name)Retrieves a string property value by name.TransactionParameterBuffergetTransactionParameters(int isolation)Get the transaction parameter buffer corresponding to the current connection request information.inthashCode()voidsetBooleanProperty(java.lang.String name, java.lang.Boolean value)Sets abooleanproperty by name.voidsetIntProperty(java.lang.String name, java.lang.Integer value)Sets anintproperty by name.voidsetNonStandardProperty(java.lang.String propertyMapping)Set the property that does not have corresponding setter method.voidsetProperty(java.lang.String name, java.lang.String value)Sets a property by name.voidsetTransactionParameters(int isolation, TransactionParameterBuffer tpb)Set transaction parameters for the specified transaction isolation level.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.firebirdsql.jaybird.props.AttachmentProperties
getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getParallelWorkers, getPassword, getPortNumber, getProcessId, getProcessName, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getType, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setParallelWorkers, setPassword, setPortNumber, setProcessId, setProcessName, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setType, setUser, setWireCompression, setWireCrypt
-
Methods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
getBooleanProperty, getIntProperty, getProperty
-
Methods inherited from interface org.firebirdsql.jaybird.props.DatabaseConnectionProperties
getBlobBufferSize, getDatabaseName, getDataTypeBind, getDecfloatRound, getDecfloatTraps, getDefaultIsolation, getDefaultTransactionIsolation, getGeneratedKeysEnabled, getPageCacheSize, getScrollableCursor, getServerBatchBufferSize, getSessionTimeZone, getSqlDialect, getTpbMapping, isColumnLabelForName, isDefaultResultSetHoldable, isExtendedMetadata, isIgnoreProcedureType, isTimestampUsesLocalTimezone, isUseFirebirdAutocommit, isUseServerBatch, isUseStreamBlobs, setBlobBufferSize, setColumnLabelForName, setDatabaseName, setDataTypeBind, setDecfloatRound, setDecfloatTraps, setDefaultIsolation, setDefaultResultSetHoldable, setDefaultTransactionIsolation, setExtendedMetadata, setGeneratedKeysEnabled, setIgnoreProcedureType, setPageCacheSize, setScrollableCursor, setServerBatchBufferSize, setSessionTimeZone, setSqlDialect, setTimestampUsesLocalTimezone, setTpbMapping, setUseFirebirdAutocommit, setUseServerBatch, setUseStreamBlobs
-
Methods inherited from interface org.firebirdsql.jdbc.FirebirdConnectionProperties
getBuffersNumber, getDatabase, getNonStandardProperty, getUserName, setBuffersNumber, setDatabase, setNonStandardProperty, setUserName
-
-
-
-
Field Detail
-
DATABASE_PROPERTY
@Deprecated public static final java.lang.String DATABASE_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
TYPE_PROPERTY
@Deprecated public static final java.lang.String TYPE_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
ISOLATION_PROPERTY
@Deprecated public static final java.lang.String ISOLATION_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
DEFAULT_ISOLATION_PROPERTY
@Deprecated public static final java.lang.String DEFAULT_ISOLATION_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
BLOB_BUFFER_SIZE_PROPERTY
@Deprecated public static final java.lang.String BLOB_BUFFER_SIZE_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
LOCAL_ENCODING_PROPERTY
@Deprecated public static final java.lang.String LOCAL_ENCODING_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
ENCODING_PROPERTY
@Deprecated public static final java.lang.String ENCODING_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
ROLE_NAME_PROPERTY
@Deprecated public static final java.lang.String ROLE_NAME_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
SQL_DIALECT_PROPERTY
@Deprecated public static final java.lang.String SQL_DIALECT_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
USE_STREAM_BLOBS_PROPERTY
@Deprecated public static final java.lang.String USE_STREAM_BLOBS_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
SOCKET_BUFFER_SIZE_PROPERTY
@Deprecated public static final java.lang.String SOCKET_BUFFER_SIZE_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
TIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTY
@Deprecated public static final java.lang.String TIMESTAMP_USES_LOCAL_TIMEZONE_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
USER_NAME_PROPERTY
@Deprecated public static final java.lang.String USER_NAME_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
PASSWORD_PROPERTY
@Deprecated public static final java.lang.String PASSWORD_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
BUFFERS_NUMBER_PROPERTY
@Deprecated public static final java.lang.String BUFFERS_NUMBER_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
DEFAULT_HOLDABLE_RS_PROPERTY
@Deprecated public static final java.lang.String DEFAULT_HOLDABLE_RS_PROPERTY
Deprecated.- See Also:
- Constant Field Values
-
SO_TIMEOUT
@Deprecated public static final java.lang.String SO_TIMEOUT
Deprecated.- See Also:
- Constant Field Values
-
CONNECT_TIMEOUT
@Deprecated public static final java.lang.String CONNECT_TIMEOUT
Deprecated.- See Also:
- Constant Field Values
-
USE_FIREBIRD_AUTOCOMMIT
@Deprecated public static final java.lang.String USE_FIREBIRD_AUTOCOMMIT
Deprecated.- See Also:
- Constant Field Values
-
WIRE_CRYPT_LEVEL
@Deprecated public static final java.lang.String WIRE_CRYPT_LEVEL
Deprecated.- See Also:
- Constant Field Values
-
DB_CRYPT_CONFIG
@Deprecated public static final java.lang.String DB_CRYPT_CONFIG
Deprecated.- See Also:
- Constant Field Values
-
AUTH_PLUGINS
@Deprecated public static final java.lang.String AUTH_PLUGINS
Deprecated.- See Also:
- Constant Field Values
-
GENERATED_KEYS_ENABLED
@Deprecated public static final java.lang.String GENERATED_KEYS_ENABLED
Deprecated.- See Also:
- Constant Field Values
-
DATA_TYPE_BIND
@Deprecated public static final java.lang.String DATA_TYPE_BIND
Deprecated.- See Also:
- Constant Field Values
-
SESSION_TIME_ZONE
@Deprecated public static final java.lang.String SESSION_TIME_ZONE
Deprecated.- See Also:
- Constant Field Values
-
IGNORE_PROCEDURE_TYPE
@Deprecated public static final java.lang.String IGNORE_PROCEDURE_TYPE
Deprecated.- See Also:
- Constant Field Values
-
WIRE_COMPRESSION
@Deprecated public static final java.lang.String WIRE_COMPRESSION
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getProperty
public java.lang.String getProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves a string property value by name.For properties with an explicit default, this method should return the string presentation of that default, not
null. Forintorbooleanthe string equivalent is returned.- Specified by:
getPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Value of the property, or
nullwhen not set or not a known property
-
setProperty
public void setProperty(java.lang.String name, java.lang.String value)Description copied from interface:BasePropertiesSets a property by name.This method can be used to set all defined properties, but also properties not known by Jaybird. When setting
intorbooleanproperties, the appropriate conversions are applied. Usingnullwill reset to the default value. Forbooleanproperties, an empty string is taken to meantrue.- Specified by:
setPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getIntProperty
public java.lang.Integer getIntProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves anintproperty value by name.For properties with an explicit default, this method should return the integer presentation of that default. For implementation simplicity, it is allowed to convert any string property to
intinstead of checking if something is actually anintproperty- Specified by:
getIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
setIntProperty
public void setIntProperty(java.lang.String name, java.lang.Integer value)Description copied from interface:BasePropertiesSets anintproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setIntPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
getBooleanProperty
public java.lang.Boolean getBooleanProperty(java.lang.String name)
Description copied from interface:BasePropertiesRetrieves abooleanproperty value by name.For properties with an explicit default, this method should return the boolean presentation of that default. For implementation simplicity, it is allowed to convert any string property to
booleaninstead of checking if something is actually anintproperty- Specified by:
getBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)- Returns:
- Integer with value of the property, or
nullwhen not set
-
setBooleanProperty
public void setBooleanProperty(java.lang.String name, java.lang.Boolean value)Description copied from interface:BasePropertiesSets abooleanproperty by name.For implementation simplicity, it is allowed to also set string properties. The value set will be the string equivalent.
- Specified by:
setBooleanPropertyin interfaceBaseProperties- Parameters:
name- Property name (notnullor empty)value- Property value (usenullto apply default)
-
connectionPropertyValues
public java.util.Map<ConnectionProperty,java.lang.Object> connectionPropertyValues()
Description copied from interface:BasePropertiesAn unmodifiable view on the connection properties held by this BaseProperties implementation.Be aware, implementations can have additional properties that are not mapped from
ConnectionProperty. Such properties will need to be retrieved in an implementation-specific manner.- Specified by:
connectionPropertyValuesin interfaceBaseProperties- Returns:
- An unmodifiable view on the property values held in this properties instance
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
clone
public java.lang.Object clone()
- Overrides:
clonein classjava.lang.Object
-
setNonStandardProperty
public void setNonStandardProperty(java.lang.String propertyMapping)
Description copied from interface:FirebirdConnectionPropertiesSet the property that does not have corresponding setter method.- Specified by:
setNonStandardPropertyin interfaceFirebirdConnectionProperties- Parameters:
propertyMapping- parameter value in thepropertyName[=propertyValue]form, this allows setting non-standard parameters using configuration files.
-
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.
-
getMapper
public FBTpbMapper getMapper() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
asIConnectionProperties
public IConnectionProperties asIConnectionProperties()
- Returns:
- A mutable view of these connection properties as an implementation of
IConnectionProperties - Since:
- 5
-
-