|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FirebirdConnectionProperties
Connection properties for the Firebird connection. Main part of this interface corresponds to the Database Parameter Buffer, but also contains properties to specify default transaction parameters.
Method Summary | |
---|---|
int |
getBlobBufferSize()
|
int |
getBuffersNumber()
|
java.lang.String |
getCharSet()
|
int |
getConnectTimeout()
Get the current connect timeout. |
java.lang.String |
getDatabase()
|
DatabaseParameterBuffer |
getDatabaseParameterBuffer()
Get the database parameter buffer corresponding to the current connection request information. |
java.lang.String |
getDefaultIsolation()
Get the default transaction isolation level as string. |
int |
getDefaultTransactionIsolation()
Get the default transaction isolation level. |
java.lang.String |
getEncoding()
|
java.lang.String |
getNonStandardProperty(java.lang.String key)
Get the property that does not have corresponding getter method by its name. |
java.lang.String |
getPassword()
|
java.lang.String |
getRoleName()
|
int |
getSocketBufferSize()
|
int |
getSoTimeout()
Get the current Socket blocking timeout (SoTimeout). |
java.lang.String |
getSqlDialect()
|
java.lang.String |
getTpbMapping()
Get the used TPB mapping. |
TransactionParameterBuffer |
getTransactionParameters(int isolation)
Get the transaction parameter buffer corresponding to the current connection request information. |
java.lang.String |
getType()
|
java.lang.String |
getUserName()
|
java.lang.String |
getUseTranslation()
|
boolean |
isDefaultResultSetHoldable()
Get the default ResultSet holdability. |
boolean |
isTimestampUsesLocalTimezone()
|
boolean |
isUseFirebirdAutocommit()
Get whether to use Firebird autocommit (experimental). |
boolean |
isUseStandardUdf()
|
boolean |
isUseStreamBlobs()
|
void |
setBlobBufferSize(int bufferSize)
|
void |
setBuffersNumber(int buffersNumber)
|
void |
setCharSet(java.lang.String charSet)
|
void |
setConnectTimeout(int connectTimeout)
Set the connect timeout. |
void |
setDatabase(java.lang.String database)
|
void |
setDefaultIsolation(java.lang.String isolation)
Set the default transaction isolation level as string. |
void |
setDefaultResultSetHoldable(boolean isHoldable)
Sets the default ResultSet holdability. |
void |
setDefaultTransactionIsolation(int defaultIsolationLevel)
Set the default transaction isolation level. |
void |
setEncoding(java.lang.String encoding)
|
void |
setNonStandardProperty(java.lang.String propertyMapping)
Set the property that does not have corresponding setter method. |
void |
setNonStandardProperty(java.lang.String key,
java.lang.String value)
Set the property that does not have corresponding setter method. |
void |
setPassword(java.lang.String password)
|
void |
setRoleName(java.lang.String roleName)
|
void |
setSocketBufferSize(int socketBufferSize)
|
void |
setSoTimeout(int soTimeout)
Set the Socket blocking timeout (SoTimeout). |
void |
setSqlDialect(java.lang.String sqlDialect)
|
void |
setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone)
|
void |
setTpbMapping(java.lang.String tpbMapping)
Set path to the properties file with the TPB mapping. |
void |
setTransactionParameters(int isolation,
TransactionParameterBuffer tpb)
Set transaction parameters for the specified transaction isolation level. |
void |
setType(java.lang.String type)
|
void |
setUseFirebirdAutocommit(boolean useFirebirdAutocommit)
Set whether to use Firebird autocommit (experimental). |
void |
setUserName(java.lang.String userName)
|
void |
setUseStandardUdf(boolean useStandardUdf)
|
void |
setUseStreamBlobs(boolean useStreamBlobs)
|
void |
setUseTranslation(java.lang.String translationPath)
|
Method Detail |
---|
java.lang.String getDatabase()
void setDatabase(java.lang.String database)
database
- path to the database including the server name and the
port, if needed.java.lang.String getType()
void setType(java.lang.String type)
type
- type of the connection, for example, "PURE_JAVA", "LOCAL",
"EMBEDDED", depends on the GDS implementations installed in the system.int getBlobBufferSize()
void setBlobBufferSize(int bufferSize)
bufferSize
- size of the BLOB buffer in bytes.java.lang.String getCharSet()
setCharSet(String)
void setCharSet(java.lang.String charSet)
charSet
- Character set for the connection. Similar to
encoding
property, but accepts Java names
instead of Firebird ones.java.lang.String getEncoding()
setEncoding(String)
void setEncoding(java.lang.String encoding)
encoding
- Character encoding for the connection. See Firebird
documentation for more information.java.lang.String getRoleName()
void setRoleName(java.lang.String roleName)
roleName
- SQL role to use.java.lang.String getSqlDialect()
void setSqlDialect(java.lang.String sqlDialect)
sqlDialect
- SQL dialect of the client.java.lang.String getUseTranslation()
void setUseTranslation(java.lang.String translationPath)
translationPath
- path to the character translation table.boolean isUseStreamBlobs()
true
if stream blobs should be created, otherwise
false
.void setUseStreamBlobs(boolean useStreamBlobs)
useStreamBlobs
- true
if stream blobs should be created,
otherwise false
.boolean isUseStandardUdf()
true
if driver should assume that standard UDF are
installed.void setUseStandardUdf(boolean useStandardUdf)
useStandardUdf
- true
if driver should assume that standard UDF
are installed.int getSocketBufferSize()
void setSocketBufferSize(int socketBufferSize)
socketBufferSize
- socket buffer size in bytes.boolean isTimestampUsesLocalTimezone()
true
if the Jaybird 1.0 handling of the calendar
in corresponding setters. This is also compatible with MySQL
calendar treatment.void setTimestampUsesLocalTimezone(boolean timestampUsesLocalTimezone)
timestampUsesLocalTimezone
- true
if the Jaybird 1.0 handling of the
calendar in corresponding setters. This is also compatible
with MySQL calendar treatment.java.lang.String getUserName()
void setUserName(java.lang.String userName)
userName
- name of the user that will be used when connecting to the
database.java.lang.String getPassword()
void setPassword(java.lang.String password)
password
- password corresponding to the specified user name.int getBuffersNumber()
void setBuffersNumber(int buffersNumber)
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.java.lang.String getNonStandardProperty(java.lang.String key)
key
- name of the property to get.
void setNonStandardProperty(java.lang.String key, java.lang.String value)
key
- name of the property to set.value
- value of the property.void setNonStandardProperty(java.lang.String propertyMapping)
propertyMapping
- parameter value in the ?propertyName[=propertyValue]? form,
this allows setting non-standard parameters using
configuration files.DatabaseParameterBuffer getDatabaseParameterBuffer() throws java.sql.SQLException
DatabaseParameterBuffer
.
java.sql.SQLException
- if database parameter buffer cannot be created.java.lang.String getTpbMapping()
setTpbMapping(String)
void setTpbMapping(java.lang.String tpbMapping)
"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 the Connection
interface
and a comma-separated list of TPB parameters.
tpbMapping
- path to the properties file.int getDefaultTransactionIsolation()
void setDefaultTransactionIsolation(int defaultIsolationLevel)
defaultIsolationLevel
- default transaction isolation level.java.lang.String getDefaultIsolation()
getDefaultTransactionIsolation()
, however
it takes a string as parameter instead of a numeric constant.
setDefaultIsolation(String)
void setDefaultIsolation(java.lang.String isolation)
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.
isolation
- string constant representing a default isolation level.TransactionParameterBuffer getTransactionParameters(int isolation)
isolation
- transaction isolation level for which TPB should be returned.
TransactionParameterBuffer
.void setTransactionParameters(int isolation, TransactionParameterBuffer tpb)
isolation
- transaction isolation level.tpb
- instance of TransactionParameterBuffer
containing
transaction parameters.boolean isDefaultResultSetHoldable()
true
when ResultSets are holdable by default, false
not holdable.void setDefaultResultSetHoldable(boolean isHoldable)
isHoldable
- true
when ResultSets are holdable by default, false
not holdable.int getSoTimeout()
void setSoTimeout(int soTimeout)
soTimeout
- Timeout in milliseconds (0 is 'infinite')int getConnectTimeout()
void setConnectTimeout(int connectTimeout)
connectTimeout
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)boolean isUseFirebirdAutocommit()
use Firebird autocommitvoid setUseFirebirdAutocommit(boolean useFirebirdAutocommit)
useFirebirdAutocommit
- true
Use Firebird autocommit
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |