Package com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions

Class JobRestriction

java.lang.Object

com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

All Implemented Interfaces:

ExtensionPoint, Describable<JobRestriction>, Serializable

Direct Known Subclasses:

AbstractUserCauseRestriction, AndJobRestriction, AnyJobRestriction, JobClassNameRestriction, MultipleAndJobRestriction, MultipleOrJobRestriction, NotJobRestriction, OrJobRestriction, RegexNameRestriction

public abstract class JobRestriction
extends Object
implements ExtensionPoint, Describable<JobRestriction>, Serializable

The extension point, which allows to restrict job executions.

Author:

Oleg Nenashev

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final JobRestriction	DEFAULT

Constructor Summary

Constructors

Constructor	Description
JobRestriction()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<JobRestriction,JobRestrictionDescriptor>	all()	Get list of all registered JobRestrictions.
static List<JobRestrictionDescriptor>	allDescriptors()	Returns list of JobRestrictionDescriptors.
abstract boolean	canTake(Queue.BuildableItem item)	Check if the Queue item can be taken.
abstract boolean	canTake(Run run)	Check if the Job can be executed according to the specified Run.
JobRestrictionDescriptor	getDescriptor()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final JobRestriction DEFAULT

Constructor Details

JobRestriction

public JobRestriction()

Method Details

canTake

public abstract boolean canTake(@NonNull
 Queue.BuildableItem item)

Check if the Queue item can be taken. This method is being used to check if the Node can take the specified job. If the job cannot be taken, Jenkins will try to launch the job on other nodes.

Parameters:

item - An item to be checked

Returns:

true if the node can take the item

canTake

public abstract boolean canTake(@NonNull
 Run run)

Check if the Job can be executed according to the specified Run. If the job cannot be executed, it will be aborted by the plugin.

Parameters:

run - A Run to be checked

Returns:

true if the build can be executed

getDescriptor

public JobRestrictionDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<JobRestriction>

all

public static DescriptorExtensionList<JobRestriction,JobRestrictionDescriptor> all()

Get list of all registered JobRestrictions.

Returns:

List of JobRestrictions.

allDescriptors

public static List<JobRestrictionDescriptor> allDescriptors()

Returns list of JobRestrictionDescriptors.

Returns:

List of available descriptors.

Since:

0.2