edu.isi.pegasus.planner.provenance.pasoa.pps

Class Pasoa

java.lang.Object

edu.isi.pegasus.planner.provenance.pasoa.pps.Pasoa

All Implemented Interfaces:

PPS

public class Pasoa
extends Object
implements PPS

Implements the PPS interface for recording documentation from a Pegasus refinement.

Field Summary

Fields

Modifier and Type	Field and Description
private DocumentBuilder	_builder A pre-created DOM XML parser (expensive to create so we do just once)
private org.pasoa.pstructure.InteractionKey	_causeKey
static String	_clusteredRelation
static String	_clusterParameter
private org.pasoa.pstructure.InteractionKey	_effectKey
static String	_identicalParameter
static String	_identicalRelation The identicalTo relationship relates a workflow node before and after a refinement that has not changed during that refinement
static String	_inClusterParameter
private String	_refinement
private String	_refinementID
static String	_registrationOfParameter
static String	_registrationParameter
static String	_registrationRelation
private int	_relationshipPAssertionCounter
static String	_siteSelectionInputParameter The job before site selection plays the 'preselection' role.
static String	_siteSelectionOutputParameter The job after site selection plays the 'postselection' role.
static String	_siteSelectionRelation The site seleciotn relationship relates a job that has had its site selected to that same job before site selection.
static String	_stagedForParameter
static String	_stagingParameter
static String	_stagingRelation
private org.pasoa.storeclient.ClientLib	_storeProxy ClientLib is the primary class by which a client communicates with a provenance store
private URL	_storeRecordURL The URL of the provenance store Web Service (recording port)
private static String	_workflowPostfix A partially refined workflow is specified as an XML document.
private String	_workflowXML
private static String	_xmlFooter

Fields inherited from interface edu.isi.pegasus.planner.provenance.pasoa.PPS

NAMESPACE, PEGASUS, REFINEMENT_CLUSTER, REFINEMENT_REDUCE, REFINEMENT_REGISTER, REFINEMENT_SITE_SELECT, REFINEMENT_STAGE

Constructor Summary

Constructors

Constructor and Description
Pasoa() On initialisation, create a ClientLib object for communication with a store, set the store URL and create a namespace-aware DOM document parser.
Pasoa(String storeURL) On initialisation, create a ClientLib object for communication with a store, set the store URL and create a namespace-aware DOM document parser.

Method Summary

Methods

Modifier and Type	Method and Description
static Element	addressToElement(String address) Conventionally, we use WS-Addressing to identify the endpoints of an interaction between actors, and this method constructs an XML (DOM) fragment in the WS-Addressing schema for a particular URL.
String	beginWorkflowRefinementStep(Refiner workflow, String refinementStepName, boolean firstStep)
void	clusteringOf(String clusteredJob, List jobs)
Element	createDataAccessor(String jobID) Individual jobs in a workflow are identified by an XML document fragment, called a data accessor, and this method constructs the fragment for a given job ID.
org.pasoa.pstructure.InteractionKey	createInteractionKey(String refinementID, String refinementAddress, boolean preRefinement) Creates an interaction key to identify an interaction between two actors.
org.pasoa.pstructure.InteractionPAssertion	createInteractionPAssertion(String workflow) Creates an interaction p-assertion asserting that a given partially refined workflow was exchanged between actors.
org.pasoa.pstructure.RelationshipPAssertion	createRelationship(int count, String effectJobID, String effectParameter, String relationType, org.pasoa.pstructure.InteractionKey causeKey, String causeJobID, String causeParameter) Creates a relationship p-assertion between nodes in two partially refined workflows.
void	endWorkflowRefinementStep(Refiner workflow)
void	isIdenticalTo(String afterNode, String beforeNode)
void	isPartitionOf(String afterNode, List beforeNode)
void	record(org.pasoa.pstructure.PAssertion passertion, org.pasoa.pstructure.InteractionKey interactionKey, boolean isSender, String asserterURL)
void	recordInteraction(org.pasoa.pstructure.InteractionPAssertion passertion, org.pasoa.pstructure.InteractionKey interactionKey, String refinerType, boolean refinementInput)
void	recordInteraction(String workflow, org.pasoa.pstructure.InteractionKey interactionKey, String refinerType, boolean refinementInput)
org.pasoa.pstructure.RelationshipPAssertion	recordRelationship(int count, String effectJobID, String effectParameter, String relationType, org.pasoa.pstructure.InteractionKey causeKey, String causeJobID, String causeParameter, String asserterURL)
void	registrationIntroducedFor(String registrationNode, String dataStagingNode)
void	siteSelectionFor(String afterNode, String beforeNode)
void	stagingIntroducedFor(List stagingNodes, String appNode)
Element	toElement(String xmlAsString) Convenience method to parse string represented XML into a DOM XML fragment representation

Methods inherited from class java.lang.Object

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

Field Detail

_workflowXML

private String _workflowXML

_relationshipPAssertionCounter

private int _relationshipPAssertionCounter

_causeKey

private org.pasoa.pstructure.InteractionKey _causeKey

_effectKey

private org.pasoa.pstructure.InteractionKey _effectKey

_refinement

private String _refinement

_refinementID

private String _refinementID

_xmlFooter

private static final String _xmlFooter

See Also:

Constant Field Values

_identicalRelation

public static final String _identicalRelation

The identicalTo relationship relates a workflow node before and after a refinement that has not changed during that refinement

See Also:

Constant Field Values

_identicalParameter

public static final String _identicalParameter

See Also:

Constant Field Values

_siteSelectionRelation

public static final String _siteSelectionRelation

The site seleciotn relationship relates a job that has had its site selected to that same job before site selection.

See Also:

Constant Field Values

_siteSelectionInputParameter

public static final String _siteSelectionInputParameter

The job before site selection plays the 'preselection' role.

See Also:

Constant Field Values

_siteSelectionOutputParameter

public static final String _siteSelectionOutputParameter

The job after site selection plays the 'postselection' role.

See Also:

Constant Field Values

_stagingRelation

public static final String _stagingRelation

See Also:

Constant Field Values

_stagedForParameter

public static final String _stagedForParameter

See Also:

Constant Field Values

_stagingParameter

public static final String _stagingParameter

See Also:

Constant Field Values

_registrationRelation

public static final String _registrationRelation

See Also:

Constant Field Values

_registrationOfParameter

public static final String _registrationOfParameter

See Also:

Constant Field Values

_registrationParameter

public static final String _registrationParameter

See Also:

Constant Field Values

_clusteredRelation

public static final String _clusteredRelation

See Also:

Constant Field Values

_inClusterParameter

public static final String _inClusterParameter

See Also:

Constant Field Values

_clusterParameter

public static final String _clusterParameter

See Also:

Constant Field Values

_workflowPostfix

private static final String _workflowPostfix

A partially refined workflow is specified as an XML document. We represent this as a String object, and for convenience this is the closing tag of that document.

See Also:

Constant Field Values

_storeProxy

private org.pasoa.storeclient.ClientLib _storeProxy

ClientLib is the primary class by which a client communicates with a provenance store

_storeRecordURL

private URL _storeRecordURL

The URL of the provenance store Web Service (recording port)

_builder

private DocumentBuilder _builder

A pre-created DOM XML parser (expensive to create so we do just once)

Constructor Detail

Pasoa

public Pasoa()
      throws Exception

On initialisation, create a ClientLib object for communication with a store, set the store URL and create a namespace-aware DOM document parser.

Throws:

Exception

Pasoa

public Pasoa(String storeURL)
      throws Exception

On initialisation, create a ClientLib object for communication with a store, set the store URL and create a namespace-aware DOM document parser.

Throws:

Exception

Method Detail

beginWorkflowRefinementStep

public String beginWorkflowRefinementStep(Refiner workflow,
                                 String refinementStepName,
                                 boolean firstStep)
                                   throws Exception

Specified by:

beginWorkflowRefinementStep in interface PPS

Returns:

The ID used for the whole refinement process of this workflow

Throws:

Exception

isIdenticalTo

public void isIdenticalTo(String afterNode,
                 String beforeNode)
                   throws Exception

Specified by:

isIdenticalTo in interface PPS

Throws:

Exception

siteSelectionFor

public void siteSelectionFor(String afterNode,
                    String beforeNode)
                      throws Exception

Specified by:

siteSelectionFor in interface PPS

Throws:

Exception

stagingIntroducedFor

public void stagingIntroducedFor(List stagingNodes,
                        String appNode)
                          throws Exception

Specified by:

stagingIntroducedFor in interface PPS

Throws:

Exception

registrationIntroducedFor

public void registrationIntroducedFor(String registrationNode,
                             String dataStagingNode)
                               throws Exception

Specified by:

registrationIntroducedFor in interface PPS

Throws:

Exception

clusteringOf

public void clusteringOf(String clusteredJob,
                List jobs)
                  throws Exception

Specified by:

clusteringOf in interface PPS

Throws:

Exception

isPartitionOf

public void isPartitionOf(String afterNode,
                 List beforeNode)

Specified by:

isPartitionOf in interface PPS

endWorkflowRefinementStep

public void endWorkflowRefinementStep(Refiner workflow)
                               throws Exception

Specified by:

endWorkflowRefinementStep in interface PPS

Throws:

Exception

addressToElement

public static Element addressToElement(String address)

Conventionally, we use WS-Addressing to identify the endpoints of an interaction between actors, and this method constructs an XML (DOM) fragment in the WS-Addressing schema for a particular URL.

Parameters:

address - The URL of the endpoint

Returns:

An XML (DOM) fragment in WS-Addressing endpoint schema containing the address

createDataAccessor

public Element createDataAccessor(String jobID)
                           throws IOException,
                                  SAXException

Individual jobs in a workflow are identified by an XML document fragment, called a data accessor, and this method constructs the fragment for a given job ID.

Parameters:

jobID - The job ID

Returns:

An XML (DOM) fragment representing a reference to that job in an XML workflow representation

Throws:

IOException

SAXException

createInteractionPAssertion

public org.pasoa.pstructure.InteractionPAssertion createInteractionPAssertion(String workflow)
                                                                       throws IOException,
                                                                              SAXException

Creates an interaction p-assertion asserting that a given partially refined workflow was exchanged between actors.

Parameters:

workflow - The (XML) content of the partially refined workflow

Returns:

A JavaBean representation of an interaction p-assertion containing the workflow

Throws:

IOException

SAXException

createInteractionKey

public org.pasoa.pstructure.InteractionKey createInteractionKey(String refinementID,
                                                       String refinementAddress,
                                                       boolean preRefinement)

Creates an interaction key to identify an interaction between two actors.

Parameters:

refinementID - The unique identifier for this workflow refinement (run of Pegasus)

refinementAddress - The URI of the particular refinement step (site selection, cluster etc.)

preRefinement - True if the interaction is pre-refinement, i.e. from Pegasus to a refiner, rather than the other way round

createRelationship

public org.pasoa.pstructure.RelationshipPAssertion createRelationship(int count,
                                                             String effectJobID,
                                                             String effectParameter,
                                                             String relationType,
                                                             org.pasoa.pstructure.InteractionKey causeKey,
                                                             String causeJobID,
                                                             String causeParameter)
                                                               throws IOException,
                                                                      SAXException

Creates a relationship p-assertion between nodes in two partially refined workflows.

Parameters:

count - The index of this relationship p-assertion in the interaction (to support the requirement that each p-assertion has a unique ID)

effectJobID - The job ID of the subject (effect) of the relationship

effectParameter - The role played by the subject of the relationship

relationType - The type of the relationship

causeKey - The interaction key of the object of the relationship

causeJobID - The job ID of the object (cause) of the relationship

causeParameter - The role played by the object of the relationship

Returns:

A RelationshipPAssertion JavaBean representing the relationship p-assertion with the given arguments

Throws:

IOException

SAXException

record

public void record(org.pasoa.pstructure.PAssertion passertion,
          org.pasoa.pstructure.InteractionKey interactionKey,
          boolean isSender,
          String asserterURL)
            throws Exception

Throws:

Exception

recordInteraction

public void recordInteraction(org.pasoa.pstructure.InteractionPAssertion passertion,
                     org.pasoa.pstructure.InteractionKey interactionKey,
                     String refinerType,
                     boolean refinementInput)
                       throws Exception

Throws:

Exception

recordInteraction

public void recordInteraction(String workflow,
                     org.pasoa.pstructure.InteractionKey interactionKey,
                     String refinerType,
                     boolean refinementInput)
                       throws Exception

Throws:

Exception

recordRelationship

public org.pasoa.pstructure.RelationshipPAssertion recordRelationship(int count,
                                                             String effectJobID,
                                                             String effectParameter,
                                                             String relationType,
                                                             org.pasoa.pstructure.InteractionKey causeKey,
                                                             String causeJobID,
                                                             String causeParameter,
                                                             String asserterURL)
                                                               throws Exception

Throws:

Exception

toElement

public Element toElement(String xmlAsString)
                  throws IOException,
                         SAXException

Convenience method to parse string represented XML into a DOM XML fragment representation

Throws:

IOException

SAXException