java.lang.Object
com.synopsys.arc.jenkins.plugins.rolestrategy.RoleMacroExtension
com.synopsys.arc.jenkins.plugins.rolestrategy.macros.StubMacro
All Implemented Interfaces:
IMacroExtension, ExtensionPoint

public final class StubMacro extends RoleMacroExtension
A stub for non-existent macros. Always returns false during permissions check.
Since:
2.1.0
Author:
Oleg Nenashev
  • Field Details

    • Instance

      public static final StubMacro Instance
  • Method Details

    • getName

      public String getName()
      Description copied from interface: IMacroExtension
      Get name of the appropriate macro.
      Returns:
      Name of the macro
    • IsApplicable

      public boolean IsApplicable(RoleType roleType)
      Description copied from interface: IMacroExtension
      Check if the macro extension is applicable to specified role type.
      Parameters:
      roleType - Type to be checked
      Returns:
      true if the macro is applicable to the specified role type
    • hasPermission

      public boolean hasPermission(PermissionEntry sid, Permission p, RoleType type, AccessControlled item, Macro macro)
      Description copied from interface: IMacroExtension
      Check if user belongs to specified Macro.
      Parameters:
      sid - SID to be checked
      p - Permission
      type - Type of the role to be checked
      item - Item
      macro - Macro with parameters
      Returns:
      True if user satisfies macro's requirements
    • getDescription

      public String getDescription()
      Description copied from interface: IMacroExtension
      Returns description of the macro (including parameters).
      Returns:
      Description of the macro