Uses of Interface
hudson.model.TaskListener
Package
Description
Server-side CLI commands for Hudson.
Core object model that are bound to URLs via stapler, rooted at
Jenkins
.Listener interfaces for various events that occur inside the server.
Code that monitors the health of agents
Jenkins's interface with source code management systems.
Code related to agents.
Other miscellaneous utility code
-
Uses of TaskListener in hudson
Modifier and TypeMethodDescriptionLauncher.DecoratedLauncher.getListener()
Launcher.getListener()
Gets theTaskListener
that this launcher uses to report the commands that it's executing.Modifier and TypeMethodDescriptionFilePath.createLauncher
(TaskListener listener) Creates aLauncher
for starting processes on the node that has this file.static void
Util.createSymlink
(File baseDir, String targetPath, String symlinkPath, TaskListener listener) Creates a symlink to targetPath at baseDir+symlinkPath.static void
Util.displayIOException
(IOException e, TaskListener listener) On Windows, error messages for IOException aren't very helpful.boolean
FilePath.installIfNecessaryFrom
(URL archive, TaskListener listener, String message) Given a tgz/zip file, extracts it to the given target directory, if necessary.final int
Proc.joinWithTimeout
(long timeout, TimeUnit unit, TaskListener listener) LikeProc.join()
but can be given a maximum time to wait.void
FileSystemProvisioner.Default.prepareWorkspace
(AbstractBuild<?, ?> build, FilePath ws, TaskListener listener) abstract void
FileSystemProvisioner.prepareWorkspace
(AbstractBuild<?, ?> build, FilePath ws, TaskListener listener) Deprecated.static String
Util.resolveSymlink
(File link, TaskListener listener) Deprecated.abstract void
WorkspaceSnapshot.restoreTo
(AbstractBuild<?, ?> owner, FilePath dst, TaskListener listener) Deprecated.Restores the snapshot to the given file system location.FileSystemProvisioner.Default.snapshot
(AbstractBuild<?, ?> build, FilePath ws, String glob, TaskListener listener) abstract WorkspaceSnapshot
FileSystemProvisioner.snapshot
(AbstractBuild<?, ?> build, FilePath ws, String glob, TaskListener listener) Deprecated.Launcher.ProcStarter.stdout
(TaskListener out) Sends the stdout to the givenTaskListener
.void
FilePath.symlinkTo
(String target, TaskListener listener) Creates a symlink to the specified target.ModifierConstructorDescriptionDummyLauncher
(TaskListener listener) protected
Launcher
(TaskListener listener, hudson.remoting.VirtualChannel channel) LocalLauncher
(TaskListener listener) LocalLauncher
(TaskListener listener, hudson.remoting.VirtualChannel channel) RemoteLauncher
(TaskListener listener, hudson.remoting.VirtualChannel channel, boolean isUnix) -
Uses of TaskListener in hudson.cli
-
Uses of TaskListener in hudson.logging
Modifier and TypeMethodDescriptionvoid
LogRecorder.ComputerLogInitializer.preOnline
(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) -
Uses of TaskListener in hudson.model
Modifier and TypeInterfaceDescriptioninterface
Receives events that happen during a build.Modifier and TypeFieldDescriptionstatic final TaskListener
TaskListener.NULL
TaskListener
that discards the output.Modifier and TypeMethodDescriptionComputer.buildEnvironment
(TaskListener listener) Creates an environment variable override to be used for launching processes on this node.void
EnvironmentContributor.buildEnvironmentFor
(Job j, EnvVars envs, TaskListener listener) Contributes environment variables used for a job.void
EnvironmentContributor.buildEnvironmentFor
(Run r, EnvVars envs, TaskListener listener) Contributes environment variables used for a build.abstract Launcher
Node.createLauncher
(TaskListener listener) Returns aLauncher
for executing programs on this node.Slave.createLauncher
(TaskListener listener) Creates a launcher for the agent.protected abstract void
AsyncAperiodicWork.execute
(TaskListener listener) Executes the task.protected abstract void
AsyncPeriodicWork.execute
(TaskListener listener) Executes the task.void
FingerprintCleanupThread.execute
(TaskListener listener) Initiates the cleanup of fingerprints IF enabled.protected void
WorkspaceCleanupThread.execute
(TaskListener listener) JDK.forNode
(Node node, TaskListener log) AbstractBuild.getEnvironment
(TaskListener log) AbstractProject.getEnvironment
(Node node, TaskListener listener) Job.getEnvironment
(Node node, TaskListener listener) Creates an environment variable override for launching processes for this project.Run.getEnvironment
(TaskListener listener) Returns the map that contains environmental variables to be used for launching processes for this build.void
Computer.DisplayExecutor.InternalComputerListener.onOnline
(Computer c, TaskListener listener) void
Node.InternalComputerListener.onOnline
(Computer c, TaskListener listener) protected abstract void
TaskThread.perform
(TaskListener listener) Do the actual work.AbstractProject.poll
(TaskListener listener) Checks if there's any update in SCM, and returns true if any is found.SCMedItem.poll
(TaskListener listener) Deprecated.Checks if there's any update in SCM, and returns true if any is found.boolean
AbstractProject.pollSCMChanges
(TaskListener listener) Deprecated.as of 1.346 UseAbstractProject.poll(TaskListener)
instead.boolean
SCMedItem.pollSCMChanges
(TaskListener listener) Deprecated.as of 1.346 UseSCMedItem.poll(TaskListener)
instead.void
Cause.print
(TaskListener listener) Report a line to the listener about this cause.void
Cause.UpstreamCause.print
(TaskListener listener) void
Cause.UserIdCause.print
(TaskListener listener) void
Executor.recordCauseOfInterruption
(Run<?, ?> build, TaskListener listener) report cause of interruption and record it to the build, if available.boolean
DependencyGraph.Dependency.shouldTriggerBuild
(AbstractBuild build, TaskListener listener, List<Action> actions) Decide whether build should be triggered and provide any Actions for the build.final void
Run.updateSymlinks
(TaskListener listener) Deprecated.After JENKINS-37862 this no longer does anything.ModifierConstructorDescriptionListenerAndText
(TaskListener listener, AnnotatedLargeText<TaskAction> text) -
Uses of TaskListener in hudson.model.listeners
Modifier and TypeMethodDescriptionstatic void
SCMPollListener.fireBeforePolling
(AbstractProject<?, ?> project, TaskListener listener) static void
RunListener.fireCompleted
(Run r, TaskListener listener) Fires theRunListener.onCompleted(Run, TaskListener)
event.static void
SCMPollListener.firePollingFailed
(AbstractProject<?, ?> project, TaskListener listener, Throwable exception) static void
SCMPollListener.firePollingSuccess
(AbstractProject<?, ?> project, TaskListener listener, PollingResult result) static void
RunListener.fireStarted
(Run r, TaskListener listener) Fires theRunListener.onStarted(Run, TaskListener)
event.void
SCMPollListener.onBeforePolling
(AbstractProject<?, ?> project, TaskListener listener) Called before the polling execution.void
SCMListener.onChangeLogParsed
(Run<?, ?> build, SCM scm, TaskListener listener, ChangeLogSet<?> changelog) Called once the changelog is determined.void
SCMListener.onCheckout
(Run<?, ?> build, SCM scm, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState pollingBaseline) Should be called immediately afterSCM.checkout(Run, Launcher, FilePath, TaskListener, File, SCMRevisionState)
is called.void
RunListener.onCompleted
(R r, TaskListener listener) Called after a build is completed.void
SCMPollListener.onPollingFailed
(AbstractProject<?, ?> project, TaskListener listener, Throwable exception) Called when the polling concluded with an error.void
SCMPollListener.onPollingSuccess
(AbstractProject<?, ?> project, TaskListener listener, PollingResult result) Called when the polling successfully concluded.void
RunListener.onStarted
(R r, TaskListener listener) Called when a build is started (i.e. -
Uses of TaskListener in hudson.model.queue
Modifier and TypeMethodDescriptionvoid
CauseOfBlockage.BecauseLabelIsBusy.print
(TaskListener listener) void
CauseOfBlockage.BecauseLabelIsOffline.print
(TaskListener listener) void
CauseOfBlockage.BecauseNodeIsBusy.print
(TaskListener listener) void
CauseOfBlockage.BecauseNodeIsNotAcceptingTasks.print
(TaskListener listener) void
CauseOfBlockage.BecauseNodeIsOffline.print
(TaskListener listener) void
CauseOfBlockage.print
(TaskListener listener) Report a line to the listener about this cause. -
Uses of TaskListener in hudson.node_monitors
Modifier and TypeMethodDescriptionvoid
NodeMonitorUpdater.onOnline
(Computer c, TaskListener listener) Triggers the update with 5 seconds quiet period, to avoid triggering data check too often when multiple agents become online at about the same time. -
Uses of TaskListener in hudson.os
Modifier and TypeMethodDescriptionstatic <V,
T extends Throwable>
VSU.execute
(TaskListener listener, String rootUsername, String rootPassword, hudson.remoting.Callable<V, T> closure) Starts a new privilege-escalated environment, execute a closure, and shut it down.static hudson.remoting.VirtualChannel
SU.start
(TaskListener listener, String rootUsername, String rootPassword) Returns aVirtualChannel
that's connected to the privilege-escalated environment. -
Uses of TaskListener in hudson.scm
Modifier and TypeMethodDescriptionSCM._calcRevisionsFromBuild
(AbstractBuild<?, ?> build, Launcher launcher, TaskListener listener) Deprecated.NullSCM.calcRevisionsFromBuild
(Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener) SCM.calcRevisionsFromBuild
(AbstractBuild<?, ?> build, Launcher launcher, TaskListener listener) Deprecated.SCM.calcRevisionsFromBuild
(Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener) Calculates theSCMRevisionState
that represents the state of the workspace of the given build.void
NullSCM.checkout
(Run<?, ?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline) void
SCM.checkout
(Run<?, ?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline) Obtains a fresh workspace of the module(s) into the specified directory of the specified machine.NullSCM.compareRemoteRevisionWith
(Job<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) protected PollingResult
SCM.compareRemoteRevisionWith
(AbstractProject<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) Deprecated.SCM.compareRemoteRevisionWith
(Job<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) Compares the current state of the remote repository against the given baselineSCMRevisionState
.protected final void
SCM.createEmptyChangeLog
(File changelogFile, TaskListener listener, String rootTag) final PollingResult
SCM.poll
(AbstractProject<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline) Convenience method for the caller to handle the backward compatibility between pre 1.345 SCMs.boolean
SCM.pollChanges
(AbstractProject<?, ?> project, Launcher launcher, FilePath workspace, TaskListener listener) Deprecated.as of 1.345 OverrideSCM.calcRevisionsFromBuild(AbstractBuild, Launcher, TaskListener)
andSCM.compareRemoteRevisionWith(AbstractProject, Launcher, FilePath, TaskListener, SCMRevisionState)
for implementation.void
SCM.postCheckout
(Run<?, ?> build, Launcher launcher, FilePath workspace, TaskListener listener) Get a chance to do operations after the workspace i checked out and the changelog is written. -
Uses of TaskListener in hudson.slaves
Modifier and TypeMethodDescriptionSlaveComputer.getListener()
Offers a way to write to the log file for this agent.Modifier and TypeMethodDescriptionprotected abstract void
AbstractCloudSlave._terminate
(TaskListener listener) Performs the removal of the underlying resource from the cloud.void
ComputerLauncher.afterDisconnect
(SlaveComputer computer, TaskListener listener) Allows theComputerLauncher
to tidy-up after a disconnect.void
ComputerLauncherFilter.afterDisconnect
(SlaveComputer computer, TaskListener listener) void
DelegatingComputerLauncher.afterDisconnect
(SlaveComputer computer, TaskListener listener) void
ComputerLauncher.beforeDisconnect
(SlaveComputer computer, TaskListener listener) Allows theComputerLauncher
to prepare for a disconnect.void
ComputerLauncherFilter.beforeDisconnect
(SlaveComputer computer, TaskListener listener) void
DelegatingComputerLauncher.beforeDisconnect
(SlaveComputer computer, TaskListener listener) void
EnvironmentVariablesNodeProperty.buildEnvVars
(EnvVars env, TaskListener listener) void
NodeProperty.buildEnvVars
(EnvVars env, TaskListener listener) Creates environment variable override for launching child processes in this node.protected void
ConnectionActivityMonitor.execute
(TaskListener listener) NodeSpecific.forNode
(Node node, TaskListener log) Returns a specialized copy of T for functioning in the given node.abstract ComputerLauncher
ComputerConnector.launch
(String host, TaskListener listener) Creates aComputerLauncher
for connecting to the given host.void
ComputerLauncher.launch
(SlaveComputer computer, TaskListener listener) Launches the agent for the givenComputer
.void
ComputerLauncherFilter.launch
(SlaveComputer computer, TaskListener listener) void
DelegatingComputerLauncher.launch
(SlaveComputer computer, TaskListener listener) void
JNLPLauncher.launch
(SlaveComputer computer, TaskListener listener) static hudson.remoting.Channel
Channels.newJVM
(String displayName, TaskListener listener, FilePath workDir, ClasspathBuilder classpath, Map<String, String> systemProperties) Deprecated.removed without replacementstatic hudson.remoting.Channel
Channels.newJVM
(String displayName, TaskListener listener, JVMBuilder vmb, FilePath workDir, ClasspathBuilder classpath) Deprecated.removed without replacementvoid
ComputerListener.onLaunchFailure
(Computer c, TaskListener taskListener) Called when an agent attempted to connect viaComputerLauncher
but it failed.void
ComputerListener.onOnline
(Computer c, TaskListener listener) Called right after aComputer
comes online.void
ComputerListener.preLaunch
(Computer c, TaskListener taskListener) Called before aComputerLauncher
is asked to launch a connection withComputer
.void
ChannelPinger.preOnline
(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) void
ComputerListener.preOnline
(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) Called before aComputer
is marked online.void
SlaveComputer.setChannel
(InputStream in, OutputStream out, TaskListener taskListener, hudson.remoting.Channel.Listener listener) Creates aChannel
from the given stream and sets that to this agent. -
Uses of TaskListener in hudson.tasks
Modifier and TypeMethodDescriptionMaven.MavenInstallation.forNode
(Node node, TaskListener log) void
ArtifactArchiver.perform
(Run<?, ?> build, FilePath ws, EnvVars environment, Launcher launcher, TaskListener listener) boolean
CommandInterpreter.perform
(AbstractBuild<?, ?> build, Launcher launcher, TaskListener listener) void
Fingerprinter.perform
(Run<?, ?> build, FilePath workspace, EnvVars environment, Launcher launcher, TaskListener listener) -
Uses of TaskListener in hudson.tools
Modifier and TypeMethodDescriptionInstallerTranslator.getToolHome
(Node node, ToolInstallation tool, TaskListener log) static String
ToolLocationNodeProperty.getToolHome
(Node node, ToolInstallation installation, TaskListener log) Deprecated.since 2009-04-09.abstract String
ToolLocationTranslator.getToolHome
(Node node, ToolInstallation installation, TaskListener log) Called for eachToolInstallation.translateFor(Node, TaskListener)
invocations (which normally means it's invoked for eachNodeSpecific.forNode(Node, TaskListener)
) to translate the tool location into the node specific location.AbstractCommandInstaller.performInstallation
(ToolInstallation tool, Node node, TaskListener log) DownloadFromUrlInstaller.performInstallation
(ToolInstallation tool, Node node, TaskListener log) abstract FilePath
ToolInstaller.performInstallation
(ToolInstallation tool, Node node, TaskListener log) Ensure that the configured tool is really installed.ZipExtractionInstaller.performInstallation
(ToolInstallation tool, Node node, TaskListener log) ToolInstallation.translate
(AbstractBuild<?, ?> buildInProgress, TaskListener listener) Convenient version ofToolInstallation.translate(Node, EnvVars, TaskListener)
that just takes a build object in progress.ToolInstallation.translate
(Node node, EnvVars envs, TaskListener listener) Performs a necessary variable/environment/context expansion.protected String
ToolInstallation.translateFor
(Node node, TaskListener log) Finds a tool on a node. -
Uses of TaskListener in hudson.util
Modifier and TypeClassDescriptionclass
Deprecated.implementTaskListener
directlyclass
TaskListener
which sends messages to aLogger
.class
TaskListener
that generates output into a single stream. -
Uses of TaskListener in jenkins
-
Uses of TaskListener in jenkins.fingerprints
Modifier and TypeMethodDescriptionboolean
FingerprintStorage.cleanFingerprint
(Fingerprint fingerprint, TaskListener taskListener) This method performs the cleanup of the given fingerprint.void
FileFingerprintStorage.iterateAndCleanupFingerprints
(TaskListener taskListener) Perform Fingerprint cleanup.abstract void
FingerprintStorage.iterateAndCleanupFingerprints
(TaskListener taskListener) Iterates a set of fingerprints, and cleans them up. -
Uses of TaskListener in jenkins.management
Modifier and TypeMethodDescriptionprotected abstract void
AsynchronousAdministrativeMonitor.fix
(TaskListener listener) Run on a separate thread in the background to fix up stuff. -
Uses of TaskListener in jenkins.model
Modifier and TypeMethodDescriptionvoid
CoreEnvironmentContributor.buildEnvironmentFor
(Job j, EnvVars env, TaskListener listener) void
CoreEnvironmentContributor.buildEnvironmentFor
(Run r, EnvVars env, TaskListener listener) Jenkins.createLauncher
(TaskListener listener) protected void
BackgroundGlobalBuildDiscarder.execute
(TaskListener listener) void
PeepholePermalink.RunListenerImpl.onCompleted
(Run<?, ?> run, TaskListener listener) See if the new build matches any of the peephole permalink.void
CauseOfInterruption.print
(TaskListener listener) Report a line to the listener about this cause.void
CauseOfInterruption.UserInterruption.print
(TaskListener listener) static void
BackgroundGlobalBuildDiscarder.processJob
(TaskListener listener, Job job) -
Uses of TaskListener in jenkins.model.queue
-
Uses of TaskListener in jenkins.mvn
Modifier and TypeMethodDescriptionstatic FilePath
GlobalSettingsProvider.getSettingsFilePath
(GlobalSettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnull
checks.static FilePath
SettingsProvider.getSettingsFilePath
(SettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnull
checks.static String
GlobalSettingsProvider.getSettingsRemotePath
(GlobalSettingsProvider provider, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnull
checks.static String
SettingsProvider.getSettingsRemotePath
(SettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnull
checks.DefaultGlobalSettingsProvider.supplySettings
(AbstractBuild<?, ?> project, TaskListener listener) DefaultSettingsProvider.supplySettings
(AbstractBuild<?, ?> project, TaskListener listener) FilePathGlobalSettingsProvider.supplySettings
(AbstractBuild<?, ?> build, TaskListener listener) FilePathSettingsProvider.supplySettings
(AbstractBuild<?, ?> build, TaskListener listener) abstract FilePath
GlobalSettingsProvider.supplySettings
(AbstractBuild<?, ?> build, TaskListener listener) configure maven launcher argument list with adequate settings pathabstract FilePath
SettingsProvider.supplySettings
(AbstractBuild<?, ?> build, TaskListener listener) Configure maven launcher argument list with adequate settings path. -
Uses of TaskListener in jenkins.slaves
Modifier and TypeMethodDescriptionvoid
StandardOutputSwapper.preOnline
(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) -
Uses of TaskListener in jenkins.slaves.restarter
Modifier and TypeMethodDescriptionvoid
JnlpSlaveRestarterInstaller.onOnline
(Computer c, TaskListener listener) -
Uses of TaskListener in jenkins.tasks
Modifier and TypeMethodDescriptiondefault void
SimpleBuildStep.perform
(Run<?, ?> run, EnvVars env, TaskListener listener) Run this step, without a workspace context.default void
SimpleBuildStep.perform
(Run<?, ?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener) Run this step.default void
SimpleBuildStep.perform
(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener) Deprecated.void
SimpleBuildWrapper.setUp
(SimpleBuildWrapper.Context context, Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener, EnvVars initialEnvironment) Called when a segment of a build is started that is to be enhanced with this wrapper.void
SimpleBuildWrapper.setUp
(SimpleBuildWrapper.Context context, Run<?, ?> build, TaskListener listener, EnvVars initialEnvironment) Called when a segment of a build is started that is to be enhanced with this wrapper.void
SimpleBuildWrapper.Disposer.tearDown
(Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener) Attempt to clean up anything that was done in the initial setup.void
SimpleBuildWrapper.Disposer.tearDown
(Run<?, ?> build, TaskListener listener) Attempt to clean up anything that was done in the initial setup. -
Uses of TaskListener in jenkins.tasks.filters
Modifier and TypeMethodDescriptionvoid
EnvVarsFilterRuleWrapper.filter
(EnvVars envVars, Launcher launcher, TaskListener listener) ModifierConstructorDescriptionEnvVarsFilterRuleContext
(Launcher launcher, TaskListener taskListener) -
Uses of TaskListener in jenkins.telemetry
Modifier and TypeMethodDescriptionprotected void
Telemetry.TelemetryReporter.execute
(TaskListener listener) -
Uses of TaskListener in jenkins.triggers
Modifier and TypeMethodDescriptionvoid
ReverseBuildTrigger.RunListenerImpl.onCompleted
(Run r, TaskListener listener) SCMTriggerItem.poll
(TaskListener listener) Checks if there is any update in SCM. -
Uses of TaskListener in jenkins.util
Modifier and TypeClassDescriptionfinal class
Wraps aTaskListener
as aBuildListener
for compatibility with APIs which historically expected the latter.Modifier and TypeMethodDescriptionvoid
SystemProperties.AgentCopier.preOnline
(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) static BuildListener
BuildListenerAdapter.wrap
(TaskListener l)
Util.resolveSymlink(File)