hudson.plugins.label_verifier

Class LabelVerifier

java.lang.Object

hudson.model.AbstractDescribableImpl<LabelVerifier>

hudson.plugins.label_verifier.LabelVerifier

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<LabelVerifier>

Direct Known Subclasses:

AlwaysFalse, AlwaysTrue, And, Not, Or, RegexNameVerifier, ShellScriptVerifier

public abstract class LabelVerifier
extends hudson.model.AbstractDescribableImpl<LabelVerifier>
implements hudson.ExtensionPoint

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
LabelVerifier()

Method Summary

Modifier and Type	Method and Description
LabelVerifierDescriptor	getDescriptor()
abstract void	verify(hudson.model.labels.LabelAtom label, hudson.model.Computer c, hudson.remoting.Channel channel, hudson.FilePath root, hudson.model.TaskListener listener) Called before a Computer becomes online to verify if the label assignment is correct.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelVerifier

public LabelVerifier()

Method Detail

verify

public abstract void verify(hudson.model.labels.LabelAtom label,
                            hudson.model.Computer c,
                            hudson.remoting.Channel channel,
                            hudson.FilePath root,
                            hudson.model.TaskListener listener)
                     throws IOException,
                            InterruptedException

Called before a Computer becomes online to verify if the label assignment is correct.

Parameters:

label - Label whose validity you'll check.

channel - This is the channel object to talk to the slave. (This is the same object returned by Computer.getChannel() once it's connected.

root - The directory where this slave stores files. The same as Node.getRootPath(), except that method returns null until the slave is connected. So this parameter is passed explicitly instead.

listener - This is connected to the launch log of the computer. Since this method is called synchronously from the thread that launches a computer, if this method performs a time-consuming operation, this listener should be notified of the progress. This is also a good listener for reporting problems.

Throws:

IOException - Exceptions will be recorded to the listener, and the computer will not become online.

InterruptedException - Exceptions will be recorded to the listener, and the computer will not become online.

getDescriptor

public LabelVerifierDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<LabelVerifier>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<LabelVerifier>