Package io.jenkins.plugins.jobrestrictions.restrictions.job

Class JobClassNameRestriction

java.lang.Object

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

io.jenkins.plugins.jobrestrictions.restrictions.job.JobClassNameRestriction

All Implemented Interfaces:

ExtensionPoint, Describable<JobRestriction>, Serializable

public class JobClassNameRestriction
extends JobRestriction

Handles job class restrictions.

Since:

TODO

Author:

Oleg Nenashev

See Also:

• ClassSelector
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobClassNameRestriction.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

DEFAULT

Constructor Summary

Constructors

Constructor	Description
JobClassNameRestriction(List<ClassSelector> jobClasses)

Method Summary

Modifier and Type	Method	Description
boolean	canTake(Queue.BuildableItem item)	Check if the Queue item can be taken.
boolean	canTake(Run run)	Check if the Job can be executed according to the specified Run.
List<ClassSelector>	getJobClasses()

Methods inherited from class com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.JobRestriction

all, allDescriptors, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

JobClassNameRestriction

@DataBoundConstructor
public JobClassNameRestriction(List<ClassSelector> jobClasses)

Method Details

getJobClasses

@NonNull
public List<ClassSelector> getJobClasses()

canTake

public boolean canTake(Queue.BuildableItem item)

Description copied from class: JobRestriction

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.

Specified by:

canTake in class JobRestriction

Parameters:

item - An item to be checked

Returns:

true if the node can take the item

canTake

public boolean canTake(Run run)

Description copied from class: JobRestriction

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.

Specified by:

canTake in class JobRestriction

Parameters:

run - A Run to be checked

Returns:

true if the build can be executed