com.synopsys.arc.jenkins.plugins.rolestrategy

Interface IMacroExtension

All Known Implementing Classes:

BuildableJobMacro, LoggedUserMacro, RoleMacroExtension, StubMacro, UserMacroExtension

public interface IMacroExtension

Interface for Role-based plug-in Macro extensions.

Since:

2.1.0

Author:

Oleg Nenashev

See Also:

RoleMacroExtension, UserMacroExtension

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns description of the macro (including parameters).
String	getName() Get name of the appropriate macro.
boolean	hasPermission(String sid, hudson.security.Permission p, RoleType type, hudson.security.AccessControlled item, Macro macro) Check if user belongs to specified Macro
boolean	IsApplicable(RoleType roleType) Check if the macro extension is applicable to specified role type

Method Detail

getName

String getName()

Get name of the appropriate macro.

Returns:

Name of the macro

IsApplicable

boolean IsApplicable(RoleType roleType)

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

getDescription

String getDescription()

Returns description of the macro (including parameters).

Returns:

Description of the macro

hasPermission

boolean hasPermission(String sid,
                    hudson.security.Permission p,
                    RoleType type,
                    hudson.security.AccessControlled item,
                    Macro macro)

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