Package org.opencastproject.workflow.handler.matrix

Class MatrixNotificationWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.matrix.MatrixNotificationWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class MatrixNotificationWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

The Matrix notification workflow operation handler can send notifications to Matrix rooms.

This workflow operation sends a message to a specified Matrix room using the Matrix Client-Server API. It requires the following configuration parameters:

• room-id - The Matrix room ID to send the notification to
• message - The message body to send

The handler also requires the following configuration properties to be set:

• matrix.server.url - The Matrix server URL (default: https://matrix.org)
• matrix.access.token - The Matrix access token for authentication
• matrix.max.retry - Maximum number of retry attempts (default: 5)
• matrix.timeout - Request timeout in seconds (default: 10)

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 int	INITIAL_SLEEP_TIME	Default time between two request attempts
static final String	OPT_MESSAGE	Configuration key for the Matrix message body
static final String	OPT_ROOM_ID	Configuration key for the Matrix room ID
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

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

Constructor Summary

Constructors

Constructor	Description
MatrixNotificationWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	Activates this component and initializes the configuration properties.
WorkflowOperationResult	start(WorkflowInstance workflow, JobContext context)	Starts the Matrix notification workflow operation.

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

applyTargetTagsToElement, asList, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, 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_ROOM_ID

public static final String OPT_ROOM_ID

Configuration key for the Matrix room ID

See Also:

• Constant Field Values

OPT_MESSAGE

public static final String OPT_MESSAGE

Configuration key for the Matrix message body

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

MatrixNotificationWorkflowOperationHandler

public MatrixNotificationWorkflowOperationHandler()

Method Details

activate

protected void activate(org.osgi.service.component.ComponentContext cc)

Activates this component and initializes the configuration properties.

Overrides:

activate in class AbstractWorkflowOperationHandler

Parameters:

cc - the component context

start

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

Starts the Matrix notification workflow operation.

Specified by:

start in interface WorkflowOperationHandler

Specified by:

start in class AbstractWorkflowOperationHandler

Parameters:

workflow - the workflow instance

context - the job context

Returns:

the workflow operation result

Throws:

WorkflowOperationException - if the operation fails

See Also:

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