- All Superinterfaces:
AttachmentProperties,BaseProperties,ServiceConnectionProperties
- All Known Subinterfaces:
BackupManager,MaintenanceManager,NBackupManager,StatisticsManager,TraceManager,UserManager
- All Known Implementing Classes:
FBBackupManager,FBBackupManagerBase,FBMaintenanceManager,FBNBackupManager,FBServiceManager,FBStatisticsManager,FBStreamingBackupManager,FBTraceManager,FBUserManager
The base Firebird Service API functionality.
- Author:
- Roman Rokytskyy, Steven Jardine, Mark Rotteveel
-
Method Summary
Modifier and TypeMethodDescriptionReturns the database path for the connection to the service manager.getHost()Deprecated, for removal: This API element is subject to removal in a future version.Returns the logger for the connection to the service manager.intgetPort()Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.getPortNumber(); will be removed in Jaybird 6 or laterObtains the server version through a service call.Get the wire encryption level.voidsetDatabase(String database) Sets the database path for the connection to the service manager.voidDeprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.setServerName(String); will be removed in Jaybird 6 or latervoidsetLogger(OutputStream logger) Sets the logger for the connection to the service manager.voidsetPort(int port) Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.setPortNumber(int); will be removed in Jaybird 6 or latervoidsetWireCryptAsEnum(WireCrypt wireCrypt) Set the wire encryption level.Methods inherited from interface org.firebirdsql.jaybird.props.AttachmentProperties
getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEnableProtocol, getEncoding, getParallelWorkers, getPassword, getPortNumber, getProcessId, getProcessName, getRoleName, getServerName, getSocketBufferSize, getSocketFactory, getSoTimeout, getType, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEnableProtocol, setEncoding, setParallelWorkers, setPassword, setPortNumber, setProcessId, setProcessName, setRoleName, setServerName, setSocketBufferSize, setSocketFactory, setSoTimeout, setType, setUser, setWireCompression, setWireCryptMethods inherited from interface org.firebirdsql.jaybird.props.BaseProperties
connectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setPropertyMethods inherited from interface org.firebirdsql.jaybird.props.ServiceConnectionProperties
getExpectedDb, getServiceName, setExpectedDb, setServiceName
-
Method Details
-
setDatabase
Sets the database path for the connection to the service manager.Will also set the
expectedDbproperty. If a different value must be used, it must be set after calling this method.- Parameters:
database- path for the connection to the service manager.
-
getDatabase
String getDatabase()Returns the database path for the connection to the service manager.- Returns:
- the database path for the connection to the service manager.
-
getHost
Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.getServerName(); will be removed in Jaybird 6 or laterReturns the host for the connection to the service manager.- Returns:
- the host for the connection to the service manager.
-
setHost
Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.setServerName(String); will be removed in Jaybird 6 or laterSets the host for the connection to the service manager.See
AttachmentProperties.setServerName(String)for details.- Parameters:
host- for the connection to the service manager.
-
getPort
Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.getPortNumber(); will be removed in Jaybird 6 or laterReturns the port for the connection to the service manager.- Returns:
- the port for the connection to the service manager.
-
setPort
Deprecated, for removal: This API element is subject to removal in a future version.UseAttachmentProperties.setPortNumber(int); will be removed in Jaybird 6 or laterSets the port for the connection to the service manager.- Parameters:
port- for the connection to the service manager.
-
getWireCryptAsEnum
WireCrypt getWireCryptAsEnum()Get the wire encryption level.- Returns:
- Wire encryption level
- Since:
- 5
-
setWireCryptAsEnum
Set the wire encryption level.- Parameters:
wireCrypt- Wire encryption level (nullnot allowed)- Since:
- 5
-
getLogger
OutputStream getLogger()Returns the logger for the connection to the service manager.- Returns:
- the logger for the connection to the service manager.
-
setLogger
Sets the logger for the connection to the service manager.- Parameters:
logger- for the connection to the service manager.
-
getServerVersion
Obtains the server version through a service call.- Returns:
- Parsed server version, or
GDSServerVersion.INVALID_VERSIONif parsing failed. - Throws:
SQLException- For errors connecting to the service manager.
-
AttachmentProperties.getServerName(); will be removed in Jaybird 6 or later