|
XML:DB API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xmldb.api.sdk.SimpleConfigurable
org.xmldb.api.sdk.SimpleDatabase
public abstract class SimpleDatabase
Simple Database
implementation intended to be used as a base
class for a specific implementation.
Constructor Summary | |
---|---|
SimpleDatabase()
|
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()
Returns the name associated with the Configurable object. |
java.lang.String[] |
getNames()
Returns an array of names associated with the Database instance. |
Methods inherited from class org.xmldb.api.sdk.SimpleConfigurable |
---|
getProperty, setProperty |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.xmldb.api.base.Configurable |
---|
getProperty, setProperty |
Constructor Detail |
---|
public SimpleDatabase()
Method Detail |
---|
public java.lang.String getName() throws XMLDBException
getName
in interface Database
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String[] getNames() throws XMLDBException
Database
getNames
in interface Database
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. Implementations must override this
method.
getCollection
in interface Database
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
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.
acceptsURI
in interface Database
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
getConformanceLevel
in interface Database
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 |