org.apache.oodt.cas.pge

Class PGETaskInstance

java.lang.Object

org.apache.oodt.cas.pge.PGETaskInstance

All Implemented Interfaces:

WorkflowTaskInstance

Direct Known Subclasses:

StdPGETaskInstance, WinPGETaskInstance

public class PGETaskInstance
extends Object
implements WorkflowTaskInstance

Runs a CAS-style Product Generation Executive based on the PCS Wrapper Architecture from mattmann et al. on OCO.

Author:

mattmann (Chris Mattmann), bfoster (Brian Foster)

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger
protected PgeConfig	pgeConfig
protected PgeMetadata	pgeMetadata
protected XmlRpcWorkflowManagerClient	wm
protected String	workflowInstId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PGETaskInstance()

Method Summary

Modifier and Type	Method and Description
protected ScriptFile	buildPgeRunScript()
protected void	createDynamicConfigFile(DynamicConfigFile dynamicConfigFile)
protected void	createDynamicConfigFiles()
protected void	createExeDir()
protected String	createLogFileName()
protected Logger	createLogger()
protected void	createOuputDirsIfRequested()
protected PgeConfig	createPgeConfig()
protected PgeMetadata	createPgeMetadata(Metadata dynMetadata, WorkflowTaskConfiguration config)
protected ProductCrawler	createProductCrawler()
protected XmlRpcWorkflowManagerClient	createWorkflowManagerClient()
protected void	dumpMetadataIfRequested()
protected String	getDumpMetadataName()
protected String	getDumpMetadataPath()
protected FileStager	getFileStager()
protected Metadata	getMetadataForFile(File sciPgeCreatedDataFile, PcsMetFileWriter writer, Object[] args)
protected String	getPgeScriptName()
protected File	getScriptPath()
protected String	getWorkflowInstanceId()
protected ConfigFilePropertyAdder	loadPropertyAdder(String propertyAdderClasspath)
protected void	processOutput()
protected File	renameFile(File file, PathUtilsNamingConvention renamingConv)
void	run(Metadata metadata, WorkflowTaskConfiguration config) Runs the Task with the specified metadata context.
protected void	runIngestCrawler(ProductCrawler crawler)
protected void	runPge()
protected void	runPropertyAdder(ConfigFilePropertyAdder propAdder)
protected void	runPropertyAdders()
protected void	stageFiles()
protected void	updateDynamicMetadata()
protected void	updateStatus(String status)
protected void	verifyIngests(ProductCrawler crawler)
protected boolean	wasPgeSuccessful(int returnCode)
protected void	writeFromMetadata(Metadata metadata, String toMetFilePath)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Logger logger

wm

protected XmlRpcWorkflowManagerClient wm

workflowInstId

protected String workflowInstId

pgeMetadata

protected PgeMetadata pgeMetadata

pgeConfig

protected PgeConfig pgeConfig

Constructor Detail

PGETaskInstance

protected PGETaskInstance()

Method Detail

run

public void run(Metadata metadata,
                WorkflowTaskConfiguration config)
         throws WorkflowTaskInstanceException

Description copied from interface: WorkflowTaskInstance

Runs the Task with the specified metadata context.

Specified by:

run in interface WorkflowTaskInstance

Parameters:

metadata - The TaskContext of metadata that is shared between the tasks.

config - The static configuration metadata for this task.

Throws:

WorkflowTaskInstanceException

updateStatus

protected void updateStatus(String status)
                     throws PGEException,
                            org.apache.xmlrpc.XmlRpcException,
                            IOException

Throws:

PGEException

org.apache.xmlrpc.XmlRpcException

IOException

createLogger

protected Logger createLogger()
                       throws IOException,
                              PGEException

Throws:

IOException

PGEException

createLogFileName

protected String createLogFileName()

createPgeMetadata

protected PgeMetadata createPgeMetadata(Metadata dynMetadata,
                                        WorkflowTaskConfiguration config)

createPgeConfig

protected PgeConfig createPgeConfig()
                             throws Exception

Throws:

Exception

runPropertyAdders

protected void runPropertyAdders()
                          throws PGEException

Throws:

PGEException

loadPropertyAdder

protected ConfigFilePropertyAdder loadPropertyAdder(String propertyAdderClasspath)

runPropertyAdder

protected void runPropertyAdder(ConfigFilePropertyAdder propAdder)

createWorkflowManagerClient

protected XmlRpcWorkflowManagerClient createWorkflowManagerClient()
                                                           throws MalformedURLException

Throws:

MalformedURLException

getWorkflowInstanceId

protected String getWorkflowInstanceId()

dumpMetadataIfRequested

protected void dumpMetadataIfRequested()
                                throws IOException

Throws:

IOException

getDumpMetadataPath

protected String getDumpMetadataPath()

getDumpMetadataName

protected String getDumpMetadataName()

createExeDir

protected void createExeDir()
                     throws PGEException

Throws:

PGEException

createOuputDirsIfRequested

protected void createOuputDirsIfRequested()
                                   throws PGEException

Throws:

PGEException

stageFiles

protected void stageFiles()
                   throws PGEException,
                          IOException,
                          ConnectionException,
                          CatalogException,
                          URISyntaxException,
                          DataTransferException,
                          InstantiationException

Throws:

PGEException

IOException

ConnectionException

CatalogException

URISyntaxException

DataTransferException

InstantiationException

getFileStager

protected FileStager getFileStager()

createDynamicConfigFiles

protected void createDynamicConfigFiles()
                                 throws IOException,
                                        PGEException

Throws:

IOException

PGEException

createDynamicConfigFile

protected void createDynamicConfigFile(DynamicConfigFile dynamicConfigFile)
                                throws PGEException,
                                       IOException

Throws:

PGEException

IOException

buildPgeRunScript

protected ScriptFile buildPgeRunScript()

getScriptPath

protected File getScriptPath()

getPgeScriptName

protected String getPgeScriptName()

runPge

protected void runPge()
               throws PGEException,
                      org.apache.xmlrpc.XmlRpcException

Throws:

PGEException

org.apache.xmlrpc.XmlRpcException

wasPgeSuccessful

protected boolean wasPgeSuccessful(int returnCode)

processOutput

protected void processOutput()
                      throws IOException

Throws:

IOException

renameFile

protected File renameFile(File file,
                          PathUtilsNamingConvention renamingConv)
                   throws NamingConventionException

Throws:

NamingConventionException

getMetadataForFile

protected Metadata getMetadataForFile(File sciPgeCreatedDataFile,
                                      PcsMetFileWriter writer,
                                      Object[] args)
                               throws PGEException,
                                      MetExtractorConfigReaderException,
                                      ParseException,
                                      MetExtractionException,
                                      CommonsException,
                                      CasMetadataException,
                                      FileNotFoundException

Throws:

PGEException

MetExtractorConfigReaderException

ParseException

MetExtractionException

CommonsException

CasMetadataException

FileNotFoundException

writeFromMetadata

protected void writeFromMetadata(Metadata metadata,
                                 String toMetFilePath)
                          throws IOException

Throws:

IOException

createProductCrawler

protected ProductCrawler createProductCrawler()
                                       throws MalformedURLException,
                                              IllegalAccessException,
                                              CrawlerActionException,
                                              MetExtractionException,
                                              InstantiationException,
                                              FileNotFoundException,
                                              ClassNotFoundException

Throws:

MalformedURLException

IllegalAccessException

CrawlerActionException

MetExtractionException

InstantiationException

FileNotFoundException

ClassNotFoundException

runIngestCrawler

protected void runIngestCrawler(ProductCrawler crawler)
                         throws PGEException,
                                IOException,
                                org.apache.xmlrpc.XmlRpcException

Throws:

PGEException

IOException

org.apache.xmlrpc.XmlRpcException

verifyIngests

protected void verifyIngests(ProductCrawler crawler)
                      throws PGEException

Throws:

PGEException

updateDynamicMetadata

protected void updateDynamicMetadata()
                              throws org.apache.xmlrpc.XmlRpcException,
                                     IOException

Throws:

org.apache.xmlrpc.XmlRpcException

IOException