Package com.michelin.cio.hudson.plugins.rolestrategy

Class RoleStrategyConfig

java.lang.Object
hudson.model.ManagementLink
com.michelin.cio.hudson.plugins.rolestrategy.RoleStrategyConfig
All Implemented Interfaces:
ExtensionPoint, Action, ModelObject
@Extension public class RoleStrategyConfig extends ManagementLink
Add the role management link to the Manage Hudson page.
Author:
Thomas Maurel

  • Constructor Details

    • RoleStrategyConfig

      public RoleStrategyConfig()

  • Method Details

    • get

      @NonNull public static RoleStrategyConfig get()
      Get the singleton instance of RoleStrategyConfig.
      Returns:
      The RoleStrategyConfig instance

    • getIconFileName

      public String getIconFileName()
      Provides the icon for the Manage Hudson page link.
      Specified by:
      getIconFileName in interface Action
      Specified by:
      getIconFileName in class ManagementLink
      Returns:
      Path to the icon, or null if not enabled

    • getRequiredPermission

      @NonNull public Permission getRequiredPermission()
      Overrides:
      getRequiredPermission in class ManagementLink

    • getUrlName

      public String getUrlName()
      URL name for the strategy management.
      Specified by:
      getUrlName in interface Action
      Specified by:
      getUrlName in class ManagementLink
      Returns:
      Path to the strategy admin panel

    • getCategoryName

      @NonNull public String getCategoryName()
      Overrides:
      getCategoryName in class ManagementLink

    • getDisplayName

      public String getDisplayName()
      Text displayed in the Manage Hudson panel.
      Returns:
      Link text in the Admin panel

    • getDescription

      public String getDescription()
      The description of the link.
      Specified by:
      getDescription in interface Action
      Overrides:
      getDescription in class ManagementLink
      Returns:
      The description of the link

    • getAssignRolesName

      @Deprecated public String getAssignRolesName()
      Deprecated.
      no longer used internally; retained only for compatibility
      Text formerly displayed for the roles assignment panel; kept for binary and source compatibility with external callers now that the panel is rendered by the React Assign Roles page instead of a Jelly view referencing this method.
      Returns:
      Title of the Role assignment panel

    • getManageRolesName

      @Deprecated public String getManageRolesName()
      Deprecated.
      no longer used internally; retained only for compatibility
      Text formerly displayed for the roles management panel; kept for binary and source compatibility with external callers now that the panel is rendered by the React Manage Roles page instead of a Jelly view referencing this method.
      Returns:
      Title of the Role management panel

    • getStrategy

      @CheckForNull public AuthorizationStrategy getStrategy()
      Retrieve the RoleBasedAuthorizationStrategy object from the Hudson instance.

      Used by the views to build matrix.

      Returns:
      The RoleBasedAuthorizationStrategy object. null if the strategy is not used.

    • doTemplatesSubmit

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public void doTemplatesSubmit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp) throws IOException, jakarta.servlet.ServletException
      Called on roles generator form submission.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getRoleMacroExtensions

      public ExtensionList<RoleMacroExtension> getRoleMacroExtensions()

    • getPermissionTemplatesBootstrapJson

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public String getPermissionTemplatesBootstrapJson()
      Bootstrap JSON for the Permission Templates page, intended to be embedded in a data-* attribute so the React UI can render immediately without an additional round trip.
      Returns:
      JSON string with templates, item-scope permission groups, and edit permissions

    • getManageRolesBootstrapJson

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public String getManageRolesBootstrapJson()
      Bootstrap JSON for the Manage Roles page, intended to be embedded in a data-* attribute so the React UI can render immediately without an additional round trip.
      Returns:
      JSON string with the roles, permission groups and edit permission per role type, plus the permission templates for the item-role dialog

    • getAssignRolesBootstrapJson

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public String getAssignRolesBootstrapJson()
      Bootstrap JSON for the Assign Roles page, intended to be embedded in a data-* attribute so the React UI can render immediately without an additional round trip.
      Returns:
      JSON string with the roles, sid entries and edit permission per role type

    • getMaxRows

      public static int getMaxRows()
      The number of Assign Roles cards rendered per page, kept configurable via the documented MAX_ROWS system property so large instances can tune it for performance.
      Returns:
      the configured page size, defaulting to 50, clamped to between 1 and RoleBasedAuthorizationStrategy.MAX_SIDS_PER_REQUEST: a value of 0 or less would make client-side pagination invalid, and a page larger than that limit would make every realm-lookup request for a full page (which sends one sid per non-internal entry) fail with 400

    • getGlobalRoleType

      public final RoleType getGlobalRoleType()
      Returns the global role type, used by list-macros.jelly to evaluate a macro's applicability to global roles.
      Returns:
      the RoleType.Global constant

    • getProjectRoleType

      public final RoleType getProjectRoleType()
      Returns the project role type, used by list-macros.jelly to evaluate a macro's applicability to item roles.
      Returns:
      the RoleType.Project constant

    • getSlaveRoleType

      public final RoleType getSlaveRoleType()
      Returns the slave role type, used by list-macros.jelly to evaluate a macro's applicability to agent roles.
      Returns:
      the RoleType.Slave constant