Package org.opencastproject.workflow.api

Class XmlWorkflowParser

java.lang.Object

org.opencastproject.workflow.api.XmlWorkflowParser

public final class XmlWorkflowParser
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 WorkflowInstance	parseWorkflowInstance(InputStream in)	Loads a workflow instance from the given input stream.
static WorkflowInstance	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	toXml(JaxbWorkflowInstance workflowInstance)	Converts a xml annotated workflowInstance to an xml string
static String	toXml(WorkflowDefinition workflowDefinition)	Converts a workflowDefinition to an xml string
static String	toXml(WorkflowInstance workflowInstance)	Converts a workflowInstance to an xml string

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 WorkflowInstance 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 WorkflowInstance 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

toXml

public static String toXml(WorkflowInstance workflowInstance)
                    throws WorkflowParsingException

Converts a workflowInstance to an xml string

Parameters:

workflowInstance - the workflowInstance

Returns:

workflowInstance as xml string

Throws:

WorkflowParsingException

toXml

public static String toXml(JaxbWorkflowInstance workflowInstance)
                    throws WorkflowParsingException

Converts a xml annotated workflowInstance to an xml string

Parameters:

workflowInstance - the xml annotated workflowInstance

Returns:

workflowInstance as xml string

Throws:

WorkflowParsingException

toXml

public static String toXml(WorkflowDefinition workflowDefinition)
                    throws WorkflowParsingException

Converts a workflowDefinition to an xml string

Parameters:

workflowDefinition - the workflowDefinition

Returns:

workflowDefinition as xml string

Throws:

WorkflowParsingException