OozieWorkflowEngine (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.pipeline.workflowV2.engine.oozie.OozieWorkflowEngine

All Implemented Interfaces:

WorkflowEngine
```
public class OozieWorkflowEngine
extends Object
implements WorkflowEngine
```
This is the implementation of the WorkflowEngine with a Oozie back-end.

Author:

dyuen

Constructor Summary

Constructors
Constructor and Description
`OozieWorkflowEngine(AbstractWorkflowDataModel objectModel, boolean useSge, String threadsSgeParamFormat, String maxMemorySgeParamFormat, boolean createDirectories)`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`copyFromLocal(org.apache.hadoop.fs.FileSystem fileSystem, String source, org.apache.hadoop.fs.Path dstPath)`
`String`	`getLookupToken()` An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
`String`	`getWorkingDirectory()` The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
`static org.apache.hadoop.conf.Configuration`	`initConf(AbstractWorkflowDataModel model)`
`static org.apache.hadoop.fs.Path`	`initHdfsWorkDir(AbstractWorkflowDataModel model, org.apache.hadoop.conf.Configuration conf, File nfsWorkDir)`
`static File`	`initNfsWorkDir(AbstractWorkflowDataModel model)`
`void`	`prepareWorkflow(AbstractWorkflowDataModel objectModel)` Prepare the workflow according to the info filled in the input objectModel.
`ReturnValue`	`runWorkflow()` Run the prepared workflow.
`ReturnValue`	`watchWorkflow(String jobToken)` Watch a workflow and return running information until it completes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OozieWorkflowEngine
```
public OozieWorkflowEngine(AbstractWorkflowDataModel objectModel,
                   boolean useSge,
                   String threadsSgeParamFormat,
                   String maxMemorySgeParamFormat,
                   boolean createDirectories)
```
    Parameters:
    objectModel -
    useSge -
    threadsSgeParamFormat -
    maxMemorySgeParamFormat -
    createDirectories - true when creating the engine to launch a job
- Method Detail
  - initNfsWorkDir
```
public static File initNfsWorkDir(AbstractWorkflowDataModel model)
```
  - initConf
```
public static org.apache.hadoop.conf.Configuration initConf(AbstractWorkflowDataModel model)
```
  - initHdfsWorkDir
```
public static org.apache.hadoop.fs.Path initHdfsWorkDir(AbstractWorkflowDataModel model,
                                        org.apache.hadoop.conf.Configuration conf,
                                        File nfsWorkDir)
```
  - prepareWorkflow
```
public void prepareWorkflow(AbstractWorkflowDataModel objectModel)
```
    Description copied from interface: WorkflowEngine
    
    Prepare the workflow according to the info filled in the input objectModel.
    
    Specified by:
    
    prepareWorkflow in interface WorkflowEngine
    
    Parameters:
    objectModel - model of the workflow to prepare to run
  - runWorkflow
```
public ReturnValue runWorkflow()
```
    Description copied from interface: WorkflowEngine
    
    Run the prepared workflow.
    
    Specified by:
    
    runWorkflow in interface WorkflowEngine
    
    Returns:
  - watchWorkflow
```
public ReturnValue watchWorkflow(String jobToken)
```
    Description copied from interface: WorkflowEngine
    
    Watch a workflow and return running information until it completes. The exact nature of the output is arbitrary and likely dependent on the workflow engine.
    
    Specified by:
    
    watchWorkflow in interface WorkflowEngine
    
    Returns:
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    Description copied from interface: WorkflowEngine
    
    The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
    
    Specified by:
    
    getWorkingDirectory in interface WorkflowEngine
    
    Returns:
    the working directory, or null
  - copyFromLocal
```
public static void copyFromLocal(org.apache.hadoop.fs.FileSystem fileSystem,
                 String source,
                 org.apache.hadoop.fs.Path dstPath)
```
  - getLookupToken
```
public String getLookupToken()
```
    Description copied from interface: WorkflowEngine
    
    An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
    
    Specified by:
    
    getLookupToken in interface WorkflowEngine
    
    Returns:
    the token

Class OozieWorkflowEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OozieWorkflowEngine

Method Detail

initNfsWorkDir

initConf

initHdfsWorkDir

prepareWorkflow

runWorkflow

watchWorkflow

getWorkingDirectory

copyFromLocal

getLookupToken