Package org.firebirdsql.management
Interface ServiceManager
- 
- 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
 
 public interface ServiceManager extends ServiceConnectionProperties The base Firebird Service API functionality.- Author:
- Roman Rokytskyy, Steven Jardine, Mark Rotteveel
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetDatabase()Returns the database path for the connection to the service manager.java.lang.StringgetHost()Deprecated.UseAttachmentProperties.getServerName(); will be removed in Jaybird 6 or laterjava.io.OutputStreamgetLogger()Returns the logger for the connection to the service manager.intgetPort()Deprecated.UseAttachmentProperties.getPortNumber(); will be removed in Jaybird 6 or laterGDSServerVersiongetServerVersion()Obtains the server version through a service call.WireCryptgetWireCryptAsEnum()Get the wire encryption level.voidsetDatabase(java.lang.String database)Sets the database path for the connection to the service manager.voidsetHost(java.lang.String host)Deprecated.UseAttachmentProperties.setServerName(String); will be removed in Jaybird 6 or latervoidsetLogger(java.io.OutputStream logger)Sets the logger for the connection to the service manager.voidsetPort(int port)Deprecated.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.AttachmentPropertiesgetAuthPlugins, 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.BasePropertiesconnectionPropertyValues, getBooleanProperty, getBooleanProperty, getIntProperty, getIntProperty, getProperty, getProperty, setBooleanProperty, setIntProperty, setProperty
 - 
Methods inherited from interface org.firebirdsql.jaybird.props.ServiceConnectionPropertiesgetExpectedDb, getServiceName, setExpectedDb, setServiceName
 
- 
 
- 
- 
- 
Method Detail- 
setDatabasevoid setDatabase(java.lang.String database) 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.
 
 - 
getDatabasejava.lang.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 java.lang.String getHost() Deprecated.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 void setHost(java.lang.String host) Deprecated.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 int getPort() Deprecated.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 void setPort(int port) Deprecated.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.
 
 - 
getWireCryptAsEnumWireCrypt getWireCryptAsEnum() Get the wire encryption level.- Returns:
- Wire encryption level
- Since:
- 5
 
 - 
setWireCryptAsEnumvoid setWireCryptAsEnum(WireCrypt wireCrypt) Set the wire encryption level.- Parameters:
- wireCrypt- Wire encryption level (- nullnot allowed)
- Since:
- 5
 
 - 
getLoggerjava.io.OutputStream getLogger() Returns the logger for the connection to the service manager.- Returns:
- the logger for the connection to the service manager.
 
 - 
setLoggervoid setLogger(java.io.OutputStream logger) Sets the logger for the connection to the service manager.- Parameters:
- logger- for the connection to the service manager.
 
 - 
getServerVersionGDSServerVersion getServerVersion() throws java.sql.SQLException Obtains the server version through a service call.- Returns:
- Parsed server version, or GDSServerVersion.INVALID_VERSIONif parsing failed.
- Throws:
- java.sql.SQLException- For errors connecting to the service manager.
 
 
- 
 
-