public interface IAttachProperties<T extends IAttachProperties>
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_CONNECT_TIMEOUT |
static int |
DEFAULT_PORT |
static java.lang.String |
DEFAULT_SERVER_NAME |
static int |
DEFAULT_SO_TIMEOUT |
static int |
DEFAULT_SOCKET_BUFFER_SIZE |
| Modifier and Type | Method and Description |
|---|---|
T |
asImmutable() |
T |
asNewMutable() |
java.lang.String |
getAttachObjectName() |
java.lang.String |
getAuthPlugins()
Get the list of authentication plugins to try.
|
java.lang.String |
getCharSet() |
int |
getConnectTimeout()
Get the connect timeout in seconds.
|
java.lang.String |
getDbCryptConfig()
Get the database encryption plugin configuration.
|
java.lang.String |
getEncoding() |
java.lang.String |
getPassword() |
int |
getPortNumber()
Get the portnumber of the server.
|
java.lang.String |
getRoleName() |
java.lang.String |
getServerName()
Get the hostname or IP address of the Firebird server.
|
int |
getSocketBufferSize()
Get the socket buffer size.
|
int |
getSoTimeout()
Get the initial Socket blocking timeout (SoTimeout).
|
java.lang.String |
getUser() |
WireCrypt |
getWireCrypt()
Get the wire encryption level.
|
boolean |
isWireCompression()
Get if wire compression should be enabled.
|
void |
setAuthPlugins(java.lang.String authPlugins)
Sets the authentication plugins to try.
|
void |
setCharSet(java.lang.String charSet)
Set the Java character set for the connection.
|
void |
setConnectTimeout(int connectTimeout)
Set the connect timeout in seconds.
|
void |
setDbCryptConfig(java.lang.String dbCryptConfig)
Sets the database encryption plugin configuration.
|
void |
setEncoding(java.lang.String encoding)
Set the Firebird character set for the connection.
|
void |
setPassword(java.lang.String password) |
void |
setPortNumber(int portNumber)
Set the port number of the server.
|
void |
setRoleName(java.lang.String roleName) |
void |
setServerName(java.lang.String serverName)
Set the hostname or IP address of the Firebird server.
|
void |
setSocketBufferSize(int socketBufferSize)
Set the socket buffer size.
|
void |
setSoTimeout(int soTimeout)
Set the initial Socket blocking timeout (SoTimeout).
|
void |
setUser(java.lang.String user) |
void |
setWireCompression(boolean wireCompression)
Sets if the connection should try to enable wire compression.
|
void |
setWireCrypt(WireCrypt wireCrypt)
Set the wire encryption level.
|
static final int DEFAULT_PORT
static final java.lang.String DEFAULT_SERVER_NAME
static final int DEFAULT_SOCKET_BUFFER_SIZE
static final int DEFAULT_SO_TIMEOUT
static final int DEFAULT_CONNECT_TIMEOUT
java.lang.String getAttachObjectName()
java.lang.String getServerName()
NOTE: Implementer should take care to return DEFAULT_SERVER_NAME
if value hasn't been set yet.
void setServerName(java.lang.String serverName)
NOTE: Implementer should take care to use DEFAULT_SERVER_NAME if
value hasn't been set yet.
serverName - Hostname or IP address of the serverint getPortNumber()
NOTE: Implementer should take care to return DEFAULT_PORT if
value hasn't been set yet.
void setPortNumber(int portNumber)
NOTE: Implementer should take care to use the DEFAULT_PORT if
this method hasn't been called yet.
portNumber - Port number of the serverjava.lang.String getUser()
void setUser(java.lang.String user)
user - Name of the user to authenticate to the server.java.lang.String getPassword()
void setPassword(java.lang.String password)
password - Password to authenticate to the server.java.lang.String getRoleName()
void setRoleName(java.lang.String roleName)
roleName - SQL role to use.java.lang.String getCharSet()
void setCharSet(java.lang.String charSet)
Contrary to other parts of the codebase, the value of
encoding should not be changed when charSet is
set.
charSet - Character set for the connection. Similar to
encoding property, but accepts Java names instead
of Firebird ones.setEncoding(String)java.lang.String getEncoding()
void setEncoding(java.lang.String encoding)
Contrary to other parts of the codebase, the value of
charSet should not be changed when encoding is
set.
encoding - Firebird character encoding for the connection. See Firebird
documentation for more information.int getSocketBufferSize()
NOTE: Implementer should take care to return DEFAULT_SOCKET_BUFFER_SIZE if the
value hasn't been set yet.
void setSocketBufferSize(int socketBufferSize)
NOTE: Implementer should take care to use DEFAULT_SOCKET_BUFFER_SIZE if the
value hasn't been set yet.
socketBufferSize - socket buffer size in bytes.int getSoTimeout()
NOTE: Implementer should take care to return DEFAULT_SO_TIMEOUT if the
value hasn't been set yet.
void setSoTimeout(int soTimeout)
NOTE: Implementer should take care to use DEFAULT_SO_TIMEOUT if the
value hasn't been set yet.
soTimeout - Timeout in milliseconds (0 is 'infinite')int getConnectTimeout()
NOTE: Implementer should take care to return DEFAULT_CONNECT_TIMEOUT if the
value hasn't been set yet.
void setConnectTimeout(int connectTimeout)
NOTE: Implementer should take care to use DEFAULT_CONNECT_TIMEOUT if the
value hasn't been set yet.
connectTimeout - Connect timeout in seconds (0 is 'infinite', or better: OS
specific timeout)WireCrypt getWireCrypt()
NOTE: Implementer should take care to return WireCrypt.DEFAULT if
the value hasn't been set yet.
void setWireCrypt(WireCrypt wireCrypt)
NOTE: Implementer should take care to use WireCrypt.DEFAULT if
the value hasn't been set yet.
wireCrypt - Wire encryption level (null not allowed)java.lang.String getDbCryptConfig()
void setDbCryptConfig(java.lang.String dbCryptConfig)
dbCryptConfig - Database encryption plugin configuration, meaning plugin specificjava.lang.String getAuthPlugins()
null for driver defaultvoid setAuthPlugins(java.lang.String authPlugins)
Invalid names are skipped during authentication.
authPlugins - comma-separated list of authentication plugins, or null for driver defaultboolean isWireCompression()
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.conf read by the client library will be used.
true wire compression enabledvoid setWireCompression(boolean wireCompression)
wireCompression - true enable wire compression, false disable wire compression (the default)isWireCompression()T asImmutable()
IAttachPropertiesT asNewMutable()
IAttachProperties with all properties copied.Copyright © 2001-2023 Jaybird (Firebird JDBC/JCA) team. All rights reserved.