Package jenkins.model

Class NodeListener

java.lang.Object

jenkins.model.NodeListener

All Implemented Interfaces:

ExtensionPoint

public abstract class NodeListener
extends Object
implements ExtensionPoint

Listen to Node CRUD operations.

Since:

2.8

Author:

ogondza.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
NodeListener()

Method Summary

Modifier and Type	Method	Description
static List<NodeListener>	all()	Get all NodeListeners registered in Jenkins.
protected boolean	allowLoad(Node node)	Allows to veto node loading.
static void	fireOnCreated(Node node)	Inform listeners that node is being created.
static void	fireOnDeleted(Node node)	Inform listeners that node is being removed.
static void	fireOnUpdated(Node oldOne, Node newOne)	Inform listeners that node is being updated.
protected void	onCreated(Node node)	Node is being created.
protected void	onDeleted(Node node)	Node is being deleted.
protected void	onUpdated(Node oldOne, Node newOne)	Node is being updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeListener

public NodeListener()

Method Detail

allowLoad

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
protected boolean allowLoad(@NonNull
                            Node node)

Allows to veto node loading.

Parameters:

node - the node being loaded. Not yet attached to Jenkins.

Returns:

false to veto node loading.

onCreated

protected void onCreated(@NonNull
                         Node node)

Node is being created.

onUpdated

protected void onUpdated(@NonNull
                         Node oldOne,
                         @NonNull
                         Node newOne)

Node is being updated.

onDeleted

protected void onDeleted(@NonNull
                         Node node)

Node is being deleted.

fireOnCreated

public static void fireOnCreated(@NonNull
                                 Node node)

Inform listeners that node is being created.

Parameters:

node - A node being created.

fireOnUpdated

public static void fireOnUpdated(@NonNull
                                 Node oldOne,
                                 @NonNull
                                 Node newOne)

Inform listeners that node is being updated.

Parameters:

oldOne - Old configuration.

newOne - New Configuration.

fireOnDeleted

public static void fireOnDeleted(@NonNull
                                 Node node)

Inform listeners that node is being removed.

Parameters:

node - A node being removed.

all

@NonNull
public static List<NodeListener> all()

Get all NodeListeners registered in Jenkins.