|
XML:DB API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Database
is an encapsulation of the database driver
functionality that is
necessary to access an XML database. Each vendor must provide their own
implmentation of the Database
interface. The implementation
is registered with the
DatabaseManager
to provide access to the resources of the XML database.
Database
implementations directly during initialization.
Method Summary | |
boolean |
acceptsURI(java.lang.String uri)
acceptsURI determines whether this Database implementation
can handle the URI. |
Collection |
getCollection(java.lang.String uri,
java.lang.String username,
java.lang.String password)
Retrieves a Collection instance based on the URI provided
in the uri parameter. |
java.lang.String |
getConformanceLevel()
Returns the XML:DB API Conformance level for the implementation. |
java.lang.String |
getName()
Deprecated. Replaced by String[] getNames(). |
java.lang.String[] |
getNames()
Returns an array of names associated with the Database instance. |
Methods inherited from interface org.xmldb.api.base.Configurable |
getProperty, setProperty |
Method Detail |
public java.lang.String getName() throws XMLDBException
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String[] getNames() throws XMLDBException
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public Collection getCollection(java.lang.String uri, java.lang.String username, java.lang.String password) throws XMLDBException
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.
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.
Collection
instance for the requested collection or
null if the collection could not be found.
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.public boolean acceptsURI(java.lang.String uri) throws XMLDBException
Database
implementation
can handle the URI. It should return true
if the Database instance knows how to handle the URI and false otherwise.
uri
- the URI to check for.
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. public java.lang.String getConformanceLevel() throws XMLDBException
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
|
XML:DB API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |