Interface DatabaseInstanceService

  • All Superinterfaces:
    Configurable, Service

    public interface DatabaseInstanceService
    extends Service
    A service to manage the database instance. The service defines a single method shutdown() to shut down the database instance used by the current driver.
    • Method Detail

      • shutdown

        void shutdown()
               throws XMLDBException
        Immediately shutdown the current database instance. The current user must be a member of the "dba" group or an exception will be thrown. This operation is synchronous and will not return until the database is shutdown
        Throws:
        XMLDBException - with expected error codes. ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
      • shutdown

        void shutdown​(long delay)
               throws XMLDBException
        Shutdown the current database instance after the specified delay (in milliseconds). The current user must be a member of the "dba" group or an exception will be thrown. This operation is asynchronous and the delay is scheduled with the database scheduler.
        Parameters:
        delay - the delay in milliseconds to wait before shutdown
        Throws:
        XMLDBException - with expected error codes. ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
      • isLocalInstance

        boolean isLocalInstance()
        Returns true if the database instance is running local, i.e. in the same thread as this service.
        Returns:
        true on a local instance, false otherwise