org.exist.xmldb.DatabaseInstanceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation

eXist-db NoSQL Database Core

There is a newer version: 6.3.0

package org.exist.xmldb;

import org.xmldb.api.base.Service;
import org.xmldb.api.base.XMLDBException;

/**
 * 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.
 * 
 */
public interface DatabaseInstanceManager extends Service {
	
	/**
	 * 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 if an error occurs during shutdown.
	 */
	void shutdown() 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.
	 *
	 * @param delay the period in ms to wait before shutting down
	 *
	 * @throws XMLDBException if an error occurs during shutdown.
	 */
	void shutdown(long delay) throws XMLDBException;

    boolean enterServiceMode() throws XMLDBException;

    void exitServiceMode() throws XMLDBException;
    
    DatabaseStatus getStatus() throws XMLDBException;
	
	/**
	 * Returns true if the database instance is running local, i.e. in
	 * the same thread as this service.
	 *
	 * @return true if the database instance is running local
	 */
	boolean isLocalInstance();
}