org.jenkinsci.plugins.durabletask

Class FileMonitoringTask

java.lang.Object

hudson.model.AbstractDescribableImpl<DurableTask>

org.jenkinsci.plugins.durabletask.DurableTask

org.jenkinsci.plugins.durabletask.FileMonitoringTask

All Implemented Interfaces:

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

Direct Known Subclasses:

BourneShellScript, PowershellScript, WindowsBatchScript

public abstract class FileMonitoringTask
extends DurableTask

A task which forks some external command and then waits for log and status files to be updated/created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FileMonitoringTask.FileMonitoringController

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
FileMonitoringTask()

Method Summary

Modifier and Type	Method and Description
protected FileMonitoringTask.FileMonitoringController	doLaunch(hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars envVars) Should start a process which sends output to log file in the workspace and finally writes its exit code to result file.
protected static Map<String,String>	escape(hudson.EnvVars envVars) JENKINS-40734: blocks the substitutions of EnvVars.overrideExpandingAll(java.util.Map<java.lang.String, java.lang.String>) done by Launcher.
Controller	launch(hudson.EnvVars env, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Launches a durable task.
protected FileMonitoringTask.FileMonitoringController	launchWithCookie(hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars envVars, String cookieVariable, String cookieValue)

Methods inherited from class org.jenkinsci.plugins.durabletask.DurableTask

captureOutput, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMonitoringTask

public FileMonitoringTask()

Method Detail

launch

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

Description copied from class: DurableTask

Launches a durable task.

Specified by:

launch in class DurableTask

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

launchWithCookie

protected FileMonitoringTask.FileMonitoringController launchWithCookie(hudson.FilePath workspace,
                                                                       hudson.Launcher launcher,
                                                                       hudson.model.TaskListener listener,
                                                                       hudson.EnvVars envVars,
                                                                       String cookieVariable,
                                                                       String cookieValue)
                                                                throws IOException,
                                                                       InterruptedException

Throws:

IOException

InterruptedException

doLaunch

protected FileMonitoringTask.FileMonitoringController doLaunch(hudson.FilePath workspace,
                                                               hudson.Launcher launcher,
                                                               hudson.model.TaskListener listener,
                                                               hudson.EnvVars envVars)
                                                        throws IOException,
                                                               InterruptedException

Should start a process which sends output to log file in the workspace and finally writes its exit code to result file.

Parameters:

workspace - the workspace to use

launcher - a way to launch processes

listener - build console log

envVars - recommended environment for the subprocess

Returns:

a specialized controller

Throws:

IOException

InterruptedException

escape

protected static Map<String,String> escape(hudson.EnvVars envVars)

JENKINS-40734: blocks the substitutions of EnvVars.overrideExpandingAll(java.util.Map<java.lang.String, java.lang.String>) done by Launcher.