org.jenkinsci.plugins.durabletask

Class DurableTask

java.lang.Object

hudson.model.AbstractDescribableImpl<DurableTask>

org.jenkinsci.plugins.durabletask.DurableTask

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<DurableTask>

Direct Known Subclasses:

FileMonitoringTask

public abstract class DurableTask
extends hudson.model.AbstractDescribableImpl<DurableTask>
implements hudson.ExtensionPoint

A task which may be run asynchronously on a build node and withstand disconnection of the slave agent. Should have a descriptor, and a config.jelly for form data binding.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DurableTask()

Method Summary

Modifier and Type	Method and Description
void	captureOutput() Requests that standard output of the task be captured rather than streamed to Controller.writeLog(hudson.FilePath, java.io.OutputStream).
DurableTaskDescriptor	getDescriptor()
abstract Controller	launch(hudson.EnvVars env, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Launches a durable task.

Methods inherited from class java.lang.Object

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

Constructor Detail

DurableTask

public DurableTask()

Method Detail

getDescriptor

public DurableTaskDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<DurableTask>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<DurableTask>

launch

public abstract Controller launch(hudson.EnvVars env,
                                  hudson.FilePath workspace,
                                  hudson.Launcher launcher,
                                  hudson.model.TaskListener listener)
                           throws IOException,
                                  InterruptedException

Launches a durable task.

Parameters:

env - basic environment variables to use during launch

workspace - the workspace to use

launcher - a way to start processes

listener - log output for the build

Returns:

a way to check up on the task’s subsequent status

Throws:

IOException

InterruptedException

captureOutput

public void captureOutput()
                   throws UnsupportedOperationException

Requests that standard output of the task be captured rather than streamed to Controller.writeLog(hudson.FilePath, java.io.OutputStream). If so, you may call Controller.getOutput(hudson.FilePath, hudson.Launcher). Standard error should still be streamed to the log. Should be called prior to launch(hudson.EnvVars, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) to take effect.

Throws:

UnsupportedOperationException - if this implementation does not support that mode