Package org.jenkinsci.plugins.durabletask

Class PowershellScript

java.lang.Object

hudson.model.AbstractDescribableImpl<DurableTask>

org.jenkinsci.plugins.durabletask.DurableTask

org.jenkinsci.plugins.durabletask.FileMonitoringTask

org.jenkinsci.plugins.durabletask.PowershellScript

All Implemented Interfaces:

ExtensionPoint, Describable<DurableTask>

public final class PowershellScript
extends FileMonitoringTask

Runs a Powershell script

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PowershellScript.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.durabletask.FileMonitoringTask

FileMonitoringTask.FileMonitoringController

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	USE_BINARY_WRAPPER

Fields inherited from class org.jenkinsci.plugins.durabletask.FileMonitoringTask

BINARY_RESOURCE_PREFIX, COOKIE

Constructor Summary

Constructors

Constructor	Description
PowershellScript(String script)

Method Summary

Modifier and Type	Method	Description
void	captureOutput()	Requests that standard output of the task be captured rather than streamed.
protected FileMonitoringTask.FileMonitoringController	doLaunch(FilePath ws, Launcher launcher, TaskListener listener, EnvVars envVars)	Should start a process which sends output to log file in the workspace and finally writes its exit code to result file.
String	getPowershellBinary()
String	getScript()
boolean	isLoadProfile()
void	setLoadProfile(boolean loadProfile)
void	setPowershellBinary(String powershellBinary)

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

charset, defaultCharset, escape, getAgentInfo, getNodeRoot, launch, launchWithCookie, requestBinary, requestBinary

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

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

USE_BINARY_WRAPPER

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean USE_BINARY_WRAPPER

Constructor Details

PowershellScript

@DataBoundConstructor
public PowershellScript(String script)

Method Details

getPowershellBinary

public String getPowershellBinary()

setPowershellBinary

@DataBoundSetter
public void setPowershellBinary(String powershellBinary)

isLoadProfile

public boolean isLoadProfile()

setLoadProfile

@DataBoundSetter
public void setLoadProfile(boolean loadProfile)

getScript

public String getScript()

captureOutput

public void captureOutput()

Description copied from class: DurableTask

Requests that standard output of the task be captured rather than streamed. If you use Controller.watch(hudson.FilePath, org.jenkinsci.plugins.durabletask.Handler, hudson.model.TaskListener), standard output will not be sent to Handler.output(java.io.InputStream); it will be included in Handler.exited(int, byte[]) instead. Otherwise (using polling mode), standard output will not be sent to Controller.writeLog(hudson.FilePath, java.io.OutputStream); call Controller.getOutput(hudson.FilePath, hudson.Launcher) to collect. Standard error should still be streamed to the log. Should be called prior to DurableTask.launch(hudson.EnvVars, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) to take effect.

Overrides:

captureOutput in class DurableTask

doLaunch

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

Description copied from class: FileMonitoringTask

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

Overrides:

doLaunch in class FileMonitoringTask

Parameters:

ws - 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