org.apache.xindice.client.xmldb.embed
Class DatabaseImpl

java.lang.Object
  org.apache.xindice.client.xmldb.CommonConfigurable
      org.apache.xindice.client.xmldb.embed.DatabaseImpl

All Implemented Interfaces:

org.xmldb.api.base.Configurable, org.xmldb.api.base.Database

Direct Known Subclasses:

DatabaseImpl

public class DatabaseImpl

extends CommonConfigurable

implements org.xmldb.api.base.Database

Implements XML:DB's Database interface providing embedded access to a Xindice database. Usually, this class is not used directly, but DatabaseImpl is used instead. Embedded database driver supports multiple database instances simultaneously. To use multiple instances, configure several root-collection elements in the Xindice configuration file and point this driver to this configuration. Currently, databases are loaded by the driver lazily, on first access to the database. Embedded database driver uses following configuration parameters:

• db-home: Specifies path to the Xindice DB Home directory
• configuration: Specifies path to the Xindice Configuration file
• managed: If set to true, driver will not load databases by himself, but will assume that third party code had initialized the database (See DatabaseImpl)

If one of these parameters is not specified, system properties will be used. Driver parameters can be specified either:

• by instantiating DatabaseImpl and setting its properties (see CommonConfigurable.setProperty(java.lang.String, java.lang.String)). You won't use this class directly in this case.
• by setting parameters via CommonConfigurable.setProperty(java.lang.String, java.lang.String) method before obtaining collection with getCollection(String, String, String) method.
• by setting Java system properties (see System.setProperty(String, String))
• by using constructor DatabaseImpl(CommonConfigurable) and passing instance of CommonConfigurable with all properties already set.

Version:

$Revision: 564998 $, $Date: 2007-08-11 22:51:49 -0400 (Sat, 11 Aug 2007) $

Author:

Kimbro Staken, James Bates, Vladimir R. Bossicard, Vadim Gritsenko

Field Summary

static String	DRIVER_NAME Prefix used to denote XML:DB URI's that should use this driver
static String	PROP_XINDICE_CONFIGURATION Driver property name for the xindice configuration file.
static String	PROP_XINDICE_DB_HOME Driver property name for the xindice database home.
static String	PROP_XINDICE_MANAGED Driver property name for the managed configuration parameter.
static String	SYSPROP_XINDICE_CONFIGURATION System property name for the xindice configuration file.
static String	SYSPROP_XINDICE_DB_HOME System property name for the xindice database home.
static String	SYSPROP_XINDICE_MANAGED System property name for the managed configuration parameter.

Constructor Summary

DatabaseImpl()
Creates new DatabaseImpl instance.

DatabaseImpl(CommonConfigurable config)
Create a new DatabaseImpl object with a copy of the properties from the config parameter.

Method Summary

boolean	acceptsURI(String uri) Determines whether this Database implementation can handle the URI.
org.xmldb.api.base.Collection	getCollection(String uri, String userName, String password) Retrieves a Collection instance based on the URI provided in the uri parameter.
protected Configuration	getConfiguration(String dbName) Get configuration for the named database
String	getConformanceLevel() Returns the XML:DB API Conformance level for the implementation.
String	getName() Returns the prefix used in XML:DB to denote URI's that this driver can handle.
String[]	getNames() Returns an array of names associated with the Database instance.
protected boolean	isManaged()

Methods inherited from class org.apache.xindice.client.xmldb.CommonConfigurable

getProperty, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getProperty, setProperty

Field Detail

PROP_XINDICE_DB_HOME

public static final String PROP_XINDICE_DB_HOME

Driver property name for the xindice database home.

See Also:

Constant Field Values

SYSPROP_XINDICE_DB_HOME

public static final String SYSPROP_XINDICE_DB_HOME

System property name for the xindice database home.

See Also:

Constant Field Values

PROP_XINDICE_CONFIGURATION

public static final String PROP_XINDICE_CONFIGURATION

Driver property name for the xindice configuration file.

See Also:

Constant Field Values

SYSPROP_XINDICE_CONFIGURATION

public static final String SYSPROP_XINDICE_CONFIGURATION

System property name for the xindice configuration file.

See Also:

Constant Field Values

PROP_XINDICE_MANAGED

public static final String PROP_XINDICE_MANAGED

Driver property name for the managed configuration parameter.

See Also:

Constant Field Values

SYSPROP_XINDICE_MANAGED

public static final String SYSPROP_XINDICE_MANAGED

System property name for the managed configuration parameter.

See Also:

Constant Field Values

DRIVER_NAME

public static final String DRIVER_NAME

Prefix used to denote XML:DB URI's that should use this driver

See Also:

Constant Field Values

Constructor Detail

DatabaseImpl

public DatabaseImpl()

Creates new DatabaseImpl instance.

DatabaseImpl

public DatabaseImpl(CommonConfigurable config)

Create a new DatabaseImpl object with a copy of the properties from the config parameter. This allows to pass properties such as PROP_XINDICE_CONFIGURATION to this instance. Usually this is done by instantiating not this class, but DatabaseImpl, set all the necessary parameters, and then get a collection.

Parameters:

config - from which the initial parameters for this DatabaseImpl object are copied.

Method Detail

isManaged

protected boolean isManaged()

getConfiguration

protected Configuration getConfiguration(String dbName)
                                  throws org.xmldb.api.base.XMLDBException

Get configuration for the named database

Parameters:

dbName - Database name

Returns:

Database configuration

Throws:

org.xmldb.api.base.XMLDBException - if unable to load database configuration

acceptsURI

public boolean acceptsURI(String uri)
                   throws org.xmldb.api.base.XMLDBException

Determines whether this Database implementation can handle the URI. It should return true if the Database instance knows how to handle the URI and false otherwise.

Specified by:

acceptsURI in interface org.xmldb.api.base.Database

Parameters:

uri - the URI to check for.

Returns:

true if the URI can be handled, false otherwise.

Throws:

org.xmldb.api.base.XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
ErrroCodes.INVALID_URI If the URI is not in a valid format.


getCollection

public org.xmldb.api.base.Collection getCollection(String uri,
                                                   String userName,
                                                   String password)
                                            throws org.xmldb.api.base.XMLDBException

Retrieves a Collection instance based on the URI provided in the uri parameter. The format of the URI is defined in the documentation for DatabaseManager.getCollection().

Authentication is handled via username and password however it is not required that the database support authentication. Databases that do not support authentication MUST ignore the username and password if those provided are not null.

Specified by:

getCollection in interface org.xmldb.api.base.Database

Parameters:

uri - the URI to use to locate the collection.

password - The password to use for authentication to the database or null if the database does not support authentication.

Returns:

A Collection instance for the requested collection or null if the collection could not be found.

Throws:

org.xmldb.api.base.XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
ErrroCodes.INVALID_URI If the URI is not in a valid format.
ErrroCodes.PERMISSION_DENIED If the username and password were not accepted by the database.

getName

public String getName()
               throws org.xmldb.api.base.XMLDBException

Returns the prefix used in XML:DB to denote URI's that this driver can handle.

Specified by:

getName in interface org.xmldb.api.base.Database

Returns:

the prefix driver name

Throws:

org.xmldb.api.base.XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.


getNames

public String[] getNames()
                  throws org.xmldb.api.base.XMLDBException

Returns an array of names associated with the Database instance.

Specified by:

getNames in interface org.xmldb.api.base.Database

Returns:

the array of name of the object.

Throws:

org.xmldb.api.base.XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.


getConformanceLevel

public String getConformanceLevel()
                           throws org.xmldb.api.base.XMLDBException

Returns the XML:DB API Conformance level for the implementation. This can be used by client programs to determine what functionality is available to them.

Specified by:

getConformanceLevel in interface org.xmldb.api.base.Database

Returns:

the XML:DB API conformance level for this implementation.

Throws:

org.xmldb.api.base.XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.