io.jenkins.plugins.folderauth

Class FolderBasedAuthorizationStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<AuthorizationStrategy>

hudson.security.AuthorizationStrategy

io.jenkins.plugins.folderauth.FolderBasedAuthorizationStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<AuthorizationStrategy>

@ParametersAreNonnullByDefault
public class FolderBasedAuthorizationStrategy
extends AuthorizationStrategy

An AuthorizationStrategy that controls access to AbstractFolders through FolderRoles, to Computers through AgentRoles. Also provides global permissions through GlobalRoles.

All objects of this class are immutable. To modify the data for this strategy, please use the FolderAuthorizationStrategyAPI.

See Also:

for modifying the roles, for REST API methods

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderBasedAuthorizationStrategy.DescriptorImpl

Nested classes/interfaces inherited from class hudson.security.AuthorizationStrategy

AuthorizationStrategy.Unsecured

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.security.AuthorizationStrategy

LIST, UNSECURED

Constructor Summary

Constructors

Constructor and Description
FolderBasedAuthorizationStrategy(Set<GlobalRole> globalRoles, Set<FolderRole> folderRoles, Set<AgentRole> agentRoles)

Method Summary

Modifier and Type	Method and Description
SidACL	getACL(AbstractItem item)
SidACL	getACL(Computer computer)
SidACL	getACL(Job<?,?> project) Gets the ACL for a Job
Set<AgentRole>	getAgentRoles() Returns the AgentRoles on which this AuthorizationStrategy works.
Set<FolderRole>	getFolderRoles() Returns the FolderRoles on which this AuthorizationStrategy works.
Set<GlobalRole>	getGlobalRoles() Returns the GlobalRoles on which this AuthorizationStrategy works.
Collection<String>	getGroups()
GlobalAclImpl	getRootACL()

Methods inherited from class hudson.security.AuthorizationStrategy

all, getACL, getACL, getACL, getACL, getACL

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderBasedAuthorizationStrategy

@DataBoundConstructor
public FolderBasedAuthorizationStrategy(Set<GlobalRole> globalRoles,
                                                               Set<FolderRole> folderRoles,
                                                               Set<AgentRole> agentRoles)

Method Detail

getRootACL

@Nonnull
public GlobalAclImpl getRootACL()

Specified by:

getRootACL in class AuthorizationStrategy

Returns:

an ACL formed using just globalRoles

getACL

@Nonnull
public SidACL getACL(Job<?,?> project)

Gets the ACL for a Job

Overrides:

getACL in class AuthorizationStrategy

Returns:

the ACL for the Job

getACL

@Nonnull
public SidACL getACL(AbstractItem item)

Overrides:

getACL in class AuthorizationStrategy

getACL

@Nonnull
public SidACL getACL(@Nonnull
                               Computer computer)

Overrides:

getACL in class AuthorizationStrategy

getGroups

@Nonnull
public Collection<String> getGroups()

Specified by:

getGroups in class AuthorizationStrategy

getGlobalRoles

@Nonnull
public Set<GlobalRole> getGlobalRoles()

Returns the GlobalRoles on which this AuthorizationStrategy works.

Returns:

set of GlobalRoles on which this AuthorizationStrategy works.

getAgentRoles

@Nonnull
public Set<AgentRole> getAgentRoles()

Returns the AgentRoles on which this AuthorizationStrategy works.

Returns:

set of AgentRoles on which this AuthorizationStrategy works.

getFolderRoles

@Nonnull
public Set<FolderRole> getFolderRoles()

Returns the FolderRoles on which this AuthorizationStrategy works.

Returns:

FolderRoles on which this AuthorizationStrategy works