Package io.jenkins.plugins.folderauth

Class FolderAuthorizationStrategyManagementLink

java.lang.Object

hudson.model.ManagementLink

io.jenkins.plugins.folderauth.FolderAuthorizationStrategyManagementLink

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject

@Extension
@ExportedBean
@ParametersAreNonnullByDefault
public class FolderAuthorizationStrategyManagementLink
extends ManagementLink

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.ManagementLink

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor	Description
FolderAuthorizationStrategyManagementLink()

Method Summary

Modifier and Type	Method	Description
void	doAddAgentRole(AgentRoleCreationRequest request)	Adds an AgentRole to FolderBasedAuthorizationStrategy.
void	doAddFolderRole(FolderRoleCreationRequest request)	Adds a FolderRole to FolderBasedAuthorizationStrategy.
void	doAddGlobalRole(GlobalRoleCreationRequest request)	Adds a GlobalRole to FolderBasedAuthorizationStrategy.
void	doAssignSidToAgentRole(String roleName, String sid)	Assigns sid to the AgentRole identified by roleName.
void	doAssignSidToFolderRole(String roleName, String sid)	Assigns sid to the folder role identified by roleName.
void	doAssignSidToGlobalRole(String roleName, String sid)	Assigns sid to the global role identified by roleName.
void	doDeleteAgentRole(String roleName)	Deletes an AgentRole from the FolderBasedAuthorizationStrategy.
void	doDeleteFolderRole(String roleName)	Deletes a folder role.
void	doDeleteGlobalRole(String roleName)	Deletes a global role.
net.sf.json.JSONArray	doGetAllFolders()	Get all AbstractFolders in the system
void	doRemoveSidFromAgentRole(String roleName, String sid)	Removes sid from the agent role identified by roleName.
void	doRemoveSidFromFolderRole(String roleName, String sid)	Removes sid from the folder role identified by roleName.
void	doRemoveSidFromGlobalRole(String roleName, String sid)	Removes sid from the global role identified by roleName.
Set<Permission>	getAgentPermissions()
SortedSet<AgentRole>	getAgentRoles()
List<Computer>	getAllComputers()	Get all Computers in the system
Api	getApi()	Returns the Api for the plugin.
String	getCategoryName()	Name of the category for this management link.
String	getDescription()
String	getDisplayName()
Set<Permission>	getFolderPermissions()
SortedSet<FolderRole>	getFolderRoles()	Returns the FolderRoles used by the FolderBasedAuthorizationStrategy.
Set<Permission>	getGlobalPermissions()
SortedSet<GlobalRole>	getGlobalRoles()
String	getIconFileName()
String	getUrlName()

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategory, getRequiredPermission, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Constructor Details

FolderAuthorizationStrategyManagementLink

public FolderAuthorizationStrategyManagementLink()

Method Details

getIconFileName

@CheckForNull
public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

getDescription

@NonNull
public String getDescription()

Overrides:

getDescription in class ManagementLink

getUrlName

@CheckForNull
public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

getDisplayName

@CheckForNull
public String getDisplayName()

getCategoryName

public String getCategoryName()

Name of the category for this management link. Exists so that plugins with core dependency pre-dating the version when this was introduced can define a category. TODO when the core version is >2.226 change this to override getCategory() instead

Overrides:

getCategoryName in class ManagementLink

Returns:

name of the desired category, one of the enum values of Category, e.g. STATUS.

Since:

2.226

getGlobalPermissions

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Set<Permission> getGlobalPermissions()

getFolderPermissions

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Set<Permission> getFolderPermissions()

getAgentPermissions

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Set<Permission> getAgentPermissions()

getApi

public Api getApi()

Returns the Api for the plugin.

Returns:

Api for the plugin.

See Also:

• Wiki Article on exposing data to remote API.

doAddGlobalRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAddGlobalRole(@JsonBody
 GlobalRoleCreationRequest request)

Adds a GlobalRole to FolderBasedAuthorizationStrategy.

Parameters:

request - the request to create the GlobalRole

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

doAssignSidToGlobalRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAssignSidToGlobalRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Assigns sid to the global role identified by roleName.

Parameters:

roleName - the name of the global to which sid will be assigned to.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.

doAddFolderRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAddFolderRole(@JsonBody
 FolderRoleCreationRequest request)

Adds a FolderRole to FolderBasedAuthorizationStrategy.

Parameters:

request - the request to create the role

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

doAddAgentRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAddAgentRole(@JsonBody
 AgentRoleCreationRequest request)

Adds an AgentRole to FolderBasedAuthorizationStrategy.

Parameters:

request - the request to create the role

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

doAssignSidToFolderRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAssignSidToFolderRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Assigns sid to the folder role identified by roleName.

Parameters:

roleName - the name of the global to which sid will be assigned to.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

NoSuchElementException - when no role with name equal to roleName exists.

doAssignSidToAgentRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doAssignSidToAgentRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Assigns sid to the AgentRole identified by roleName.

Parameters:

roleName - the name of the global to which sid will be assigned to.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.

getGlobalRoles

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public SortedSet<GlobalRole> getGlobalRoles()

doGetAllFolders

@GET
@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public net.sf.json.JSONArray doGetAllFolders()

Get all AbstractFolders in the system

Returns:

full names of all AbstractFolders in the system

getAllComputers

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<Computer> getAllComputers()

Get all Computers in the system

Returns:

all Computers in the system

getFolderRoles

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public SortedSet<FolderRole> getFolderRoles()

Returns the FolderRoles used by the FolderBasedAuthorizationStrategy.

Returns:

the FolderRoles used by the FolderBasedAuthorizationStrategy

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

getAgentRoles

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public SortedSet<AgentRole> getAgentRoles()

doDeleteGlobalRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doDeleteGlobalRole(@QueryParameter(required=true)
 String roleName)

Deletes a global role.

Parameters:

roleName - the name of the role to be deleted

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when trying to delete the admin role

IllegalArgumentException - when no role with name equal to roleName exists.

doDeleteFolderRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doDeleteFolderRole(@QueryParameter(required=true)
 String roleName)

Deletes a folder role.

Parameters:

roleName - the name of the role to be deleted

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.

doDeleteAgentRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doDeleteAgentRole(@QueryParameter(required=true)
 String roleName)

Deletes an AgentRole from the FolderBasedAuthorizationStrategy.

Parameters:

roleName - the name of the role to be deleted

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

NoSuchElementException - when no role with name equal to roleName exists.

doRemoveSidFromGlobalRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doRemoveSidFromGlobalRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Removes sid from the global role identified by roleName.

Parameters:

roleName - the name of the global role from which sid will be removed.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.

doRemoveSidFromFolderRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doRemoveSidFromFolderRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Removes sid from the folder role identified by roleName.

Parameters:

roleName - the name of the folder role from which sid will be removed.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.

doRemoveSidFromAgentRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void doRemoveSidFromAgentRole(@QueryParameter(required=true)
 String roleName,
 @QueryParameter(required=true)
 String sid)

Removes sid from the agent role identified by roleName.

Parameters:

roleName - the name of the agent from which sid will be removed.

sid - the sid of the user/group to be assigned.

Throws:

IllegalStateException - when Jenkins.getAuthorizationStrategy() is not FolderBasedAuthorizationStrategy

IllegalArgumentException - when no role with name equal to roleName exists.