hudson.model.listeners
Class SCMListener

java.lang.Object
  hudson.model.listeners.SCMListener

All Implemented Interfaces:

ExtensionPoint

public abstract class SCMListener
extends Object
implements ExtensionPoint

Receives notifications about SCM activities in Hudson.

This is an abstract class so that methods added in the future won't break existing listeners.

Once instanciated, use the register() method to start receiving events.

Since:

1.70

Author:

Kohsuke Kawaguchi

See Also:

Jenkins.getSCMListeners()

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

SCMListener()

Method Summary

void	onChangeLogParsed(AbstractBuild<?,?> build, BuildListener listener, ChangeLogSet<?> changelog) Called once the changelog is determined.
void	register() Registers this SCMListener so that it will start receiving events.
boolean	unregister() Unregisters this SCMListener so that it will never receive further events.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMListener

public SCMListener()

Method Detail

onChangeLogParsed

public void onChangeLogParsed(AbstractBuild<?,?> build,
                              BuildListener listener,
                              ChangeLogSet<?> changelog)
                       throws Exception

Called once the changelog is determined.

During a build, Jenkins fetches the update of the workspace from SCM, and determines the changelog (see SCM.checkout(hudson.model.AbstractBuild, hudson.Launcher, hudson.FilePath, hudson.model.BuildListener, java.io.File)). Immediately after that, a build will invoke this method on all registered SCMListeners.

If a build failed before we successfully determine changelog, this method will not be invoked (for example, if "cvs update" failed.) OTOH, this method is invoked before the actual build (like ant invocation) happens.

This is an opportunity for SCM-related plugins to act on changelog. A typical usage includes parsing commit messages and do cross-referencing between other systems. Implementations can also contribute Action to AbstractBuild (by build.getActions().add(...) to display additional data on build views.

TODO: once we have cvsnews plugin, refer to its usage.

Parameters:

build - The build in progress, which just finished determining changelog. At this point this build is still in progress. Never null.

listener - BuildListener for on-going build. This can be used to report any errors or the general logging of what's going on. This will show up in the "console output" of the build. Never null.

changelog - Set of changes detected in this build. This is the same value returned from AbstractBuild.getChangeSet() but passed separately for convenience.

Throws:

Exception - If any exception is thrown from this method, it will be recorded and causes the build to fail.

register

public final void register()

Registers this SCMListener so that it will start receiving events.

unregister

public final boolean unregister()

Unregisters this SCMListener so that it will never receive further events.

Unless SCMListener is unregistered, it will never be a subject of GC.