Uses of Interface
hudson.model.TaskListener
Packages that use 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
Fields in hudson declared as TaskListenerMethods in hudson that return TaskListenerModifier and TypeMethodDescriptionLauncher.DecoratedLauncher.getListener()Launcher.getListener()Gets theTaskListenerthat this launcher uses to report the commands that it's executing.Methods in hudson with parameters of type TaskListenerModifier and TypeMethodDescriptionFilePath.createLauncher(TaskListener listener) Creates aLauncherfor starting processes on the node that has this file.static voidUtil.createSymlink(File baseDir, String targetPath, String symlinkPath, TaskListener listener) Creates a symlink to targetPath at baseDir+symlinkPath.static voidUtil.displayIOException(IOException e, TaskListener listener) On Windows, error messages for IOException aren't very helpful.booleanFilePath.installIfNecessaryFrom(URL archive, TaskListener listener, String message) Given a tgz/zip file, extracts it to the given target directory, if necessary.final intProc.joinWithTimeout(long timeout, TimeUnit unit, TaskListener listener) LikeProc.join()but can be given a maximum time to wait.voidFileSystemProvisioner.Default.prepareWorkspace(AbstractBuild<?, ?> build, FilePath ws, TaskListener listener) abstract voidFileSystemProvisioner.prepareWorkspace(AbstractBuild<?, ?> build, FilePath ws, TaskListener listener) Deprecated.static StringUtil.resolveSymlink(File link, TaskListener listener) Deprecated.abstract voidWorkspaceSnapshot.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 WorkspaceSnapshotFileSystemProvisioner.snapshot(AbstractBuild<?, ?> build, FilePath ws, String glob, TaskListener listener) Deprecated.Launcher.ProcStarter.stdout(TaskListener out) Sends the stdout to the givenTaskListener.voidFilePath.symlinkTo(String target, TaskListener listener) Creates a symlink to the specified target.Constructors in hudson with parameters of type TaskListenerModifierConstructorDescriptionDummyLauncher(TaskListener listener) protectedLauncher(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
Methods in hudson.cli with parameters of type TaskListener -
Uses of TaskListener in hudson.logging
Methods in hudson.logging with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidLogRecorder.ComputerLogInitializer.preOnline(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) -
Uses of TaskListener in hudson.model
Subinterfaces of TaskListener in hudson.modelModifier and TypeInterfaceDescriptioninterfaceReceives events that happen during a build.Classes in hudson.model that implement TaskListenerFields in hudson.model declared as TaskListenerModifier and TypeFieldDescriptionstatic final TaskListenerTaskListener.NULLTaskListenerthat discards the output.Methods in hudson.model with parameters of type TaskListenerModifier and TypeMethodDescriptionComputer.buildEnvironment(TaskListener listener) Creates an environment variable override to be used for launching processes on this node.voidEnvironmentContributor.buildEnvironmentFor(Job j, EnvVars envs, TaskListener listener) Contributes environment variables used for a job.voidEnvironmentContributor.buildEnvironmentFor(Run r, EnvVars envs, TaskListener listener) Contributes environment variables used for a build.abstract LauncherNode.createLauncher(TaskListener listener) Returns aLauncherfor executing programs on this node.Slave.createLauncher(TaskListener listener) Creates a launcher for the agent.protected abstract voidAsyncAperiodicWork.execute(TaskListener listener) Executes the task.protected abstract voidAsyncPeriodicWork.execute(TaskListener listener) Executes the task.voidFingerprintCleanupThread.execute(TaskListener listener) Initiates the cleanup of fingerprints IF enabled.protected voidWorkspaceCleanupThread.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.voidComputer.InternalComputerListener.onOnline(Computer c, TaskListener listener) protected abstract voidTaskThread.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.booleanAbstractProject.pollSCMChanges(TaskListener listener) Deprecated.as of 1.346 UseAbstractProject.poll(TaskListener)instead.booleanSCMedItem.pollSCMChanges(TaskListener listener) Deprecated.as of 1.346 UseSCMedItem.poll(TaskListener)instead.voidCause.print(TaskListener listener) Report a line to the listener about this cause.voidCause.UpstreamCause.print(TaskListener listener) voidCause.UserIdCause.print(TaskListener listener) voidExecutor.recordCauseOfInterruption(Run<?, ?> build, TaskListener listener) report cause of interruption and record it to the build, if available.booleanDependencyGraph.Dependency.shouldTriggerBuild(AbstractBuild build, TaskListener listener, List<Action> actions) Decide whether build should be triggered and provide any Actions for the build.final voidRun.updateSymlinks(TaskListener listener) Deprecated.After JENKINS-37862 this no longer does anything.Constructors in hudson.model with parameters of type TaskListenerModifierConstructorDescriptionListenerAndText(TaskListener listener, AnnotatedLargeText<TaskAction> text) -
Uses of TaskListener in hudson.model.listeners
Methods in hudson.model.listeners with parameters of type TaskListenerModifier and TypeMethodDescriptionstatic voidSCMPollListener.fireBeforePolling(AbstractProject<?, ?> project, TaskListener listener) static voidRunListener.fireCompleted(Run r, TaskListener listener) Fires theRunListener.onCompleted(Run, TaskListener)event.static voidSCMPollListener.firePollingFailed(AbstractProject<?, ?> project, TaskListener listener, Throwable exception) static voidSCMPollListener.firePollingSuccess(AbstractProject<?, ?> project, TaskListener listener, PollingResult result) static voidRunListener.fireStarted(Run r, TaskListener listener) Fires theRunListener.onStarted(Run, TaskListener)event.voidSCMPollListener.onBeforePolling(AbstractProject<?, ?> project, TaskListener listener) Called before the polling execution.voidSCMListener.onChangeLogParsed(Run<?, ?> build, SCM scm, TaskListener listener, ChangeLogSet<?> changelog) Called once the changelog is determined.voidSCMListener.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.voidRunListener.onCompleted(R r, TaskListener listener) Called after a build is completed.voidSCMPollListener.onPollingFailed(AbstractProject<?, ?> project, TaskListener listener, Throwable exception) Called when the polling concluded with an error.voidSCMPollListener.onPollingSuccess(AbstractProject<?, ?> project, TaskListener listener, PollingResult result) Called when the polling successfully concluded.voidRunListener.onStarted(R r, TaskListener listener) Called when a build is started (i.e. -
Uses of TaskListener in hudson.model.queue
Methods in hudson.model.queue with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidCauseOfBlockage.BecauseLabelIsBusy.print(TaskListener listener) voidCauseOfBlockage.BecauseLabelIsOffline.print(TaskListener listener) voidCauseOfBlockage.BecauseNodeIsBusy.print(TaskListener listener) voidCauseOfBlockage.BecauseNodeIsNotAcceptingTasks.print(TaskListener listener) voidCauseOfBlockage.BecauseNodeIsOffline.print(TaskListener listener) voidCauseOfBlockage.print(TaskListener listener) Report a line to the listener about this cause. -
Uses of TaskListener in hudson.node_monitors
Methods in hudson.node_monitors with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidNodeMonitorUpdater.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.scm
Methods in hudson.scm with parameters of type TaskListenerModifier 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 theSCMRevisionStatethat represents the state of the workspace of the given build.voidNullSCM.checkout(Run<?, ?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline) voidSCM.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 PollingResultSCM.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 voidSCM.createEmptyChangeLog(File changelogFile, TaskListener listener, String rootTag) final PollingResultSCM.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.booleanSCM.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.voidSCM.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
Methods in hudson.slaves that return TaskListenerModifier and TypeMethodDescriptionSlaveComputer.getListener()Offers a way to write to the log file for this agent.Methods in hudson.slaves with parameters of type TaskListenerModifier and TypeMethodDescriptionprotected abstract voidAbstractCloudSlave._terminate(TaskListener listener) Performs the removal of the underlying resource from the cloud.voidComputerLauncher.afterDisconnect(SlaveComputer computer, TaskListener listener) Allows theComputerLauncherto tidy-up after a disconnect.voidComputerLauncherFilter.afterDisconnect(SlaveComputer computer, TaskListener listener) voidDelegatingComputerLauncher.afterDisconnect(SlaveComputer computer, TaskListener listener) voidComputerLauncher.beforeDisconnect(SlaveComputer computer, TaskListener listener) Allows theComputerLauncherto prepare for a disconnect.voidComputerLauncherFilter.beforeDisconnect(SlaveComputer computer, TaskListener listener) voidDelegatingComputerLauncher.beforeDisconnect(SlaveComputer computer, TaskListener listener) voidEnvironmentVariablesNodeProperty.buildEnvVars(EnvVars env, TaskListener listener) voidNodeProperty.buildEnvVars(EnvVars env, TaskListener listener) Creates environment variable override for launching child processes in this node.protected voidConnectionActivityMonitor.execute(TaskListener listener) NodeSpecific.forNode(Node node, TaskListener log) Returns a specialized copy of T for functioning in the given node.abstract ComputerLauncherComputerConnector.launch(String host, TaskListener listener) Creates aComputerLauncherfor connecting to the given host.voidComputerLauncher.launch(SlaveComputer computer, TaskListener listener) Launches the agent for the givenComputer.voidComputerLauncherFilter.launch(SlaveComputer computer, TaskListener listener) voidDelegatingComputerLauncher.launch(SlaveComputer computer, TaskListener listener) voidJNLPLauncher.launch(SlaveComputer computer, TaskListener listener) static hudson.remoting.ChannelChannels.newJVM(String displayName, TaskListener listener, FilePath workDir, ClasspathBuilder classpath, Map<String, String> systemProperties) Deprecated.removed without replacementstatic hudson.remoting.ChannelChannels.newJVM(String displayName, TaskListener listener, JVMBuilder vmb, FilePath workDir, ClasspathBuilder classpath) Deprecated.removed without replacementvoidComputerListener.onLaunchFailure(Computer c, TaskListener taskListener) Called when an agent attempted to connect viaComputerLauncherbut it failed.voidComputerListener.onOnline(Computer c, TaskListener listener) Called right after aComputercomes online.voidComputerListener.preLaunch(Computer c, TaskListener taskListener) Called before aComputerLauncheris asked to launch a connection withComputer.voidChannelPinger.preOnline(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) voidComputerListener.preOnline(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) Called before aComputeris marked online.voidSlaveComputer.setChannel(InputStream in, OutputStream out, TaskListener taskListener, hudson.remoting.Channel.Listener listener) Creates aChannelfrom the given stream and sets that to this agent. -
Uses of TaskListener in hudson.tasks
Methods in hudson.tasks with parameters of type TaskListenerModifier and TypeMethodDescriptionMaven.MavenInstallation.forNode(Node node, TaskListener log) voidArtifactArchiver.perform(Run<?, ?> build, FilePath ws, EnvVars environment, Launcher launcher, TaskListener listener) booleanCommandInterpreter.perform(AbstractBuild<?, ?> build, Launcher launcher, TaskListener listener) voidFingerprinter.perform(Run<?, ?> build, FilePath workspace, EnvVars environment, Launcher launcher, TaskListener listener) -
Uses of TaskListener in hudson.tools
Methods in hudson.tools with parameters of type TaskListenerModifier and TypeMethodDescriptionInstallerTranslator.getToolHome(Node node, ToolInstallation tool, TaskListener log) static StringToolLocationNodeProperty.getToolHome(Node node, ToolInstallation installation, TaskListener log) Deprecated.since 2009-04-09.abstract StringToolLocationTranslator.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 FilePathToolInstaller.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 StringToolInstallation.translateFor(Node node, TaskListener log) Finds a tool on a node. -
Uses of TaskListener in hudson.util
Classes in hudson.util that implement TaskListenerModifier and TypeClassDescriptionclassDeprecated.implementTaskListenerdirectlyclassTaskListenerwhich sends messages to aLogger.classTaskListenerthat generates output into a single stream. -
Uses of TaskListener in jenkins
Methods in jenkins with parameters of type TaskListener -
Uses of TaskListener in jenkins.fingerprints
Methods in jenkins.fingerprints with parameters of type TaskListenerModifier and TypeMethodDescriptionbooleanFingerprintStorage.cleanFingerprint(Fingerprint fingerprint, TaskListener taskListener) This method performs the cleanup of the given fingerprint.voidFileFingerprintStorage.iterateAndCleanupFingerprints(TaskListener taskListener) Perform Fingerprint cleanup.abstract voidFingerprintStorage.iterateAndCleanupFingerprints(TaskListener taskListener) Iterates a set of fingerprints, and cleans them up. -
Uses of TaskListener in jenkins.management
Methods in jenkins.management with parameters of type TaskListenerModifier and TypeMethodDescriptionprotected abstract voidAsynchronousAdministrativeMonitor.fix(TaskListener listener) Run on a separate thread in the background to fix up stuff. -
Uses of TaskListener in jenkins.model
Methods in jenkins.model with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidCoreEnvironmentContributor.buildEnvironmentFor(Job j, EnvVars env, TaskListener listener) voidCoreEnvironmentContributor.buildEnvironmentFor(Run r, EnvVars env, TaskListener listener) Jenkins.createLauncher(TaskListener listener) protected voidBackgroundGlobalBuildDiscarder.execute(TaskListener listener) voidPeepholePermalink.RunListenerImpl.onCompleted(Run<?, ?> run, TaskListener listener) See if the new build matches any of the peephole permalink.voidCauseOfInterruption.print(TaskListener listener) Report a line to the listener about this cause.voidCauseOfInterruption.UserInterruption.print(TaskListener listener) static voidBackgroundGlobalBuildDiscarder.processJob(TaskListener listener, Job job) Runs all globally configured build discarders against a job.static voidBackgroundGlobalBuildDiscarder.processJob(TaskListener listener, Job job, Stream<GlobalBuildDiscarderStrategy> strategies) Runs the specified build discarders against a job. -
Uses of TaskListener in jenkins.model.queue
Methods in jenkins.model.queue with parameters of type TaskListener -
Uses of TaskListener in jenkins.mvn
Methods in jenkins.mvn with parameters of type TaskListenerModifier and TypeMethodDescriptionstatic FilePathGlobalSettingsProvider.getSettingsFilePath(GlobalSettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnullchecks.static FilePathSettingsProvider.getSettingsFilePath(SettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnullchecks.static StringGlobalSettingsProvider.getSettingsRemotePath(GlobalSettingsProvider provider, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnullchecks.static StringSettingsProvider.getSettingsRemotePath(SettingsProvider settings, AbstractBuild<?, ?> build, TaskListener listener) Convenience method handling allnullchecks.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 FilePathGlobalSettingsProvider.supplySettings(AbstractBuild<?, ?> build, TaskListener listener) configure maven launcher argument list with adequate settings pathabstract FilePathSettingsProvider.supplySettings(AbstractBuild<?, ?> build, TaskListener listener) Configure maven launcher argument list with adequate settings path. -
Uses of TaskListener in jenkins.slaves
Methods in jenkins.slaves with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidStandardOutputSwapper.preOnline(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) -
Uses of TaskListener in jenkins.slaves.restarter
Methods in jenkins.slaves.restarter with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidJnlpSlaveRestarterInstaller.onOnline(Computer c, TaskListener listener) -
Uses of TaskListener in jenkins.tasks
Methods in jenkins.tasks with parameters of type TaskListenerModifier and TypeMethodDescriptiondefault voidSimpleBuildStep.perform(Run<?, ?> run, EnvVars env, TaskListener listener) Run this step, without a workspace context.default voidSimpleBuildStep.perform(Run<?, ?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener) Run this step.default voidSimpleBuildStep.perform(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener) Deprecated.voidSimpleBuildWrapper.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.voidSimpleBuildWrapper.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.voidSimpleBuildWrapper.Disposer.tearDown(Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener) Attempt to clean up anything that was done in the initial setup.voidSimpleBuildWrapper.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
Methods in jenkins.tasks.filters that return TaskListenerMethods in jenkins.tasks.filters with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidEnvVarsFilterRuleWrapper.filter(EnvVars envVars, Launcher launcher, TaskListener listener) Constructors in jenkins.tasks.filters with parameters of type TaskListenerModifierConstructorDescriptionEnvVarsFilterRuleContext(Launcher launcher, TaskListener taskListener) -
Uses of TaskListener in jenkins.telemetry
Methods in jenkins.telemetry with parameters of type TaskListenerModifier and TypeMethodDescriptionprotected voidTelemetry.TelemetryReporter.execute(TaskListener listener) -
Uses of TaskListener in jenkins.triggers
Methods in jenkins.triggers with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidReverseBuildTrigger.RunListenerImpl.onCompleted(Run r, TaskListener listener) SCMTriggerItem.poll(TaskListener listener) Checks if there is any update in SCM. -
Uses of TaskListener in jenkins.util
Classes in jenkins.util that implement TaskListenerModifier and TypeClassDescriptionfinal classWraps aTaskListeneras aBuildListenerfor compatibility with APIs which historically expected the latter.Methods in jenkins.util with parameters of type TaskListenerModifier and TypeMethodDescriptionvoidSystemProperties.AgentCopier.preOnline(Computer c, hudson.remoting.Channel channel, FilePath root, TaskListener listener) static BuildListenerBuildListenerAdapter.wrap(TaskListener l) Constructors in jenkins.util with parameters of type TaskListener
Util.resolveSymlink(File)