|
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.reference.modules.CollectionManagementServiceImpl
public class CollectionManagementServiceImpl
CollectionManager provides management facilities for a Collection instance. Administrative access is required for retrieval of the CollectionManager interface. User level access is provided through the underlying Collection itself.
Field Summary |
---|
Fields inherited from interface org.xmldb.api.modules.CollectionManagementService |
---|
SERVICE_NAME |
Constructor Summary | |
---|---|
CollectionManagementServiceImpl(java.lang.String basePath)
Creates a new CollectionManager service |
Method Summary | |
---|---|
Collection |
createCollection(java.lang.String name)
Creates a simple collection with a basic default configuration. |
java.lang.String |
getName()
Returns the name of the Service |
java.lang.String |
getVersion()
Returns the version of the Service |
void |
removeCollection(java.lang.String name)
Removes the named collection from the system. |
void |
setCollection(Collection col)
Provides a reference to the XML:DB collection instance that this service is associated with. |
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 CollectionManagementServiceImpl(java.lang.String basePath)
Method Detail |
---|
public java.lang.String getName()
getName
in interface Service
public java.lang.String getVersion()
getVersion
in interface Service
public void setCollection(Collection col)
setCollection
in interface Service
col
- the XML:DB collection instance associated with this Servicepublic Collection createCollection(java.lang.String name) throws XMLDBException
createCollection
in interface CollectionManagementService
name
- The name of the collection to create.
Collection
instance.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void removeCollection(java.lang.String name) throws XMLDBException
removeCollection
in interface CollectionManagementService
name
- The name of the collection to remove.
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 |