Class CollectionManagementServiceImpl

java.lang.Object
org.xmldb.api.sdk.SimpleConfigurable
org.xmldb.api.reference.modules.CollectionManagementServiceImpl
All Implemented Interfaces:
Configurable, Service, CollectionManagementService

public class CollectionManagementServiceImpl extends SimpleConfigurable implements CollectionManagementService
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.
  • Constructor Details

    • CollectionManagementServiceImpl

      public CollectionManagementServiceImpl(String basePath)
      Creates a new CollectionManager service
  • Method Details

    • getName

      public String getName()
      Returns the name of the Service
      Specified by:
      getName in interface Service
      Returns:
      the name of the Service
    • getVersion

      public String getVersion()
      Returns the version of the Service
      Specified by:
      getVersion in interface Service
      Returns:
      the version of the Service
    • setCollection

      public void setCollection(Collection col)
      Provides a reference to the XML:DB collection instance that this service is associated with.
      Specified by:
      setCollection in interface Service
      Parameters:
      col - the XML:DB collection instance associated with this Service
    • createCollection

      public Collection createCollection(String name) throws XMLDBException
      Creates a simple collection with a basic default configuration. More complex configuration requires using a proprietary interface
      Specified by:
      createCollection in interface CollectionManagementService
      Parameters:
      name - The name of the collection to create.
      Returns:
      The created Collection instance.
      Throws:
      XMLDBException - with expected error codes.
      ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
    • removeCollection

      public void removeCollection(String name) throws XMLDBException
      Removes the named collection from the system.
      Specified by:
      removeCollection in interface CollectionManagementService
      Parameters:
      name - The name of the collection to remove.
      Throws:
      XMLDBException - with expected error codes.
      ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.