jenkins.tasks

Interface SimpleBuildStep

All Superinterfaces:

BuildStep

All Known Implementing Classes:

ArtifactArchiver, Fingerprinter

public interface SimpleBuildStep
extends BuildStep

A build step (like a Builder or Publisher) which may be called at an arbitrary time during a build (or multiple times), run, and be done.

Such a build step would typically be written according to some guidelines that ensure it makes few assumptions about how it is being used:

• Do not implement BuildStep.prebuild(hudson.model.AbstractBuild<?, ?>, hudson.model.BuildListener), since this presupposes a particular execution order.
• Do not implement BuildStep.getProjectActions(hudson.model.AbstractProject<?, ?>), since this might never be called if the step is not part of the static configuration of a project; instead, add a SimpleBuildStep.LastBuildAction to a build when run.
• Implement BuildStep.getRequiredMonitorService() to be BuildStepMonitor.NONE, since this facility only makes sense for a step called exactly once per build.
• Do not implement DependencyDeclarer since this would be limited to use in AbstractProject.
• Return true unconditionally from BuildStepDescriptor.isApplicable(java.lang.Class<? extends hudson.model.AbstractProject>) (there is currently no filtering for other Job types).
• Do not expect Executor.currentExecutor() to be non-null, and by extension do not use Computer.currentComputer().

Since:

1.577

See Also:

BuildStepCompatibilityLayer.perform(AbstractBuild, Launcher, BuildListener)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SimpleBuildStep.LastBuildAction Marker for explicitly added build actions (as Run.addAction(hudson.model.Action)) which should imply a transient project action (Actionable.getActions()) when present on the Job.getLastSuccessfulBuild().
static class	SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Method Summary

Modifier and Type	Method and Description
default void	perform(Run<?,?> run, EnvVars env, TaskListener listener) Run this step, without a workspace context.
default void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener) Run this step.
default void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener) Deprecated. Use perform(Run, FilePath, EnvVars, Launcher, TaskListener) instead.
default boolean	requiresWorkspace() Determines whether or not this step requires a workspace context (working directory and launcher).

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Method Detail

perform

@Deprecated
default void perform(@NonNull
                                 Run<?,?> run,
                                 @NonNull
                                 FilePath workspace,
                                 @NonNull
                                 Launcher launcher,
                                 @NonNull
                                 TaskListener listener)
                          throws InterruptedException,
                                 IOException

Deprecated. Use perform(Run, FilePath, EnvVars, Launcher, TaskListener) instead.

Run this step.

Parameters:

run - a build this is running as a part of

workspace - a workspace to use for any file operations

launcher - a way to start processes

listener - a place to send output

Throws:

InterruptedException - if the step is interrupted

IOException - if something goes wrong; use AbortException for a polite error

perform

default void perform(@NonNull
                     Run<?,?> run,
                     @NonNull
                     FilePath workspace,
                     @NonNull
                     EnvVars env,
                     @NonNull
                     Launcher launcher,
                     @NonNull
                     TaskListener listener)
              throws InterruptedException,
                     IOException

Run this step.

This method must be overridden when this step requires a workspace context. If such a context is not required, it does not need to be overridden; it will then forward to perform(Run, EnvVars, TaskListener).

Parameters:

run - a build this is running as a part of

workspace - a workspace to use for any file operations

env - environment variables applicable to this step

launcher - a way to start processes

listener - a place to send output

Throws:

AbstractMethodError - if this step requires a workspace context and neither this method nor perform(Run, FilePath, Launcher, TaskListener) is overridden

InterruptedException - if the step is interrupted

IOException - if something goes wrong; use AbortException for a polite error

Since:

2.241

perform

default void perform(@NonNull
                     Run<?,?> run,
                     @NonNull
                     EnvVars env,
                     @NonNull
                     TaskListener listener)
              throws InterruptedException,
                     IOException

Run this step, without a workspace context.

This method must be overridden when this step does not require a workspace context, and will not be called when such a context is required.

Parameters:

run - a build this is running as a part of

env - environment variables applicable to this step

listener - a place to send output

Throws:

AbstractMethodError - if this method is not overridden

IllegalStateException - if this step requires a workspace context

InterruptedException - if the step is interrupted

IOException - if something goes wrong; use AbortException for a polite error

Since:

2.258

requiresWorkspace

default boolean requiresWorkspace()

Determines whether or not this step requires a workspace context (working directory and launcher).

When such a context is required (the default), perform(Run, FilePath, EnvVars, Launcher, TaskListener) applies. Otherwise, perform(Run, EnvVars, TaskListener) applies.

Returns:

true if this step requires a workspace context; false otherwise.

Since:

2.258