Package org.jenkinsci.plugins.workflow.steps

Class CatchErrorStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.CatchErrorStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable, CatchExecutionOptions

public final class CatchErrorStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements CatchExecutionOptions

Runs a block. By default, if that block fails, marks the build as failed, but continues execution. Can be customized to print a message when the block fails, to set a different build result, to annotate the step with WarningAction for advanced visualizations, or to rethrow FlowInterruptedException rather than continuing execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CatchErrorStep.DescriptorImpl
static class	CatchErrorStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
CatchErrorStep()

Method Summary

Modifier and Type	Method	Description
String	getBuildResult()
Result	getBuildResultOnError()	The result that will be used for setting the build result if an error is caught.
String	getMessage()	A message to be printed when an error is caught.
String	getStageResult()
Result	getStepResultOnError()	The result that will be used for annotating the with WarningAction) if an error is caught.
boolean	isCatchInterruptions()	Whether FlowInterruptedException should be caught and handled by the step or rethrown.
void	setBuildResult(String buildResult)
void	setCatchInterruptions(boolean catchInterruptions)
void	setMessage(String message)
void	setStageResult(String stageResult)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

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

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

CatchErrorStep

@DataBoundConstructor
public CatchErrorStep()

Method Detail

getMessage

@CheckForNull
public String getMessage()

Description copied from interface: CatchExecutionOptions

A message to be printed when an error is caught. If CatchExecutionOptions.getStepResultOnError() (by adding a WarningAction)

Specified by:

getMessage in interface CatchExecutionOptions

setMessage

@DataBoundSetter
public void setMessage(String message)

getBuildResultOnError

@NonNull
public Result getBuildResultOnError()

Description copied from interface: CatchExecutionOptions

The result that will be used for setting the build result if an error is caught. Return Result.SUCCESS to leave the build result unchanged. If CatchExecutionOptions.isCatchInterruptions() returns true, then if a FlowInterruptedException is caught, its result will be used instead of this value.

Specified by:

getBuildResultOnError in interface CatchExecutionOptions

getBuildResult

@NonNull
public String getBuildResult()

setBuildResult

@DataBoundSetter
public void setBuildResult(String buildResult)

getStepResultOnError

@NonNull
public Result getStepResultOnError()

Description copied from interface: CatchExecutionOptions

The result that will be used for annotating the with WarningAction) if an error is caught. Return Result.SUCCESS to leave the step result unchanged. If CatchExecutionOptions.isCatchInterruptions() returns true, then if a FlowInterruptedException is caught, its result will be used instead of this value.

Specified by:

getStepResultOnError in interface CatchExecutionOptions

getStageResult

@NonNull
public String getStageResult()

setStageResult

@DataBoundSetter
public void setStageResult(String stageResult)

isCatchInterruptions

public boolean isCatchInterruptions()

Description copied from interface: CatchExecutionOptions

Whether FlowInterruptedException should be caught and handled by the step or rethrown. FlowInterruptedException is commonly used to control the flow of execution for things like builds aborted by a user and builds that time out inside of TimeoutStep. It is sometimes desirable to rethrow these kinds of exceptions rather than catching them so as to not interfere with their intended behavior.

Specified by:

isCatchInterruptions in interface CatchExecutionOptions

setCatchInterruptions

@DataBoundSetter
public void setCatchInterruptions(boolean catchInterruptions)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception