Activity - xmlCollectionManagement

Activity Type: XML

Description

Run collection management operations on XMLDB data resources. The following operations are supported:

• Create new collections.
• Remove existing collections.
• List existing collections.

Examples

<xmlCollectionManagement name="statement">
  <collection>musicians</collection>
  <createCollection name="folksingers"/>
  <outputStream name="statementOutput"/>
</xmlCollectionManagement>

<xmlCollectionManagement name="statement">
  <removeCollection name="jazzsingers"/>;
  <outputStream name="statementOutput"/>
</xmlCollectionManagement>

<xmlCollectionManagement name="statement">
  <<listCollections/>
  <outputStream name="statementOutput"/>
</xmlCollectionManagement>

Specification

Element xmlCollectionManagement:

• Attribute name - unique name for the activity within the scope of a request.
• Element collection (zero or one) - contains the name of the collection that the operations will be performed on.
  • Relative to the data resource's base collection.
  • For example, if a data resource is configured for the db/littleblackbook collection then the above example would perform the operations on the db/littleblackbook/musicians collection.
  • If this element is omitted then the operations will be performed on the base collection for the data resource, e.g. db/littleblackbook.
• One of three operation elements:
  • Element createCollection - create a new collection.
    • Attribute name - name for new collection, unique within the current collection.
  • Element listCollections - list the immediate sub-collections of the current collection.
  • Element removeCollection - remove an existing collection.
    • Attribute name - name of the collection.
• outputStream (required) - output stream.
  • Attribute name - name of the activity's output stream.

Input and Output Types

• Output: outputStream — a single block of type java.lang.String of XML data. The format of this data depends on the operation performed:

  • Create new collections — the following format is used:

    <createdCollection name="COLLECTION"/>
    

    where COLLECTION is the name of the newly created collection.

  • Remove existing collections — the following format is used:

    <removedCollection name="COLLECTION"/>
    

    where COLLECTION is the name of the removed collection.

  • List existing collections — the following format is used:

    <collectionNames count="N">
      <name>NAME1</name>
      <name>NAME2</name>
      ....
      </collectionNames>
    

    where N is the number of collections and NAME1, NAME2 etc. are the names of the collections.

Data Resource Accessor

This activity requires a data resource accessor that implements the following interface: uk.org.ogsadai.dataresource.XMLDBCollectionProvider

Required Libraries

The use of this activity requires the following jar to be loaded on the server:

• xmldb.jar (from eXist build 20051203) — handles access to XML database

XML Schema

OGSA-DAI/schema/ogsadai/xsd/activities/xml_collection_management.xsd

Class

uk.org.ogsadai.activity.xmldb.XMLCollectionManagementActivity

Client Toolkit Classes

uk.org.ogsadai.client.toolkit.activity.xmldb.XMLCreateCollection uk.org.ogsadai.client.toolkit.activity.xmldb.XMLListCollections uk.org.ogsadai.client.toolkit.activity.xmldb.XMLRemoveCollection