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

Class AbstractUserCauseRestriction

java.lang.Object

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

com.synopsys.arc.jenkinsci.plugins.jobrestrictions.restrictions.job.AbstractUserCauseRestriction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<JobRestriction>, Serializable

Direct Known Subclasses:

StartedByMemberOfGroupRestriction, StartedByUserRestriction

public abstract class AbstractUserCauseRestriction
extends JobRestriction

Abstract class, which defines the logic of UserCause-based restrictions.

Since:

0.4

Author:

Christopher Suarez, Oleg Nenashev

See Also:

StartedByUserRestriction, StartedByMemberOfGroupRestriction, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

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

DEFAULT

Constructor Summary

Constructors

Constructor and Description
AbstractUserCauseRestriction(boolean checkUpstreamProjects)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	acceptsUser(String userId) Check if the method accepts the specified user.
boolean	canTake(hudson.model.Queue.BuildableItem item) Check if the Queue item can be taken.
boolean	canTake(hudson.model.Run run) Check if the Job can be executed according to the specified Run.
boolean	isCheckUpstreamProjects()

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 Detail

AbstractUserCauseRestriction

public AbstractUserCauseRestriction(boolean checkUpstreamProjects)

Method Detail

isCheckUpstreamProjects

public final boolean isCheckUpstreamProjects()

acceptsUser

protected abstract boolean acceptsUser(@CheckForNull
                                       String userId)

Check if the method accepts the specified user. The user will be automatically extracted by the logic in AbstractUserCauseRestriction.

Parameters:

userId - User id

Returns:

true if the restriction accepts the user

canTake

public boolean canTake(hudson.model.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(hudson.model.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