Activity - xmlResourceManagement

Activity Type: XML

Description

Run XMLDB resource management operations on XMLDB data resources. XMLDB resources are XML documents which are stored within XMLDB collections (not to be confused with an XMLDB data resource itself or data service resources). The following operations are supported:

Create new XMLDB resources.
Remove existing XMLDB resources.
List existing XMLDB resources.

Examples

<xmlResourceManagement name="statement">
  <collection>musicians/folksingers</collection>
  <createResource name="newResource">
    <entry xmlns="http://folksingers/contact-details">
      <name>Smithers-Jones</name>
      <address>12 Mill Hill East, London</address>
      <phone>02636328605</phone>
    </entry>
  </createResource>
  <outputStream name="statementOutput"/>
</xmlResourceManagement>

<xmlResourceManagement name="statement">
  <createResource name="newResource" from="someActivityOutput"/>
  <outputStream name="statementOutput"/>
</xmlResourceManagement>

<xmlResourceManagement name="statement">
  <removeResource name="someResource"/>
  <outputStream name="statementOutput"/>
</xmlResourceManagement>

<xmlResourceManagement name="statement">
  <listResources/>
  <outputStream name="statementOutput"/>
</xmlResourceManagement>

Specification

Element xmlResourceManagement:

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 within.
- Relative to the data resource's base collection.
- For example, if a data resource is configured for the db/littleblackbook collection then the first example would perform the operations on the db/littleblackbook/musicians/folksingers collection.
- If this element is omitted then the operations will be performed on the base collection for the data resource, e.g. for the second to fourth examples, db/littleblackbook.
One of three operation elements:
- Element createResource - create a new XMLDB resource:
  - Attribute name - name of the new XMLDB resource. If omitted then a new name will be generated automatically.
  - Either an attribute specifying where to find the XMLDB resource content or the XMLDB resource content itself:
    - XML content for the new XMLDB resource e.g. the first example above.
    - Attribute from - name of an input stream providing the contents of the new XMLDB resource e.g. the second example above.
- Element listResources - list the XMLDB resources in the current collection.
- Element removeResource - remove an existing XMLDB resource.
  - Attribute name - name of the XMLDB resource to remove.
outputStream (required) - output stream.
- Attribute name - name of the activity's output stream.

Input and Output Types

Input: createResource (optional input) — one or more blocks of type java.lang.String. Together these blocks specify an XML element, for example:
```
<entry>
  <name>Yanick McTavish</name>
  <address>23 Somewhere Street</address>
  <phone>45645456</phone>
</entry>
```
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 XMLDB resources — the following format is used:
```
<createdResource name="RESOURCE"/>
```
  where RESOURCE is the name of the newly created resource.
- Remove existing XMLDB resources — the following format is used:
```
<removedResource name="RESOURCE"/>
```
  where RESOURCE is the name of the removed resource.
- List existing XMLDB resources — the following format is used:
```
<resourceNames count="N">
  <name>NAME1</name>
  <name>NAME2</name>
  ....
</resourceNames>
```
  where N is the number of resources and NAME1, NAME2 etc. are the names of the resources.

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_resource_management.xsd

Class

uk.org.ogsadai.activity.xmldb.XMLResourceManagementActivity

Client Toolkit Classes

uk.org.ogsadai.client.toolkit.activity.xmldb.XMLCreateResource uk.org.ogsadai.client.toolkit.activity.xmldb.XMLCreateResourceFromActivityOutput uk.org.ogsadai.client.toolkit.activity.xmldb.XMLListResources uk.org.ogsadai.client.toolkit.activity.xmldb.XMLRemoveResource