Module org.firebirdsql.jaybird
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 Details

    • setDatabase

      void setDatabase(String database)
      Sets the database path for the connection to the service manager.

      Will also set the expectedDb property. 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(since="5", forRemoval=true) String getHost()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use AttachmentProperties.getServerName(); will be removed in Jaybird 6 or later
      Returns the host for the connection to the service manager.
      Returns:
      the host for the connection to the service manager.

    • setHost

      @Deprecated(since="5", forRemoval=true) void setHost(String host)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use AttachmentProperties.setServerName(String); will be removed in Jaybird 6 or later
      Sets 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(since="5", forRemoval=true) int getPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use AttachmentProperties.getPortNumber(); will be removed in Jaybird 6 or later
      Returns the port for the connection to the service manager.
      Returns:
      the port for the connection to the service manager.

    • setPort

      @Deprecated(since="5", forRemoval=true) void setPort(int port)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use AttachmentProperties.setPortNumber(int); will be removed in Jaybird 6 or later
      Sets 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

      void setWireCryptAsEnum(WireCrypt wireCrypt)
      Set the wire encryption level.
      Parameters:
      wireCrypt - Wire encryption level (null not 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

      void setLogger(OutputStream logger)
      Sets the logger for the connection to the service manager.
      Parameters:
      logger - for the connection to the service manager.

    • setServiceRequestCustomizer

      void setServiceRequestCustomizer(@Nullable ServiceRequestCustomizer customizer)
      Sets a service request customizer on this service manager. This replaces any previously set customizer.

      The customizer is called just before the request is sent to the server, allowing users to modify the request.

      If you set a customizer to access a feature not implemented by Jaybird, please consider creating an improvement ticket on the Jaybird GitHub repository as well.

      Parameters:
      customizer - service request customizer, null to remove a previous customizer
      Since:
      6.0.5
      See Also:

    • getServiceRequestCustomizer

      @Nullable ServiceRequestCustomizer getServiceRequestCustomizer()
      Returns:
      service request customizer, null if none set
      Since:
      6.0.5
      See Also:

    • getServerVersion

      GDSServerVersion getServerVersion() throws SQLException
      Obtains the server version through a service call.
      Returns:
      Parsed server version, or GDSServerVersion.INVALID_VERSION if parsing failed.
      Throws:
      SQLException - For errors connecting to the service manager.