Package org.opencastproject.workflow.handler.mattermost.notification

Class MattermostNotificationWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.mattermost.notification.MattermostNotificationWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class MattermostNotificationWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

Workflow operation for notifying Mattermost about the status of the current workflow.

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_PAYLOAD	Name of the subject HTTP parameter
static final int	INITIAL_SLEEP_TIME	Default time between two request attempts in milliseconds
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_TIMEOUT	Configuration key for the request timeout in milliseconds
static final String	OPT_URL_PATH	Configuration key for the target URL of the notification request
static final String	POST	HTTP method POST
static final String	PUT	HTTP method PUT
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
MattermostNotificationWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
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, setServiceRegistry, 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_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 in milliseconds

See Also:

• Constant Field Values

HTTP_PARAM_PAYLOAD

public static final String HTTP_PARAM_PAYLOAD

Name of the subject HTTP parameter

See Also:

• Constant Field Values

POST

public static final String POST

HTTP method POST

See Also:

• Constant Field Values

PUT

public static final String PUT

HTTP method PUT

See Also:

• Constant Field Values

INITIAL_SLEEP_TIME

public static final int INITIAL_SLEEP_TIME

Default time between two request attempts in milliseconds

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

MattermostNotificationWorkflowOperationHandler

public MattermostNotificationWorkflowOperationHandler()

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)