org.exist.xmldb
Interface DatabaseInstanceManager

All Superinterfaces:

org.xmldb.api.base.Configurable, org.xmldb.api.base.Service

All Known Implementing Classes:

LocalDatabaseInstanceManager, RemoteDatabaseInstanceManager

public interface DatabaseInstanceManager
extends org.xmldb.api.base.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 Summary

boolean	enterServiceMode()
void	exitServiceMode()
DatabaseStatus	getStatus()
boolean	isLocalInstance() Returns true if the database instance is running local, i.e.
boolean	isXACMLEnabled() Returns true if XACML is enabled for the database instance.
void	shutdown() Immediately shutdown the current database instance.
void	shutdown(long delay) Shutdown the current database instance after the specified delay (in milliseconds).

Methods inherited from interface org.xmldb.api.base.Service

getName, getVersion, setCollection

Methods inherited from interface org.xmldb.api.base.Configurable

getProperty, setProperty

Method Detail

shutdown

void shutdown()
              throws org.xmldb.api.base.XMLDBException

Immediately shutdown the current database instance. This current user should be a member of the "dba" group or an exception will be thrown.

Throws:

org.xmldb.api.base.XMLDBException

shutdown

void shutdown(long delay)
              throws org.xmldb.api.base.XMLDBException

Shutdown the current database instance after the specified delay (in milliseconds). This current user should be a member of the "dba" group or an exception will be thrown.

Throws:

org.xmldb.api.base.XMLDBException

enterServiceMode

boolean enterServiceMode()
                         throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

exitServiceMode

void exitServiceMode()
                     throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

getStatus

DatabaseStatus getStatus()
                         throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

isLocalInstance

boolean isLocalInstance()

Returns true if the database instance is running local, i.e. in the same thread as this service.

Returns:

true if the database instance is running local

isXACMLEnabled

boolean isXACMLEnabled()
                       throws org.xmldb.api.base.XMLDBException

Returns true if XACML is enabled for the database instance.

Returns:

True if XACML is enabled

Throws:

org.xmldb.api.base.XMLDBException