Package org.opencastproject.workflow.handler.notification

Class HttpNotificationWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.notification.HttpNotificationWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class HttpNotificationWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

Workflow operation handler that will send HTTP POST or PUT requests to a specified address.

The request can contain a message type and a message body and automatically includes the workflow instance id. Should the notification fail, a retry strategy is implemented.

Requests will be send using the POST method by default, PUT is a supported alternative method.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

AbstractWorkflowOperationHandler.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HTTP_PARAM_MESSAGE	Name of the message HTTP parameter
static final String	HTTP_PARAM_SUBJECT	Name of the subject HTTP parameter
static final String	HTTP_PARAM_WORKFLOW	Name of the workflow instance id HTTP parameter
static final int	INITIAL_SLEEP_TIME	Default time between two request attempts
static final String	OPT_MAX_RETRY	Configuration key for the maximal attempts for the notification request
static final String	OPT_METHOD	Configuration key for the HTTP method to use (put or post)
static final String	OPT_NOTIFICATION_MESSAGE	Configuration key for the notification message
static final String	OPT_NOTIFICATION_SUBJECT	Configuration key for the notification event
static final String	OPT_TIMEOUT	Configuration key for the request timeout
static final String	OPT_URL_PATH	Configuration key for the target URL of the notification request
static final int	SLEEP_SCALE_FACTOR	The scale factor to the sleep time between two notification attempts

Fields inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

asList, description, id, serviceRegistry, SOURCE_FLAVOR, SOURCE_FLAVORS, SOURCE_TAG, SOURCE_TAGS, TARGET_FLAVOR, TARGET_FLAVORS, TARGET_TAG, TARGET_TAGS

Constructor Summary

Constructors

Constructor	Description
HttpNotificationWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

Methods inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

activate, asList, cfgKeyMissing, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OPT_URL_PATH

public static final String OPT_URL_PATH

Configuration key for the target URL of the notification request

See Also:

• Constant Field Values

OPT_NOTIFICATION_SUBJECT

public static final String OPT_NOTIFICATION_SUBJECT

Configuration key for the notification event

See Also:

• Constant Field Values

OPT_NOTIFICATION_MESSAGE

public static final String OPT_NOTIFICATION_MESSAGE

Configuration key for the notification message

See Also:

• Constant Field Values

OPT_METHOD

public static final String OPT_METHOD

Configuration key for the HTTP method to use (put or post)

See Also:

• Constant Field Values

OPT_MAX_RETRY

public static final String OPT_MAX_RETRY

Configuration key for the maximal attempts for the notification request

See Also:

• Constant Field Values

OPT_TIMEOUT

public static final String OPT_TIMEOUT

Configuration key for the request timeout

See Also:

• Constant Field Values

HTTP_PARAM_SUBJECT

public static final String HTTP_PARAM_SUBJECT

Name of the subject HTTP parameter

See Also:

• Constant Field Values

HTTP_PARAM_MESSAGE

public static final String HTTP_PARAM_MESSAGE

Name of the message HTTP parameter

See Also:

• Constant Field Values

HTTP_PARAM_WORKFLOW

public static final String HTTP_PARAM_WORKFLOW

Name of the workflow instance id HTTP parameter

See Also:

• Constant Field Values

INITIAL_SLEEP_TIME

public static final int INITIAL_SLEEP_TIME

Default time between two request attempts

See Also:

• Constant Field Values

SLEEP_SCALE_FACTOR

public static final int SLEEP_SCALE_FACTOR

The scale factor to the sleep time between two notification attempts

See Also:

• Constant Field Values

Constructor Details

HttpNotificationWorkflowOperationHandler

public HttpNotificationWorkflowOperationHandler()

Method Details

start

public WorkflowOperationResult start(WorkflowInstance workflowInstance,
 JobContext context)
                              throws WorkflowOperationException

Runs the workflow operation on this WorkflowInstance. If the execution fails for some reason, this must throw a WorkflowOperationException in order to handle the problem gracefully. Runtime exceptions will cause the entire workflow instance to fail.

Specified by:

start in interface WorkflowOperationHandler

Specified by:

start in class AbstractWorkflowOperationHandler

Parameters:

workflowInstance - the workflow instance

context - the job context

Returns:

the WorkflowOperationResult containing a potentially modified MediaPackage and whether to put the workflow instance into a wait state.

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly, and the default error handling should be invoked.

See Also:

• WorkflowOperationHandler.start(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Description copied from class: AbstractWorkflowOperationHandler

Sets the service registry. This method is here as a convenience for developers that need the registry to do job waiting.

Overrides:

setServiceRegistry in class AbstractWorkflowOperationHandler

Parameters:

serviceRegistry - the service registry