Package org.opencastproject.workflow.api

Class WorkflowOperationDefinitionImpl

java.lang.Object

org.opencastproject.workflow.api.WorkflowOperationDefinitionImpl

All Implemented Interfaces:

Configurable, WorkflowOperationDefinition

public class WorkflowOperationDefinitionImpl
extends Object
implements WorkflowOperationDefinition

See WorkflowOperationDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<JaxbWorkflowConfiguration>	configurations
protected String	description
protected String	exceptionHandlingWorkflow
protected String	executeCondition
protected boolean	failWorkflowOnException
protected String	id
protected int	maxAttempts
protected RetryStrategy	retryStrategy
protected String	skipCondition

Constructor Summary

Constructors

Constructor	Description
WorkflowOperationDefinitionImpl()	A no-arg constructor is needed by JAXB
WorkflowOperationDefinitionImpl(String id, String description, String exceptionHandlingWorkflow, boolean failWorkflowOnException)

Method Summary

Modifier and Type	Method	Description
String	getConfiguration(String key)	Returns the value of property name or null if no such property has been set.
Set<String>	getConfigurationKeys()	Gets the configuration keys that are currently set for this configurable entity.
String	getDescription()
String	getExceptionHandlingWorkflow()	The workflow to run if an exception is thrown while this operation is running.
String	getExecutionCondition()	Returns either null or true to have the operation executed.
String	getId()
int	getMaxAttempts()	Returns the number of attempts the workflow service will make to execute this operation.
RetryStrategy	getRetryStrategy()	Return the retry strategy
String	getSkipCondition()	Returns either null or true to have the operation skipped.
boolean	isFailWorkflowOnException()	If true, this workflow will be put into a failed (or failing, if getExceptionHandlingWorkflow() is not null) state when exceptions are thrown during an operation.
void	removeConfiguration(String key)	Removes the key configuration.
void	setConfiguration(String key, String value)	Sets the configuration with name key to value value, or adds it if it doesn't already exist.
void	setDescription(String description)
void	setExceptionHandlingWorkflow(String exceptionHandlingWorkflow)
void	setExecutionCondition(String condition)
void	setFailWorkflowOnException(boolean failWorkflowOnException)
void	setId(String id)
void	setMaxAttempts(int maxAttempts)
void	setRetryStrategy(RetryStrategy retryStrategy)
void	setSkipCondition(String condition)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

description

protected String description

failWorkflowOnException

protected boolean failWorkflowOnException

executeCondition

protected String executeCondition

skipCondition

protected String skipCondition

exceptionHandlingWorkflow

protected String exceptionHandlingWorkflow

configurations

protected Set<JaxbWorkflowConfiguration> configurations

maxAttempts

protected int maxAttempts

retryStrategy

protected RetryStrategy retryStrategy

Constructor Details

WorkflowOperationDefinitionImpl

public WorkflowOperationDefinitionImpl()

A no-arg constructor is needed by JAXB

WorkflowOperationDefinitionImpl

public WorkflowOperationDefinitionImpl(String id,
 String description,
 String exceptionHandlingWorkflow,
 boolean failWorkflowOnException)

Parameters:

id - The unique name of this operation

description - The description of what this operation does

exceptionHandlingWorkflow - The workflow to run when a workflow operation exception is thrown

failWorkflowOnException - Whether an exception thrown by this operation should fail the entire WorkflowInstance

Method Details

getId

public String getId()

Specified by:

getId in interface WorkflowOperationDefinition

setId

public void setId(String id)

getDescription

public String getDescription()

Specified by:

getDescription in interface WorkflowOperationDefinition

setDescription

public void setDescription(String description)

setExecutionCondition

public void setExecutionCondition(String condition)

getExecutionCondition

public String getExecutionCondition()

Description copied from interface: WorkflowOperationDefinition

Returns either null or true to have the operation executed. Any other value is interpreted as false and will skip the operation.

Usually, this will be a variable name such as ${foo}, which will be replaced with its acutal value once the workflow is executed.

If both getExecuteCondition() and getSkipCondition return a non-null value, the execute condition takes precedence.

Specified by:

getExecutionCondition in interface WorkflowOperationDefinition

Returns:

the excecution condition.

setSkipCondition

public void setSkipCondition(String condition)

getSkipCondition

public String getSkipCondition()

Description copied from interface: WorkflowOperationDefinition

Returns either null or true to have the operation skipped. Any other value is interpreted as false and will execute the operation.

Usually, this will be a variable name such as ${foo}, which will be replaced with its actual value once the workflow is executed.

If both getExecuteCondition() and getSkipCondition return a non-null value, the execute condition takes precedence.

Specified by:

getSkipCondition in interface WorkflowOperationDefinition

Returns:

the excecution condition.

getExceptionHandlingWorkflow

public String getExceptionHandlingWorkflow()

The workflow to run if an exception is thrown while this operation is running.

Specified by:

getExceptionHandlingWorkflow in interface WorkflowOperationDefinition

See Also:

• WorkflowOperationDefinition.getExceptionHandlingWorkflow()

setExceptionHandlingWorkflow

public void setExceptionHandlingWorkflow(String exceptionHandlingWorkflow)

isFailWorkflowOnException

public boolean isFailWorkflowOnException()

If true, this workflow will be put into a failed (or failing, if getExceptionHandlingWorkflow() is not null) state when exceptions are thrown during an operation.

Specified by:

isFailWorkflowOnException in interface WorkflowOperationDefinition

See Also:

• WorkflowOperationDefinition.isFailWorkflowOnException()

setFailWorkflowOnException

public void setFailWorkflowOnException(boolean failWorkflowOnException)

getConfiguration

public String getConfiguration(String key)

Returns the value of property name or null if no such property has been set.

Specified by:

getConfiguration in interface Configurable

Parameters:

key - the configuration key

Returns:

the configuration value

See Also:

• WorkflowInstance.getConfiguration(java.lang.String)

removeConfiguration

public void removeConfiguration(String key)

Removes the key configuration.

Specified by:

removeConfiguration in interface Configurable

Parameters:

key - the configuration key

See Also:

• WorkflowInstance.removeConfiguration(java.lang.String)

setConfiguration

public void setConfiguration(String key,
 String value)

Sets the configuration with name key to value value, or adds it if it doesn't already exist.

Specified by:

setConfiguration in interface Configurable

Parameters:

key - the configuration key

value - the configuration value

See Also:

• WorkflowInstance.setConfiguration(java.lang.String, java.lang.String)

getConfigurationKeys

public Set<String> getConfigurationKeys()

Gets the configuration keys that are currently set for this configurable entity.

Specified by:

getConfigurationKeys in interface Configurable

Returns:

the configuration keys

See Also:

• Configurable.getConfigurationKeys()

getRetryStrategy

public RetryStrategy getRetryStrategy()

Return the retry strategy

Specified by:

getRetryStrategy in interface WorkflowOperationDefinition

Returns:

the retry strategy

See Also:

• WorkflowOperationDefinition.getRetryStrategy()

setRetryStrategy

public void setRetryStrategy(RetryStrategy retryStrategy)

Parameters:

retryStrategy - the retry strategy to set

getMaxAttempts

public int getMaxAttempts()

Returns the number of attempts the workflow service will make to execute this operation.

Specified by:

getMaxAttempts in interface WorkflowOperationDefinition

Returns:

the maximum number of retries before failing

See Also:

• WorkflowOperationDefinition.getMaxAttempts()

setMaxAttempts

public void setMaxAttempts(int maxAttempts)

Parameters:

maxAttempts - the maxAttempts to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()