Package org.opencastproject.workflow.api

Class YamlWorkflowParser

java.lang.Object

org.opencastproject.workflow.api.YamlWorkflowParser

public final class YamlWorkflowParser
extends Object

Provides a mechanism to un/marshall workflow instances and definitions to/from xml.

Method Summary

Modifier and Type	Method	Description
static WorkflowDefinition	parseWorkflowDefinition(InputStream in)	Loads a workflow definition from the given input stream.
static WorkflowDefinition	parseWorkflowDefinition(String in)	Loads a workflow definition from the xml stream.
static List<WorkflowDefinition>	parseWorkflowDefinitions(InputStream in)	Loads workflow definitions from the given input stream.
static JaxbWorkflowConfiguration	parseWorkflowInstance(InputStream in)	Loads a workflow instance from the given input stream.
static JaxbWorkflowConfiguration	parseWorkflowInstance(String in)	Loads a workflow instance from the xml stream.
static WorkflowSet	parseWorkflowSet(InputStream in)	Loads a set of workflow instances from the given input stream.
static String	toYaml(WorkflowDefinition workflowDefinition)
static String	toYaml(WorkflowInstance workflowInstance)

Methods inherited from class java.lang.Object

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

Method Details

parseWorkflowDefinitions

public static List<WorkflowDefinition> parseWorkflowDefinitions(InputStream in)
                                                         throws WorkflowParsingException

Loads workflow definitions from the given input stream.

Parameters:

in -

Returns:

the list of workflow definitions

Throws:

WorkflowParsingException

parseWorkflowDefinition

public static WorkflowDefinition parseWorkflowDefinition(InputStream in)
                                                  throws WorkflowParsingException

Loads a workflow definition from the given input stream.

Parameters:

in - the input stream

Returns:

the workflow definition

Throws:

WorkflowParsingException - if creating the workflow definition fails

parseWorkflowDefinition

public static WorkflowDefinition parseWorkflowDefinition(String in)
                                                  throws WorkflowParsingException

Loads a workflow definition from the xml stream.

Parameters:

in - xml stream of the workflow definition

Returns:

the workflow definition

Throws:

WorkflowParsingException - if creating the workflow definition fails

parseWorkflowInstance

public static JaxbWorkflowConfiguration parseWorkflowInstance(InputStream in)
                                                       throws WorkflowParsingException

Loads a workflow instance from the given input stream.

Parameters:

in - the input stream

Returns:

the workflow instance

Throws:

WorkflowParsingException - if creating the workflow instance fails

parseWorkflowInstance

public static JaxbWorkflowConfiguration parseWorkflowInstance(String in)
                                                       throws WorkflowParsingException

Loads a workflow instance from the xml stream.

Parameters:

in - xml stream of the workflow instance

Returns:

the workflow instance

Throws:

WorkflowParsingException - if creating the workflow instance fails

parseWorkflowSet

public static WorkflowSet parseWorkflowSet(InputStream in)
                                    throws WorkflowParsingException

Loads a set of workflow instances from the given input stream.

Parameters:

in - the input stream

Returns:

the set of workflow instances

Throws:

WorkflowParsingException - if creating the workflow instance set fails

toYaml

public static String toYaml(WorkflowInstance workflowInstance)
                     throws WorkflowParsingException

Throws:

WorkflowParsingException

toYaml

public static String toYaml(WorkflowDefinition workflowDefinition)
                     throws WorkflowParsingException

Throws:

WorkflowParsingException