Interface AttachmentProperties
- 
- All Superinterfaces:
- BaseProperties
 - All Known Subinterfaces:
- BackupManager,- DatabaseConnectionProperties,- EventManager,- FBManagerMBean,- FirebirdConnectionProperties,- IAttachProperties<T>,- IConnectionProperties,- IServiceProperties,- MaintenanceManager,- NBackupManager,- ServiceConnectionProperties,- ServiceManager,- StatisticsManager,- TraceManager,- UserManager
 - All Known Implementing Classes:
- AbstractAttachProperties,- AbstractConnectionPropertiesDataSource,- AbstractImmutableAttachProperties,- FBAbstractCommonDataSource,- FBBackupManager,- FBBackupManagerBase,- FBConnectionPoolDataSource,- FbConnectionProperties,- FBConnectionProperties,- FBEventManager,- FbImmutableConnectionProperties,- FbImmutableServiceProperties,- FBMaintenanceManager,- FBManagedConnectionFactory,- FBManager,- FBNBackupManager,- FBServiceManager,- FbServiceProperties,- FBSimpleDataSource,- FBStatisticsManager,- FBStreamingBackupManager,- FBTraceManager,- FBUserManager,- FBXADataSource
 
 public interface AttachmentProperties extends BaseProperties Attachment properties shared by database and service connections.- Since:
- 5
- Author:
- Mark Rotteveel
 
- 
- 
Method SummaryAll Methods Instance Methods Default Methods Modifier and Type Method Description default java.lang.StringgetAuthPlugins()Get the list of authentication plugins to try.default java.lang.StringgetCharSet()Java character set configured for the connection.default intgetConnectTimeout()Get the connect timeout in seconds.default java.lang.StringgetDbCryptConfig()Get the database encryption plugin configuration.default java.lang.StringgetEncoding()Firebird character set configured for the connection.default intgetParallelWorkers()default java.lang.StringgetPassword()default intgetPortNumber()Get the port number of the server.default java.lang.IntegergetProcessId()default java.lang.StringgetProcessName()default java.lang.StringgetRoleName()default java.lang.StringgetServerName()Get the hostname or IP address of the Firebird server.default intgetSocketBufferSize()Get the socket buffer size.default intgetSoTimeout()Get the initial Socket blocking timeout (SoTimeout).default java.lang.StringgetType()default java.lang.StringgetUser()default java.lang.StringgetWireCrypt()Get the wire encryption level.default booleanisWireCompression()Get if wire compression should be enabled.default voidsetAuthPlugins(java.lang.String authPlugins)Sets the authentication plugins to try.default voidsetCharSet(java.lang.String charSet)Set the Java character set for the connection.default voidsetConnectTimeout(int connectTimeout)Set the connect timeout in seconds.default voidsetDbCryptConfig(java.lang.String dbCryptConfig)Sets the database encryption plugin configuration.default voidsetEncoding(java.lang.String encoding)Set the Firebird character set for the connection.default voidsetParallelWorkers(int parallelWorkers)Sets the number of parallel workers of the connection.default voidsetPassword(java.lang.String password)default voidsetPortNumber(int portNumber)Set the port number of the server.default voidsetProcessId(java.lang.Integer processId)Sets a custom process id to send to Firebird on attach.default voidsetProcessName(java.lang.String processName)Sets a custom process name to send to Firebird on attachdefault voidsetRoleName(java.lang.String roleName)default voidsetServerName(java.lang.String serverName)Set the hostname or IP address of the Firebird server.default voidsetSocketBufferSize(int socketBufferSize)Set the socket buffer size.default voidsetSoTimeout(int soTimeout)Set the initial Socket blocking timeout (SoTimeout).default voidsetType(java.lang.String type)default voidsetUser(java.lang.String user)default voidsetWireCompression(boolean wireCompression)Sets if the connection should try to enable wire compression.default voidsetWireCrypt(java.lang.String wireCrypt)Set the wire encryption level.- 
Methods inherited from interface org.firebirdsql.jaybird.props.BasePropertiesconnectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setProperty
 
- 
 
- 
- 
- 
Method Detail- 
getServerNamedefault java.lang.String getServerName() Get the hostname or IP address of the Firebird server.- Returns:
- Hostname or IP address of the server
- See Also:
- setServerName(String)
 
 - 
setServerNamedefault void setServerName(java.lang.String serverName) Set the hostname or IP address of the Firebird server.When set to null(the default), thedatabaseNameorserviceNameis used as the full identification of the database host, port and database path/alias. Protocol implementations, for examplePURE_JAVA, may default tolocalhostwhen this property isnull, butdatabaseName/serviceNamedoes not (seem to) contain a host name.- Parameters:
- serverName- Hostname or IP address of the server
 
 - 
getPortNumberdefault int getPortNumber() Get the port number of the server.- Returns:
- Port number of the server
- See Also:
- setPortNumber(int)
 
 - 
setPortNumberdefault void setPortNumber(int portNumber) Set the port number of the server.Defaults to 3050. This property value will be ignored ifserverNameisnull, unless the protocol implementation needs a hostname, but cannot find a hostname indatabaseName/serviceName.- Parameters:
- portNumber- Port number of the server
- See Also:
- setServerName(String)
 
 - 
getTypedefault java.lang.String getType() - Returns:
- type of the connection, for example, "PURE_JAVA", "NATIVE", "EMBEDDED", depends on the GDS implementations installed in the system.
 
 - 
setTypedefault void setType(java.lang.String type) - Parameters:
- type- type of the connection, for example, "PURE_JAVA", "NATIVE", "EMBEDDED", depends on the GDS implementations installed in the system.
- Throws:
- java.lang.IllegalStateException- may be thrown when type cannot or can no longer be changed
 
 - 
getUserdefault java.lang.String getUser() - Returns:
- Name of the user to authenticate to the server.
 
 - 
setUserdefault void setUser(java.lang.String user) - Parameters:
- user- Name of the user to authenticate to the server.
 
 - 
getPassworddefault java.lang.String getPassword() - Returns:
- Password to authenticate to the server.
 
 - 
setPassworddefault void setPassword(java.lang.String password) - Parameters:
- password- Password to authenticate to the server.
 
 - 
getRoleNamedefault java.lang.String getRoleName() - Returns:
- SQL role to use.
 
 - 
setRoleNamedefault void setRoleName(java.lang.String roleName) - Parameters:
- roleName- SQL role to use.
 
 - 
getCharSetdefault java.lang.String getCharSet() Java character set configured for the connection.After connect, the actual Java character set applied can be obtained from FbAttachment.getEncoding()(propertycharsetName), orFbAttachment.getEncodingFactory()(propertiesdefaultEncoding.charsetNameor {code defaultEncodingDefinition.javaCharset}).- Returns:
- Java character set for the connection (nullwhen not explicitly configured).
 
 - 
setCharSetdefault void setCharSet(java.lang.String charSet) Set the Java character set for the connection.It is possible to set both the charSetandencodingto achieve a character set conversion effect, but in general only one of both properties should be set.- Parameters:
- charSet- Character set for the connection. Similar to- encodingproperty, but accepts Java names instead of Firebird ones.
- See Also:
- setEncoding(String)
 
 - 
getEncodingdefault java.lang.String getEncoding() Firebird character set configured for the connection.After connect, the actual Firebird character set applied can be obtained from FbAttachment.getEncodingFactory(), propertydefaultEncodingDefinition.firebirdEncodingName.- Returns:
- Firebird character encoding for the connection (nullwhen not explicitly configured).
 
 - 
setEncodingdefault void setEncoding(java.lang.String encoding) Set the Firebird character set for the connection.It is possible to set both the charSetandencodingto achieve a character set conversion effect, but in general only one of both properties should be set.- Parameters:
- encoding- Firebird character encoding for the connection. See Firebird documentation for more information.
- See Also:
- setCharSet(String)
 
 - 
getProcessIddefault java.lang.Integer getProcessId() - Returns:
- Custom process id sent to Firebird on attach; nullmeans the default is applied (read from system propertyorg.firebirdsql.jdbc.pid, future versions may also determine the actual process id)
 
 - 
setProcessIddefault void setProcessId(java.lang.Integer processId) Sets a custom process id to send to Firebird on attach.- Parameters:
- processId- The process id to send;- nullto apply the default behaviour (see- getProcessId())
 
 - 
getProcessNamedefault java.lang.String getProcessName() - Returns:
- Custom process name sent to Firebird on attach; nullmeans the default is applied (read from system propertyorg.firebirdsql.jdbc.processName)
 
 - 
setProcessNamedefault void setProcessName(java.lang.String processName) Sets a custom process name to send to Firebird on attach- Parameters:
- processName- The process name to send;- nullto apply the default behaviour (see- getProcessName())
 
 - 
getSocketBufferSizedefault int getSocketBufferSize() Get the socket buffer size.- Returns:
- socket buffer size in bytes, or -1if not set
 
 - 
setSocketBufferSizedefault void setSocketBufferSize(int socketBufferSize) Set the socket buffer size.- Parameters:
- socketBufferSize- socket buffer size in bytes.
 
 - 
getSoTimeoutdefault int getSoTimeout() Get the initial Socket blocking timeout (SoTimeout).- Returns:
- The initial socket blocking timeout in milliseconds (0 is 'infinite'), or -1if not set
 
 - 
setSoTimeoutdefault void setSoTimeout(int soTimeout) Set the initial Socket blocking timeout (SoTimeout).- Parameters:
- soTimeout- Timeout in milliseconds (0 is 'infinite')
 
 - 
getConnectTimeoutdefault int getConnectTimeout() Get the connect timeout in seconds.- Returns:
- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout), or -1if not set
 
 - 
setConnectTimeoutdefault void setConnectTimeout(int connectTimeout) Set the connect timeout in seconds.- Parameters:
- connectTimeout- Connect timeout in seconds (0 is 'infinite', or better: OS specific timeout)
 
 - 
getWireCryptdefault java.lang.String getWireCrypt() Get the wire encryption level.- Returns:
- Wire encryption level
- Since:
- 4.0
 
 - 
setWireCryptdefault void setWireCrypt(java.lang.String wireCrypt) Set the wire encryption level.Values are defined by WireCrypt, values are handled case insensitive. Invalid values will throw an exception.- Parameters:
- wireCrypt- Wire encryption level (- nullnot allowed)
- Throws:
- InvalidPropertyValueException- If the value is not one of the allowed values
- Since:
- 4.0
 
 - 
getDbCryptConfigdefault java.lang.String getDbCryptConfig() Get the database encryption plugin configuration.- Returns:
- Database encryption plugin configuration, meaning plugin specific
- Since:
- 3.0.4
 
 - 
setDbCryptConfigdefault void setDbCryptConfig(java.lang.String dbCryptConfig) Sets the database encryption plugin configuration.- Parameters:
- dbCryptConfig- Database encryption plugin configuration, meaning plugin specific
- Since:
- 3.0.4
 
 - 
getAuthPluginsdefault java.lang.String getAuthPlugins() Get the list of authentication plugins to try.- Returns:
- comma-separated list of authentication plugins
- Since:
- 4.0
 
 - 
setAuthPluginsdefault void setAuthPlugins(java.lang.String authPlugins) Sets the authentication plugins to try.Invalid names are skipped during authentication. - Parameters:
- authPlugins- comma-separated list of authentication plugins
- Since:
- 4.0
 
 - 
isWireCompressiondefault boolean isWireCompression() Get 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.- Returns:
- truewire compression enabled
- Since:
- 4.0
 
 - 
setWireCompressiondefault void setWireCompression(boolean wireCompression) Sets if the connection should try to enable wire compression.- Parameters:
- wireCompression-- trueenable wire compression,- falsedisable wire compression (the default)
- Since:
- 4.0
- See Also:
- isWireCompression()
 
 - 
getParallelWorkersdefault int getParallelWorkers() - Returns:
- number of parallel workers, -1means no value was set (or it was explicitly set to-1)
- Since:
- 5.0.2
 
 - 
setParallelWorkersdefault void setParallelWorkers(int parallelWorkers) Sets the number of parallel workers of the connection.Requires Firebird 5.0 or higher, and a Firebird server configured with MaxParallelWorkershigher than specified byparallelWorkers.NOTE: For service attachments, this property controls behaviour only for specific operations, and requires Jaybird to explicitly set the parallel workers for that operation. - Parameters:
- parallelWorkers- number of parallel workers
- Since:
- 5.0.2
 
 
- 
 
-