hudson.model.queue

Class AbstractQueueTask

java.lang.Object

hudson.model.queue.AbstractQueueTask

All Implemented Interfaces:

ModelObject, SubTask, Queue.Task, ResourceActivity

public abstract class AbstractQueueTask
extends Object
implements Queue.Task

Abstract base class for Queue.Task to protect plugins from new additions to the interface.

Plugins are encouraged to implement AccessControlled otherwise the tasks will be hidden from display in the queue.

Since:

1.360

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
AbstractQueueTask()

Method Summary

Modifier and Type	Method and Description
CauseOfBlockage	getCauseOfBlockage() If the execution of this task should be blocked for temporary reasons, this method returns a non-null object explaining why.
org.acegisecurity.Authentication	getDefaultAuthentication() This default implementation is the historical behaviour, but this is no longer desirable.
org.acegisecurity.Authentication	getDefaultAuthentication(Queue.Item item) This method allows the task to provide the default fallback authentication object to be used when QueueItemAuthenticator fails to authenticate the build.
Queue.Task	getOwnerTask() Gets the Queue.Task that this subtask belongs to.
Object	getSameNodeConstraint() If a subset of SubTasks of a Queue.Task needs to be collocated with other SubTasks, those SubTasks should return the equal object here.
Collection<? extends SubTask>	getSubTasks() Obtains the SubTasks that constitute this task.
boolean	isConcurrentBuild() True if the task allows concurrent builds, where the same Queue.Task is executed by multiple executors concurrently on the same or different nodes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Queue.Task

checkAbortPermission, getFullDisplayName, getName, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Methods inherited from interface hudson.model.queue.SubTask

createExecutable, getAssignedLabel, getEstimatedDuration, getLastBuiltOn

Methods inherited from interface hudson.model.ResourceActivity

getDisplayName, getResourceList

Constructor Detail

AbstractQueueTask

public AbstractQueueTask()

Method Detail

getSubTasks

public Collection<? extends SubTask> getSubTasks()

Description copied from interface: Queue.Task

Obtains the SubTasks that constitute this task.

The collection returned by this method must also contain the primary SubTask represented by this Queue.Task object itself as the first element. The returned value is read-only.

At least size 1.

Since this is a newly added method, the invocation may results in AbstractMethodError. Use Tasks.getSubTasksOf(Queue.Task) that avoids this.

Specified by:

getSubTasks in interface Queue.Task

getOwnerTask

public final Queue.Task getOwnerTask()

Description copied from interface: SubTask

Gets the Queue.Task that this subtask belongs to.

Specified by:

getOwnerTask in interface SubTask

isConcurrentBuild

public boolean isConcurrentBuild()

Description copied from interface: Queue.Task

True if the task allows concurrent builds, where the same Queue.Task is executed by multiple executors concurrently on the same or different nodes.

Specified by:

isConcurrentBuild in interface Queue.Task

getCauseOfBlockage

public CauseOfBlockage getCauseOfBlockage()

Description copied from interface: Queue.Task

If the execution of this task should be blocked for temporary reasons, this method returns a non-null object explaining why.

Otherwise this method returns null, indicating that the build can proceed right away.

This can be used to define mutual exclusion that goes beyond ResourceActivity.getResourceList().

Specified by:

getCauseOfBlockage in interface Queue.Task

getSameNodeConstraint

public Object getSameNodeConstraint()

Description copied from interface: SubTask

If a subset of SubTasks of a Queue.Task needs to be collocated with other SubTasks, those SubTasks should return the equal object here. If null, the execution unit isn't under a colocation constraint.

Specified by:

getSameNodeConstraint in interface SubTask

getDefaultAuthentication

@Nonnull
public org.acegisecurity.Authentication getDefaultAuthentication()

This default implementation is the historical behaviour, but this is no longer desirable. Please override. See Queue.Task.getDefaultAuthentication() for the contract.

Specified by:

getDefaultAuthentication in interface Queue.Task

See Also:

QueueItemAuthenticator, Tasks.getDefaultAuthenticationOf(Queue.Task)

getDefaultAuthentication

@Nonnull
public org.acegisecurity.Authentication getDefaultAuthentication(Queue.Item item)

Description copied from interface: Queue.Task

This method allows the task to provide the default fallback authentication object to be used when QueueItemAuthenticator fails to authenticate the build.

When the task execution touches other objects inside Jenkins, the access control is performed based on whether this Authentication is allowed to use them.

This method was added to an interface after it was created, so plugins built against older versions of Jenkins may not have this method implemented. Called private method _getDefaultAuthenticationOf(Task) on Tasks to avoid AbstractMethodError.

Specified by:

getDefaultAuthentication in interface Queue.Task

See Also:

QueueItemAuthenticator, Tasks.getDefaultAuthenticationOf(Queue.Task, Queue.Item)