com.intel.gpe.clients.api.workflow
Interface GPEWorkflowJob

All Superinterfaces:

Job, JSDLJob, WorkflowJob

public interface GPEWorkflowJob
extends WorkflowJob

The extension of WorkflowJob with factory methods for creating some workflow actions. Each GPEWorkflowJob has associated workflow and its root action.

Version:

$Id: GPEWorkflowJob.java,v 1.18 2006/11/24 14:05:47 lukichev Exp $

Author:

Alexander Lukichev

Method Summary

Action	getAction() Get the root action.
javax.xml.namespace.QName	getExecutionJSDLPropertyName() Get the QName of the jms:ExecutionJSDL property
java.lang.String	getJobManagementNS() Get the namespace of the atomic job management service
javax.xml.namespace.QName	getJobManagementPortType() Get the QName of the JobManagement port type
javax.xml.namespace.QName	getJobStatusPropertyName() Get the QName of the jms:Status resource property of the JobManagement resource
java.lang.String	getJSDLNS() Get the JSDL namespace
Variable	getStatusVariable() Get the variable which is used to store the status of the GPEWorkflowJob
java.lang.String	getTargetSystemNS() Get the namespace of the atomic target system service
javax.xml.namespace.QName	getTargetSystemPortType() Get the QName of the TargetSystem port type
javax.xml.namespace.QName	getTargetSystemReferencePropertyName() Get the QName of the jms:TargetSystemReference property
java.lang.String	getUnigridsNS() Get the unigrids namespace
Workflow	getWorkflow() Get the workflow.
javax.xml.namespace.QName	getWorkingDirectoryReferencePropertyName() Get the QName of jms:WorkingDirectoryReference property
AtomicJob	newAtomicJob(JSDLJob job, java.util.Calendar initialTerminationTime, PartnerLink targetSystem, com.intel.gpe.util.xml.Namespaces namespaces) Create the AtomicJob action.
GPEJob	newAtomicJobDefinition(java.lang.String jobDefinition) Return the job definition template of the certain job definition type.
DataStagingSetup	newDataStagingSetup(java.util.List<java.lang.String> protocols, com.intel.gpe.util.xml.Namespaces namespaces) Create the data staging setup object that will query storage resources for the listed protocols
DataStagingSetup	newDataStagingSetup(com.intel.gpe.util.xml.Namespaces namespaces) Create the data staging setup object that will query storage resources for all protocols supported by the client
Destroy	newDestroy(PartnerLink resource, com.intel.gpe.util.xml.Namespaces namespaces) Create the Destroy action.
FileImport	newFileImport(PartnerLink storage, java.lang.String protocol, java.lang.String file, com.intel.gpe.util.xml.Namespaces namespaces) Create the FileImport action
GetResourceProperty	newGetResourceProperty(javax.xml.namespace.QName property, PartnerLink resource, Variable response, com.intel.gpe.util.xml.Namespaces namespaces) Create the GetResourceProperty action
GPEJob	newGPEJob() Create the new empty GPEJob
VariableValue	newJobStartRequestValue() Create the variable value containing the StartRequest message
ListDirectory	newListDirectory(PartnerLink storage, Variable directoryPath, Variable includes, Variable excludes, com.intel.gpe.util.xml.Namespaces namespaces) Create the ListDirectory action.
ListFileProperties	newListFileProperties(PartnerLink storage, Variable filePath, Variable gridFile, com.intel.gpe.util.xml.Namespaces namespaces) Create the ListFileProperties action.
Pick.OnMessage	newNotificationHandler(PartnerLink partnerLink, Variable variable, Action body, com.intel.gpe.util.xml.Namespaces namespaces) Create the handler of ws-bn:Notify messages.
PartnerLinkValue	newPartnerLinkValue() Produce new empty PartnerLinkValue object.
PartnerLinkValue	newPartnerLinkValue(WSRFClient client) Produce new PartnerLinkValue object containing the reference to the supplied WSRF resource.
VariableValue	newStatusValue(java.lang.String string) Create the value of type unigrids:StatusType
VariableValue	newSubmitValue(GPEJob jobTemplate, java.util.Calendar terminationTime) Create the value for the SubmitRequest message
VariableValue	newVariableValue() Produce new empty VariableValue object.
VariableValue	newVariableValue(org.w3c.dom.Element value) Produce new VariableValue object containing the supplied element.
VariableValue	newVariableValue(java.lang.String string) Create the variable value containing the supplied string
Workflow	newWorkflow(com.intel.gpe.util.xml.Namespaces namespaces) Create the new Workflow with the supplied namespaces
void	setStatusVariable(Variable var) Set the variable which is used to store the status of the GPEWorkflowJob

Methods inherited from interface com.intel.gpe.clients.api.workflow.WorkflowJob

addPartnerLink, addVariable, addWSDLReference, getVariables, getWSDLReferences, setProcess, setWorkingDirectory

Methods inherited from interface com.intel.gpe.clients.api.jsdl.JSDLJob

addDataStagingExportElement, addDataStagingImportElement, addExtensionElement, getCPUArchitectureRequirements, getDataStagingExportElements, getDataStagingImportElements, getExclusiveExecutionRequirements, getExtensionElement, getId, getIndividualCPUCountRequirements, getIndividualCPUSpeedRequirements, getIndividualDiskSpaceRequirements, getIndividualPhysicalMemoryRequirements, getOperatingSystemRequirements, getTotalCPUCountRequirements, setCPUArchitectureRequirements, setExclusiveExecutionRequirements, setId, setIndividualCPUCountRequirements, setIndividualCPUSpeedRequirements, setIndividualDiskSpaceRequirements, setIndividualPhysicalMemoryRequirements, setOperatingSystemRequirements, setTotalCPUCountRequirements, toByteArray

Method Detail

getWorkflow

Workflow getWorkflow()

Get the workflow.

Returns:

The workflow

getAction

Action getAction()

Get the root action.

Returns:

The root action

newVariableValue

VariableValue newVariableValue()

Produce new empty VariableValue object.

Returns:

The created variable value

newVariableValue

VariableValue newVariableValue(org.w3c.dom.Element value)

Produce new VariableValue object containing the supplied element.

Parameters:

value - The element to put as the value

Returns:

The created variable value

newPartnerLinkValue

PartnerLinkValue newPartnerLinkValue()

Produce new empty PartnerLinkValue object.

Returns:

The created partner link value

newPartnerLinkValue

PartnerLinkValue newPartnerLinkValue(WSRFClient client)

Produce new PartnerLinkValue object containing the reference to the supplied WSRF resource.

Parameters:

client - The GPE client object pointing to the WSRF resource

Returns:

The created partner link value

newWorkflow

Workflow newWorkflow(com.intel.gpe.util.xml.Namespaces namespaces)

Create the new Workflow with the supplied namespaces

Parameters:

namespaces - The initial namespaces collection

Returns:

The created workflow

newGPEJob

GPEJob newGPEJob()

Create the new empty GPEJob

Returns:

The created GPEJob

newSubmitValue

VariableValue newSubmitValue(GPEJob jobTemplate,
                             java.util.Calendar terminationTime)

Create the value for the SubmitRequest message

Parameters:

jobTemplate - The job description to submit

terminationTime - - initial termination time

Returns:

The created variable value

newStatusValue

VariableValue newStatusValue(java.lang.String string)

Create the value of type unigrids:StatusType

Parameters:

string - The value of the status

Returns:

The create variable value

newGetResourceProperty

GetResourceProperty newGetResourceProperty(javax.xml.namespace.QName property,
                                           PartnerLink resource,
                                           Variable response,
                                           com.intel.gpe.util.xml.Namespaces namespaces)

Create the GetResourceProperty action

Parameters:

property - The name of the property

resource - The partner link to the resource

response - The variable where to store the response

namespaces - The namespaces

Returns:

The created action

newJobStartRequestValue

VariableValue newJobStartRequestValue()

Create the variable value containing the StartRequest message

Returns:

The created variable value

getJobManagementPortType

javax.xml.namespace.QName getJobManagementPortType()

Get the QName of the JobManagement port type

Returns:

The qname of the JobManagement port type

getTargetSystemPortType

javax.xml.namespace.QName getTargetSystemPortType()

Get the QName of the TargetSystem port type

Returns:

The qname of the TargetSystem port type

getJobStatusPropertyName

javax.xml.namespace.QName getJobStatusPropertyName()

Get the QName of the jms:Status resource property of the JobManagement resource

Returns:

The qname of the jms:Status resource property

getTargetSystemNS

java.lang.String getTargetSystemNS()

Get the namespace of the atomic target system service

Returns:

The namespace of the TSS

getJobManagementNS

java.lang.String getJobManagementNS()

Get the namespace of the atomic job management service

Returns:

The namespace of the JMS

getUnigridsNS

java.lang.String getUnigridsNS()

Get the unigrids namespace

Returns:

The unigrids namespace

newVariableValue

VariableValue newVariableValue(java.lang.String string)

Create the variable value containing the supplied string

Parameters:

string - The string

Returns:

The created variable value

newDataStagingSetup

DataStagingSetup newDataStagingSetup(com.intel.gpe.util.xml.Namespaces namespaces)

Create the data staging setup object that will query storage resources for all protocols supported by the client

Parameters:

namespaces - The namespaces

Returns:

The created object

newDataStagingSetup

DataStagingSetup newDataStagingSetup(java.util.List<java.lang.String> protocols,
                                     com.intel.gpe.util.xml.Namespaces namespaces)

Create the data staging setup object that will query storage resources for the listed protocols

Parameters:

protocols - The protocols to query

namespaces - The namespaces

Returns:

The created object

newDestroy

Destroy newDestroy(PartnerLink resource,
                   com.intel.gpe.util.xml.Namespaces namespaces)

Create the Destroy action.

Parameters:

resource - The partner link to the resource to be destroyed

namespaces - The namespaces

newAtomicJob

AtomicJob newAtomicJob(JSDLJob job,
                       java.util.Calendar initialTerminationTime,
                       PartnerLink targetSystem,
                       com.intel.gpe.util.xml.Namespaces namespaces)
                       throws java.lang.Exception

Create the AtomicJob action.

Parameters:

job - The definition of the job

initialTerminationTime - The initial termination time for the created job resource

targetSystem - The target system where to submit the job to

namespaces - The currently defined namespaces

Throws:

java.lang.Exception

newAtomicJobDefinition

GPEJob newAtomicJobDefinition(java.lang.String jobDefinition)

Return the job definition template of the certain job definition type.

Parameters:

jobDefinition - The job definition type

Returns:

The job definition template

newListFileProperties

ListFileProperties newListFileProperties(PartnerLink storage,
                                         Variable filePath,
                                         Variable gridFile,
                                         com.intel.gpe.util.xml.Namespaces namespaces)

Create the ListFileProperties action.

Parameters:

storage - The storage management resource

filePath - The variable in which the path to the remote file is stored

gridFile - The variable where to store the returned GridFile structure

namespaces - The namespaces

newListDirectory

ListDirectory newListDirectory(PartnerLink storage,
                               Variable directoryPath,
                               Variable includes,
                               Variable excludes,
                               com.intel.gpe.util.xml.Namespaces namespaces)

Create the ListDirectory action.

Parameters:

storage - The partner link to the storage resource

directoryPath - The variable in which the path to the remote directory is stored

mask - The mask to filter files

namespaces - The namespaces

setStatusVariable

void setStatusVariable(Variable var)

Set the variable which is used to store the status of the GPEWorkflowJob

Parameters:

var - The variable to store the status

getStatusVariable

Variable getStatusVariable()

Get the variable which is used to store the status of the GPEWorkflowJob

Returns:

The variable in which the status is stored

newNotificationHandler

Pick.OnMessage newNotificationHandler(PartnerLink partnerLink,
                                      Variable variable,
                                      Action body,
                                      com.intel.gpe.util.xml.Namespaces namespaces)

Create the handler of ws-bn:Notify messages. See also Pick.

Parameters:

partnerLink - the partner link that is used to receive the notification

variable - the variable where the received message is stored

body - the actions executed after a message is received

namespaces - the namespaces

Returns:

the created handler

newFileImport

FileImport newFileImport(PartnerLink storage,
                         java.lang.String protocol,
                         java.lang.String file,
                         com.intel.gpe.util.xml.Namespaces namespaces)

Create the FileImport action

Parameters:

storage - The storage management resource

protocol - The protocol

file - The file path

namespaces - The namespaces

Returns:

getExecutionJSDLPropertyName

javax.xml.namespace.QName getExecutionJSDLPropertyName()

Get the QName of the jms:ExecutionJSDL property

Returns:

the qname of the jms:ExecutionJSDL property

getTargetSystemReferencePropertyName

javax.xml.namespace.QName getTargetSystemReferencePropertyName()

Get the QName of the jms:TargetSystemReference property

Returns:

the qname of the jms:TargetSystemReference property

getJSDLNS

java.lang.String getJSDLNS()

Get the JSDL namespace

Returns:

the JSDL namespace

getWorkingDirectoryReferencePropertyName

javax.xml.namespace.QName getWorkingDirectoryReferencePropertyName()

Get the QName of jms:WorkingDirectoryReference property

Returns:

the qname of the jms:WorkingDirectoryReference property