Package io.jenkins.plugins.util

Class AbstractExecution<T>

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

io.jenkins.plugins.util.AbstractExecution<T>

Type Parameters:

T - the type of the return value (use Void if no return value is available)

All Implemented Interfaces:

Serializable

public abstract class AbstractExecution<T>
extends org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<T>

Base class for step executions. Provides several helper methods to obtain the defined context elements.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExecution(org.jenkinsci.plugins.workflow.steps.StepContext context)	Creates a new instance of AbstractExecution.

Method Summary

Modifier and Type	Method	Description
protected ResultHandler	createResultHandler()	Creates a ResultHandler that sets build result of the Run or stage.
protected StageResultHandler	createStageResultHandler()	Deprecated. use createResultHandler() instead
protected FilePath	getBuildFolder()	Returns Jenkins' build folder.
protected Optional<hudson.remoting.VirtualChannel>	getChannel()	Returns a VirtualChannel to the agent where this step has been executed.
protected Charset	getCharset(String charset)	Returns the default charset for the specified encoding string.
protected Run<?,?>	getRun()	Returns the associated pipeline run.
protected TaskListener	getTaskListener()	Returns the TaskListener for this execution.
protected FilePath	getWorkspace()	Returns the workspace for this job.

Methods inherited from class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution

blocksRestart, getStatus, onResume, run, start, stop

Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepExecution

applyAll, applyAll, getContext, getStatusBounded

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractExecution

protected AbstractExecution(org.jenkinsci.plugins.workflow.steps.StepContext context)

Creates a new instance of AbstractExecution.

Parameters:

context - the context to use

Method Details

getRun

protected Run<?,?> getRun()
                   throws IOException,
InterruptedException

Returns the associated pipeline run.

Returns:

the run

Throws:

IOException - if the run could not be resolved

InterruptedException - if the user canceled the run

getChannel

protected Optional<hudson.remoting.VirtualChannel> getChannel()
                                                       throws IOException,
InterruptedException

Returns a VirtualChannel to the agent where this step has been executed.

Returns:

the channel

Throws:

IOException - if the computer could not be resolved

InterruptedException - if the user canceled the run

getBuildFolder

protected FilePath getBuildFolder()
                           throws IOException,
InterruptedException

Returns Jenkins' build folder.

Returns:

the build folder

Throws:

IOException - if the build folder could not be resolved

InterruptedException - if the user canceled the run

getWorkspace

protected FilePath getWorkspace()
                         throws IOException,
InterruptedException

Returns the workspace for this job. If the workspace does not yet exist, then the required folders are created.

Returns:

the workspace

Throws:

IOException - if the workspace could not be resolved

InterruptedException - if the user canceled the execution

getTaskListener

protected TaskListener getTaskListener()
                                throws InterruptedException,
IOException

Returns the TaskListener for this execution.

Returns:

the task listener (or a silent listener if no task listener could be found)

Throws:

InterruptedException - if the user canceled the execution

IOException - if the task listener could not be resolved

getCharset

protected Charset getCharset(String charset)

Returns the default charset for the specified encoding string. If the default encoding is empty or null, or if the charset is not valid, then the default encoding of the platform is returned.

Parameters:

charset - identifier of the character set

Returns:

the default charset for the specified encoding string

createStageResultHandler

@Deprecated
protected StageResultHandler createStageResultHandler()
                                               throws InterruptedException,
IOException

Deprecated.

use createResultHandler() instead

Creates a StageResultHandler that sets the overall build result of the Run.

Returns:

a StageResultHandler that sets the overall build result of the Run

Throws:

InterruptedException - if the user canceled the execution

IOException - if the required FlowNode instance is not found

createResultHandler

protected ResultHandler createResultHandler()
                                     throws InterruptedException,
IOException

Creates a ResultHandler that sets build result of the Run or stage.

Returns:

a ResultHandler that sets the build result of the Run or stage

Throws:

InterruptedException - if the user canceled the execution

IOException - if the required FlowNode instance is not found