Package io.jenkins.plugins.util

Klasse AbstractExecution<T>

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

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

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

Typparameter:

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

Alle implementierten Schnittstellen:

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.

Autor:

Ullrich Hafner

Siehe auch:

• Serialisierte Form

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AbstractExecution(org.jenkinsci.plugins.workflow.steps.StepContext context)	Creates a new instance of AbstractExecution.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected ResultHandler	createResultHandler()	Creates a ResultHandler that sets build result of the Run or stage.
protected StageResultHandler	createStageResultHandler()	Veraltet. 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.

Von Klasse geerbte Methoden org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution

blocksRestart, getStatus, onResume, run, start, stop

Von Klasse geerbte Methoden org.jenkinsci.plugins.workflow.steps.StepExecution

applyAll, applyAll, getContext, getStatusBounded

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

AbstractExecution

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

Creates a new instance of AbstractExecution.

Parameter:

context - the context to use

Methodendetails

getRun

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

Returns the associated pipeline run.

Gibt zurück:

the run

Löst aus:

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.

Gibt zurück:

the channel

Löst aus:

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.

Gibt zurück:

the build folder

Löst aus:

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.

Gibt zurück:

the workspace

Löst aus:

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.

Gibt zurück:

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

Löst aus:

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.

Parameter:

charset - identifier of the character set

Gibt zurück:

the default charset for the specified encoding string

createStageResultHandler

@Deprecated
protected StageResultHandler createStageResultHandler()
                                               throws InterruptedException,
IOException

Veraltet.

use createResultHandler() instead

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

Gibt zurück:

a StageResultHandler that sets the overall build result of the Run

Löst aus:

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.

Gibt zurück:

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

Löst aus:

InterruptedException - if the user canceled the execution

IOException - if the required FlowNode instance is not found