XMLDBCommandActivity (OGSA-DAI -- (c) International Business Machines Corporation, 2002-2006, The University of Edinburgh, 2002-2006)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.activity.xmldb
Class XMLDBCommandActivity

java.lang.Object
  |
  +--uk.org.ogsadai.activity.Activity
        |
        +--uk.org.ogsadai.activity.xmldb.XMLDBActivity
              |
              +--uk.org.ogsadai.activity.xmldb.XMLDBCommandActivity

Direct Known Subclasses:: XMLCollectionManagementActivity, XMLResourceManagementActivity

public abstract class XMLDBCommandActivity
extends XMLDBActivity

This XMLDBActivity is designed to execute a single Command. A CommandFactory is used to construct a Command that corresponds to a certain Element.

Author:: The OGSA-DAI Project Team

Field Summary
`private static java.lang.String`	`COPYRIGHT_NOTICE` Copyright statement
`private static DAILogger`	`LOG` Logger object for logging in this class
`private Command`	`mCommand` The command that will be executed when the activity is processed.

Fields inherited from class uk.org.ogsadai.activity.xmldb.XMLDBActivity

mDataResource, mOutput, mSubCollectionName, mUserCredentials

Fields inherited from class uk.org.ogsadai.activity.Activity

mContext, mExternalInputs, mExternalOutputs, mInternalInputs, mInternalOutputs

Constructor Summary
`XMLDBCommandActivity(org.w3c.dom.Element element, CommandFactory factory)` Constructs a `CommandActivity` using the specified element and command factory.

Method Summary
`void`	`processBlock()` Performs an iteration of the processing of an activity.

Methods inherited from class uk.org.ogsadai.activity.xmldb.XMLDBActivity

initialise

Methods inherited from class uk.org.ogsadai.activity.Activity

cleanUp, connectsTo, createOutputPipe, getActivityConfiguration, getActivityName, getCause, getName, getObservableStatus, getProperties, getSession, getStatus, hasActivityConfiguration, hasProperties, process, processFirst, setActivityName, setCompleted, setError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

See Also:: Constant Field Values

LOG

private static final DAILogger LOG

Logger object for logging in this class

mCommand

private final Command mCommand

The command that will be executed when the activity is processed.

Constructor Detail

XMLDBCommandActivity

public XMLDBCommandActivity(org.w3c.dom.Element element,
                            CommandFactory factory)
                     throws ActivitySpecificationException,
                            ActivityCreationException

Constructs a CommandActivity using the specified element and command factory.
Parameters:: element - XML fragment specifying the activity.; factory - XMLDB command factory for generating XMLDB command objects.
Throws:: ActivityCreationException - If there is a problem constructing the activity due to an implementation error or OGSA-DAI confguration problem.; ActivitySpecificationException - If there is a problem constructing the activity due to an invalid setting in element. mistake such as an invalid setting.

Method Detail

processBlock

public final void processBlock()

Description copied from class: Activity

Performs an iteration of the processing of an activity. This may involve reading a block of input data and writing a block of output data, or may involve some other kind of processing. When an activity is processed by the OGSA-DAI engine, this method will be invoked repeatedly until the activity either completes or stops due to an error or termination call. An implementation of this method should invoke the setCompleted method to indicate that processing is complete, or the setError method if an error occurs that will prevent the processing from completing.