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

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
void	addFolderRole(AgentRole agentRole) Adds an AgentRole to this strategy
void	addFolderRole(FolderRole folderRole) Adds a FolderRole to this strategy
void	addGlobalRole(GlobalRole globalRole)
void	assignSidToAgentRole(String roleName, String sid) Assigns a SID to a FolderRole.
void	assignSidToFolderRole(String roleName, String sid) Assigns a SID to a FolderRole.
void	assignSidToGlobalRole(String roleName, String sid) Assigns SID to a GlobalRole.
void	deleteAgentRole(String roleName) Deletes the AgentRole identified by its name.
void	deleteFolderRole(String roleName) Deletes the folder role identified by its name.
void	deleteGlobalRole(String roleName) Deletes the global role identified by its name.
SidACL	getACL(AbstractItem item)
SidACL	getACL(Computer computer)
SidACL	getACL(Job<?,?> project) Gets the ACL for a Job
Set<AgentRole>	getAgentRoles()
Set<FolderRole>	getFolderRoles() Returns the FolderRoles on which this AuthorizationStrategy works.
Set<GlobalRole>	getGlobalRoles()
Collection<String>	getGroups()
GlobalAclImpl	getRootACL()
protected Object	readResolve() Used to initialize transient fields when loaded from disk

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

readResolve

@Nonnull
protected Object readResolve()

Used to initialize transient fields when loaded from disk

Returns:

this

getACL

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

Gets the ACL for a Job

Overrides:

getACL in class AuthorizationStrategy

Returns:

the ACL for the Job

getACL

@Nonnull
public SidACL getACL(@Nonnull
                               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

addGlobalRole

public void addGlobalRole(@Nonnull
                          GlobalRole globalRole)
                   throws IOException

Throws:

IOException

getGlobalRoles

@Nonnull
public Set<GlobalRole> getGlobalRoles()

getAgentRoles

@Nonnull
public Set<AgentRole> getAgentRoles()

assignSidToGlobalRole

public void assignSidToGlobalRole(String roleName,
                                  String sid)
                           throws IOException

Assigns SID to a GlobalRole.

Parameters:

roleName - the name of the GlobalRole

sid - the sid to be assigned

Throws:

IOException - when unable to save the configuration to disk

NoSuchElementException - when no GlobalRole with name equal to roleName exists

getFolderRoles

@Nonnull
public Set<FolderRole> getFolderRoles()

Returns the FolderRoles on which this AuthorizationStrategy works.

Returns:

FolderRoles on which this AuthorizationStrategy works

addFolderRole

public void addFolderRole(@Nonnull
                          FolderRole folderRole)
                   throws IOException

Adds a FolderRole to this strategy

Parameters:

folderRole - the FolderRole to be added

Throws:

IOException - when unable to save configuration to disk

addFolderRole

public void addFolderRole(@Nonnull
                          AgentRole agentRole)
                   throws IOException

Adds an AgentRole to this strategy

Parameters:

agentRole - the FolderRole to be added

Throws:

IOException - when unable to save configuration to disk

assignSidToFolderRole

public void assignSidToFolderRole(String roleName,
                                  String sid)
                           throws IOException

Assigns a SID to a FolderRole.

Parameters:

roleName - the name of the FolderRole

sid - the sid to be assigned

Throws:

IOException - when unable to save the configuration to disk

NoSuchElementException - when no GlobalRole with name equal to roleName exists

assignSidToAgentRole

public void assignSidToAgentRole(String roleName,
                                 String sid)
                          throws IOException

Assigns a SID to a FolderRole.

Parameters:

roleName - the name of the FolderRole

sid - the sid to be assigned

Throws:

IOException - when unable to save the configuration to disk

NoSuchElementException - when no GlobalRole with name equal to roleName exists

deleteGlobalRole

public void deleteGlobalRole(String roleName)
                      throws IOException

Deletes the global role identified by its name.

Parameters:

roleName - the name of the role to be deleted

Throws:

IOException - when unable to save the configuration

NoSuchElementException - when no GlobalRole with name equal to roleName exists

IllegalArgumentException - when trying to delete the admin role

deleteFolderRole

public void deleteFolderRole(String roleName)
                      throws IOException

Deletes the folder role identified by its name.

Parameters:

roleName - the name of the role to be deleted

Throws:

IOException - when unable to save the configuration

NoSuchElementException - when no FolderRole with name equal to roleName exists

deleteAgentRole

public void deleteAgentRole(String roleName)
                     throws IOException

Deletes the AgentRole identified by its name.

Parameters:

roleName - the name of the role to be deleted

Throws:

IOException - when unable to save the configuration

NoSuchElementException - when no AgentRole with name equal to roleName exists