hudson.model.listeners
Class RunListener<R extends Run>

java.lang.Object
  hudson.model.listeners.RunListener<R>

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

AggregatedTestResultPublisher.TestResultAction.RunListenerImpl

public abstract class RunListener<R extends Run>
extends Object
implements ExtensionPoint

Receives notifications about builds.

Listener is always Hudson-wide, so once registered it gets notifications for every build that happens in this Hudson.

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

Since:

1.145

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static CopyOnWriteList<RunListener>	LISTENERS Deprecated. as of 1.281 Use all() for read access, and use Extension for registration.
Class<R>	targetType

Method Summary

static ExtensionList<RunListener>	all() Returns all the registered RunListener descriptors.
static void	fireCompleted(Run r, TaskListener listener) Fires the onCompleted(R, hudson.model.TaskListener) event.
static void	fireDeleted(Run r) Fires the onFinalized(Run) event.
static void	fireFinalized(Run r) Fires the onFinalized(Run) event.
static void	fireStarted(Run r, TaskListener listener) Fires the onStarted(R, hudson.model.TaskListener) event.
Class<R>	getTargetType()
void	onCompleted(R r, TaskListener listener) Called after a build is completed.
void	onDeleted(R r) Called right before a build is going to be deleted.
void	onFinalized(R r) Called after a build is moved to the Run.State#COMPLETED state.
void	onStarted(R r, TaskListener listener) Called when a build is started (i.e.
void	register() Deprecated. as of 1.281 Put Extension on your class to get it auto-registered.
void	unregister() Reverse operation of register().

Methods inherited from class java.lang.Object

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

Field Detail

targetType

public final Class<R extends Run> targetType

LISTENERS

public static final CopyOnWriteList<RunListener> LISTENERS

Deprecated. as of 1.281 Use all() for read access, and use Extension for registration.

List of registered listeners.

Method Detail

getTargetType

public Class<R> getTargetType()

onCompleted

public void onCompleted(R r,
                        TaskListener listener)

Called after a build is completed.

Parameters:

r - The completed build.

listener - The listener for this build. This can be used to produce log messages, for example, which becomes a part of the "console output" of this build. But when this method runs, the build is considered completed, so its status cannot be changed anymore.

onFinalized

public void onFinalized(R r)

Called after a build is moved to the Run.State#COMPLETED state.

At this point, all the records related to a build is written down to the disk. As such, TaskListener is no longer available. This happens later than onCompleted(Run, TaskListener).

onStarted

public void onStarted(R r,
                      TaskListener listener)

Called when a build is started (i.e. it was in the queue, and will now start running on an executor)

Parameters:

r - The started build.

listener - The listener for this build. This can be used to produce log messages, for example, which becomes a part of the "console output" of this build.

onDeleted

public void onDeleted(R r)

Called right before a build is going to be deleted.

Parameters:

r - The build.

register

public void register()

Deprecated. as of 1.281 Put Extension on your class to get it auto-registered.

Registers this object as an active listener so that it can start getting callbacks invoked.

unregister

public void unregister()

Reverse operation of register().

fireCompleted

public static void fireCompleted(Run r,
                                 TaskListener listener)

Fires the onCompleted(R, hudson.model.TaskListener) event.

fireStarted

public static void fireStarted(Run r,
                               TaskListener listener)

Fires the onStarted(R, hudson.model.TaskListener) event.

fireFinalized

public static void fireFinalized(Run r)

Fires the onFinalized(Run) event.

fireDeleted

public static void fireDeleted(Run r)

Fires the onFinalized(Run) event.

all

public static ExtensionList<RunListener> all()

Returns all the registered RunListener descriptors.