Package jenkins.security

Class QueueItemAuthenticator

java.lang.Object

jenkins.security.QueueItemAuthenticator

All Implemented Interfaces:

ExtensionPoint, Describable<QueueItemAuthenticator>

public abstract class QueueItemAuthenticator
extends Object
implements Describable<QueueItemAuthenticator>, ExtensionPoint

Extension point to run Queue.Executables under a specific identity for better access control. You must override either authenticate2(hudson.model.Queue.Item), or authenticate2(hudson.model.Queue.Task), or both.

Since:

1.520

Author:

Kohsuke Kawaguchi

See Also:

• QueueItemAuthenticatorConfiguration
• QueueItemAuthenticatorProvider
• Queue.Item.authenticate()
• Tasks.getAuthenticationOf(hudson.model.Queue.Task)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
QueueItemAuthenticator()

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Queue.Item item)	Deprecated. use authenticate2(Queue.Item)
Authentication	authenticate(Queue.Task task)	Deprecated. use authenticate2(Queue.Task)
org.springframework.security.core.Authentication	authenticate2(Queue.Item item)	Determines the identity in which the Queue.Executable will run as.
org.springframework.security.core.Authentication	authenticate2(Queue.Task task)	Determines the identity in which the Queue.Executable will run as.
QueueItemAuthenticatorDescriptor	getDescriptor()	Gets the descriptor for this instance.

Methods inherited from class java.lang.Object

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

Constructor Details

QueueItemAuthenticator

public QueueItemAuthenticator()

Method Details

authenticate2

@CheckForNull
public org.springframework.security.core.Authentication authenticate2(Queue.Item item)

Determines the identity in which the Queue.Executable will run as. The default implementation delegates to authenticate2(hudson.model.Queue.Task).

Parameters:

item - The contextual information to assist the authentication. The primary interest is likely Queue.Item.task, which is often AbstractProject. Actions associated with the item is also likely of interest, such as CauseAction.

Returns:

returning non-null will determine the identity. If null is returned, the next configured QueueItemAuthenticator will be given a chance to authenticate the executor. If everything fails, fall back to Queue.Task.getDefaultAuthentication().

Since:

2.266

authenticate2

@CheckForNull
public org.springframework.security.core.Authentication authenticate2(Queue.Task task)

Determines the identity in which the Queue.Executable will run as. The default implementation delegates to authenticate2(hudson.model.Queue.Item) (there will be no associated actions).

Parameters:

task - Often AbstractProject.

Returns:

returning non-null will determine the identity. If null is returned, the next configured QueueItemAuthenticator will be given a chance to authenticate the executor. If everything fails, fall back to Queue.Task.getDefaultAuthentication().

Since:

2.266

authenticate

@Deprecated
@CheckForNull
public Authentication authenticate(Queue.Item item)

Deprecated.

use authenticate2(Queue.Item)

authenticate

@Deprecated
@CheckForNull
public Authentication authenticate(Queue.Task task)

Deprecated.

use authenticate2(Queue.Task)

Since:

1.560

getDescriptor

public QueueItemAuthenticatorDescriptor getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<QueueItemAuthenticator>