Package com.xebialabs.xlrelease.osgi.api.tasks

Interface TaskExecutionResult

All Known Implementing Classes:

TaskExecutionResult.AwaitSignal, TaskExecutionResult.Completed, TaskExecutionResult.Failed, TaskExecutionResult.SuspendFor

public sealed interface TaskExecutionResult
permits TaskExecutionResult.Completed, TaskExecutionResult.Failed, TaskExecutionResult.SuspendFor, TaskExecutionResult.AwaitSignal

What the host should do with a task after TaskExecutorExtension.execute(com.xebialabs.xlrelease.osgi.api.tasks.TaskExecutionContext) returns.

A closed set of four outcomes, created through the static factory methods. Suspension is always a returned outcome, never a blocked or parked thread - the host persists the task's state and re-enters execute later, which is what makes a wait survive a server restart.

The two suspending outcomes mirror the two mechanisms Jython tasks already have: suspendFor(Duration) corresponds to CustomScriptTask.schedule(path, interval), and awaitSignal() to waitForSignal(). In both cases the task stays in progress and execute is entered again from the top - there is no separate "resume" method to implement. Distinguish the entries with TaskExecutionContext.isResume() and carry state across the gap in output properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	TaskExecutionResult.AwaitSignal	The task should be re-entered only when something external signals it.
static final record	TaskExecutionResult.Completed	The task finished successfully.
static final record	TaskExecutionResult.Failed	The task failed.
static final record	TaskExecutionResult.SuspendFor	The task should be re-entered after delay.

Method Summary

Static Methods

Modifier and Type	Method	Description
static TaskExecutionResult	awaitSignal()	Suspend indefinitely, until something external resumes the task.
static TaskExecutionResult	completed()	The task finished successfully.
static TaskExecutionResult	failed(String message)	The task failed, with a message for the release author.
static TaskExecutionResult	suspendFor(Duration delay)	Suspend, and re-enter TaskExecutorExtension.execute(com.xebialabs.xlrelease.osgi.api.tasks.TaskExecutionContext) after delay.

Method Details

completed

static TaskExecutionResult completed()

The task finished successfully.

failed

static TaskExecutionResult failed(String message)

The task failed, with a message for the release author.

Parameters:

message - non-blank; what went wrong and ideally what to do about it

Throws:

IllegalArgumentException - if message is null or blank - a failure the author cannot read is worse than a stack trace

suspendFor

static TaskExecutionResult suspendFor(Duration delay)

Suspend, and re-enter TaskExecutorExtension.execute(com.xebialabs.xlrelease.osgi.api.tasks.TaskExecutionContext) after delay.

State is not kept in memory across the gap - persist anything you need through TaskExecutionContext.setOutputProperty(String, Object) and read it back on the next entry.

Parameters:

delay - at least one second, matching the lower bound Jython's CustomScriptTask.schedule(String, Integer) enforces on its interval

Throws:

IllegalArgumentException - if delay is null, or shorter than a second

awaitSignal

static TaskExecutionResult awaitSignal()

Suspend indefinitely, until something external resumes the task.

See Also:

• TaskExecutionResult.AwaitSignal