edu.illinois.ncsa.isda.softwareserver.datawolf

Class WorkflowUtilities

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.datawolf.WorkflowUtilities

public class WorkflowUtilities
extends Object

DataWolf REST interface utility methods

Author:

Chris Navarro

Constructor Summary

Constructors

Constructor and Description
WorkflowUtilities()

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.gson.JsonObject	createCommandlineOption(String type, String value, String flag, String optionId, String inputOutput, String filename, boolean commandline) Creates new command line option around a workflow tool parameter or data input/output
static String	createDataWolfTool(File toolzip) Calls DataWolf REST endpoint to create the DataWolf tool
static String	createDataWolfTool(String toolName, String toolTask, String toolOutput, String toolInput, String softwareServerURL, com.google.gson.JsonObject creator) Creates a new DataWolf tool.
static com.google.gson.JsonObject	createWorkflow(String title, String description, com.google.gson.JsonObject creator) Creates a workflow with the given title, description and creator.
static com.google.gson.JsonObject	createWorkflowStep(com.google.gson.JsonObject tool, com.google.gson.JsonObject creator) Creates a new workflow step for a DataWolf tool
static com.google.gson.JsonObject	createWorkflowToolData(String title, String description, String mimeType) Creates a new workflow tool data
static com.google.gson.JsonObject	createWorkflowToolParameter(String title, String description, boolean allowNull, String type, boolean hidden, String value) Creates a new workflow tool parameter
static String	getShellScript() Returns DataWolf tool shell script for calling SoftwareServers
static com.google.gson.JsonObject	getShellScriptDescriptor() Creates a FileDescriptor to associate the shell script with for the DataWolf tool.
static com.google.gson.JsonObject	getUser() Returns DataWolf user as JSON object
static com.google.gson.JsonObject	getWorkflowTool(String toolId) Fetches a DataWolf tool by ID
static String	parseLogfile(String file) Parses a log file and creates a DataWolf workflow representation.
static com.google.gson.JsonObject	saveWorkflow(com.google.gson.JsonObject workflow, boolean update) Calls the DataWolf REST endpoint to save the workflow.
static com.google.gson.JsonObject	updateWorkflow(com.google.gson.JsonObject workflow) Calls the DataWolf REST endpoint to update the workflow

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowUtilities

public WorkflowUtilities()

Method Detail

parseLogfile

public static String parseLogfile(String file)

Parses a log file and creates a DataWolf workflow representation.

Parameters:

file - log file to parse

Returns:

HTML link to the created workflow

createWorkflow

public static com.google.gson.JsonObject createWorkflow(String title,
                                        String description,
                                        com.google.gson.JsonObject creator)

Creates a workflow with the given title, description and creator.

Parameters:

title - Workflow title

description - Workflow description

creator - Workflow creator

Returns:

New workflow

updateWorkflow

public static com.google.gson.JsonObject updateWorkflow(com.google.gson.JsonObject workflow)

Calls the DataWolf REST endpoint to update the workflow

Parameters:

workflow - Workflow to update

Returns:

Updated workflow

saveWorkflow

public static com.google.gson.JsonObject saveWorkflow(com.google.gson.JsonObject workflow,
                                      boolean update)

Calls the DataWolf REST endpoint to save the workflow. The update flag indicates whether the workflow has been created previously and is being updated so the correct endpoint is called.

Parameters:

workflow - Workflow to save

update - True if the workflow is being updated, false if this is the initial save

Returns:

Saved workflow

createWorkflowStep

public static com.google.gson.JsonObject createWorkflowStep(com.google.gson.JsonObject tool,
                                            com.google.gson.JsonObject creator)

Creates a new workflow step for a DataWolf tool

Parameters:

tool - DataWolf tool to create step for

creator - Workflow creator

Returns:

New workflowStep

createDataWolfTool

public static String createDataWolfTool(String toolName,
                        String toolTask,
                        String toolOutput,
                        String toolInput,
                        String softwareServerURL,
                        com.google.gson.JsonObject creator)

Creates a new DataWolf tool.

Parameters:

toolName - Name of the tool

toolTask - Tool task

toolOutput - Tool output

toolInput - Tool input

softwareServerURL - SoftwareServer URL

creator - Tool creator

Returns:

String representing the ID of the new tool

getWorkflowTool

public static com.google.gson.JsonObject getWorkflowTool(String toolId)

Fetches a DataWolf tool by ID

Parameters:

toolId - ID of the tool

Returns:

DataWolf tool

createWorkflowToolParameter

public static com.google.gson.JsonObject createWorkflowToolParameter(String title,
                                                     String description,
                                                     boolean allowNull,
                                                     String type,
                                                     boolean hidden,
                                                     String value)

Creates a new workflow tool parameter

Parameters:

title - Workflow tool parameter title

description - Workflow tool parameter description

allowNull - True - can be null, False - must not be null

type - Parameter Type

hidden - True - hidden from the user, False - not hidden

value - Default value for the parameter

Returns:

New workflow tool parameter

createWorkflowToolData

public static com.google.gson.JsonObject createWorkflowToolData(String title,
                                                String description,
                                                String mimeType)

Creates a new workflow tool data

Parameters:

title - Workflow tool data field title

description - Workflow tool data description

mimeType - Workflow tool data type

Returns:

New workflow tool data

createCommandlineOption

public static com.google.gson.JsonObject createCommandlineOption(String type,
                                                 String value,
                                                 String flag,
                                                 String optionId,
                                                 String inputOutput,
                                                 String filename,
                                                 boolean commandline)

Creates new command line option around a workflow tool parameter or data input/output

Parameters:

type - The type of command line option

value - Fixed value for the option

flag - Optional flag for the option

optionId - Unique id of the optino

inputOutput - Specifies whether an option is an input, output or both (if applicable)

filename - Name of the input/output file to store (if applicable)

commandline - True - option passed at the command line to the tool, False - option not passed

Returns:

New command line option

createDataWolfTool

public static String createDataWolfTool(File toolzip)

Calls DataWolf REST endpoint to create the DataWolf tool

Parameters:

toolzip - Zip file containing tool information and data

Returns:

Unique id representing new tool

getShellScriptDescriptor

public static com.google.gson.JsonObject getShellScriptDescriptor()

Creates a FileDescriptor to associate the shell script with for the DataWolf tool.

Returns:

FileDescriptor for tool shell script

getShellScript

public static String getShellScript()

Returns DataWolf tool shell script for calling SoftwareServers

Returns:

DataWolf tool shell script for calling SoftwareServers

getUser

public static com.google.gson.JsonObject getUser()

Returns DataWolf user as JSON object

Returns:

DataWolf user as JSON object