org.pasoa.common
Interface PlugIn

All Known Implementing Classes:
ProvenanceQueryPlugin, RecordPlugIn, XPathPlugIn, XQueryPlugIn

public interface PlugIn

A PlugIn process a DOM Document using the StorageSystem and returns an appropriate Document either containing a result document or an error message. Exceptions should only be thrown when fatal. A PlugIn should make every effort to handle problems and return appropriate error messages. PlugIns are expected to be thread safe. i.e. a plug in should be expect to be called from multiple threads.

Author:
Paul Groth pg03r@ecs.soton.ac.uk

Method Summary
 Map getConfiguration()
           
 String getDefaultResponse()
          This method should only be used when the PlugIn receives dispatches asynchrounsly.
 void initialize(Map configuration)
          At least the following values are present in all plug-in configurations: The provenance service URL, with key org.pasoa.common.Constants.PROVENANCE_STORE_URL
 Document process(Document document, StorageSystem ss)
           
 boolean receiveDispatchesSyncronously()
           
 

Method Detail

getConfiguration

Map getConfiguration()

initialize

void initialize(Map configuration)
At least the following values are present in all plug-in configurations:


process

Document process(Document document,
                 StorageSystem ss)
                 throws Exception
Throws:
Exception

receiveDispatchesSyncronously

boolean receiveDispatchesSyncronously()

getDefaultResponse

String getDefaultResponse()
This method should only be used when the PlugIn receives dispatches asynchrounsly.

Returns: