@Deprecated public abstract class BuildStepCompatibilityLayer extends Object implements BuildStep
BuildStep
before 1.150
so that old plugin binaries can continue to function with new Hudson.BuildStep.PublisherList
BUILDERS, PUBLISHERS
Constructor and Description |
---|
BuildStepCompatibilityLayer()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Action |
getProjectAction(AbstractProject<?,?> project)
Deprecated.
|
Action |
getProjectAction(Project<?,?> project)
Deprecated.
Use
getProjectAction(AbstractProject) instead. |
Collection<? extends Action> |
getProjectActions(AbstractProject<?,?> project)
Deprecated.
|
boolean |
perform(AbstractBuild<?,?> build,
Launcher launcher,
BuildListener listener)
Deprecated.
Runs the step over the given build and reports the progress to the listener.
|
boolean |
perform(Build<?,?> build,
Launcher launcher,
BuildListener listener)
Deprecated.
Use
perform(AbstractBuild, Launcher, BuildListener) instead. |
boolean |
prebuild(AbstractBuild<?,?> build,
BuildListener listener)
Deprecated.
Runs before the build begins.
|
boolean |
prebuild(Build<?,?> build,
BuildListener listener)
Deprecated.
Use
prebuild(AbstractBuild, BuildListener) instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRequiredMonitorService
public boolean prebuild(AbstractBuild<?,?> build, BuildListener listener)
BuildStep
prebuild
in interface BuildStep
Using the return value to indicate success/failure should
be considered deprecated, and implementations are encouraged
to throw AbortException
to indicate a failure.
public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException
BuildStep
A plugin can contribute the action object to Actionable.getActions()
so that a 'report' becomes a part of the persisted data of Build
.
This is how JUnit plugin attaches the test report to a build page, for example.
When this build step needs to make (direct or indirect) permission checks to ACL
(for example, to locate other projects by name, build them, or access their artifacts)
then it must be run under a specific Authentication
.
In such a case, the implementation should check whether Jenkins.getAuthentication2()
is ACL.SYSTEM2
,
and if so, replace it for the duration of this step with Jenkins.ANONYMOUS
.
(Either using ACL.impersonate2(org.springframework.security.core.Authentication)
, or by making explicit calls to ACL.hasPermission2(Authentication, Permission)
.)
This would typically happen when no QueueItemAuthenticator
was available, configured, and active.
perform
in interface BuildStep
SimpleBuildStep.perform(Run, FilePath, Launcher, TaskListener)
if possible, always returning true or throwing an error.InterruptedException
- If the build is interrupted by the user (in an attempt to abort the build.)
Normally the BuildStep
implementations may simply forward the exception
it got from its lower-level functions.IOException
- If the implementation wants to abort the processing when an IOException
happens, it can simply propagate the exception to the caller. This will cause
the build to fail, with the default error message.
Implementations are encouraged to catch IOException
on its own to
provide a better error message, if it can do so, so that users have better
understanding on why it failed.public Action getProjectAction(AbstractProject<?,?> project)
getProjectAction
in interface BuildStep
@NonNull public Collection<? extends Action> getProjectActions(AbstractProject<?,?> project)
BuildStep
BuildStep
has actions
to contribute to a Project
.
Project
calls this method for every BuildStep
that
it owns when the rendering is requested.
This action can have optional jobMain.jelly
view, which will be
aggregated into the main panel of the job top page. The jelly file
should have an <h2>
tag that shows the section title, followed by some
block elements to render the details of the section.
getProjectActions
in interface BuildStep
project
- Project
that owns this build step,
since BuildStep
object doesn't usually have this "parent" pointer.@Deprecated public boolean prebuild(Build<?,?> build, BuildListener listener)
prebuild(AbstractBuild, BuildListener)
instead.@Deprecated public boolean perform(Build<?,?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException
perform(AbstractBuild, Launcher, BuildListener)
instead.InterruptedException
IOException
@Deprecated public Action getProjectAction(Project<?,?> project)
getProjectAction(AbstractProject)
instead.Copyright © 2004–2021. All rights reserved.