org.rundeck.app.gui

Interface AuthMenuItem

All Superinterfaces:

MenuItem

public interface AuthMenuItem
extends MenuItem

Extends MenuItem by passing AuthContext for any necessary auth checks for enabled checks for the menu item

Nested Class Summary

Nested classes/interfaces inherited from interface org.rundeck.app.gui.MenuItem

MenuItem.MenuDomain, MenuItem.MenuType

Method Summary

Modifier and Type	Method and Description
static java.util.function.Function<MenuItem,java.lang.Boolean>	getEnabledCheck(MenuItem.MenuType menuType, UserAndRolesAuthContext authContext, java.lang.String project, java.lang.String executionId)
default boolean	isEnabled(UserAndRolesAuthContext auth)
default boolean	isEnabled(UserAndRolesAuthContext auth, java.lang.String project)
default boolean	isEnabledExecution(UserAndRolesAuthContext auth, java.lang.String project, java.lang.String executionId) Check if the menu item is enabled

Methods inherited from interface org.rundeck.app.gui.MenuItem

getEnabledCheck, getExecutionHref, getHref, getIconCSS, getProjectHref, getTitle, getTitleCode, getType, isEnabled, isEnabled, isEnabledExecution

Method Detail

isEnabled

default boolean isEnabled(UserAndRolesAuthContext auth)

Parameters:

auth - auth context

Returns:

true if enabled, false if disabled

isEnabled

default boolean isEnabled(UserAndRolesAuthContext auth,
                          java.lang.String project)

Parameters:

auth - auth context

project - name for project oriented items

Returns:

true if enabled, false if disabled

isEnabledExecution

default boolean isEnabledExecution(UserAndRolesAuthContext auth,
                                   java.lang.String project,
                                   java.lang.String executionId)

Check if the menu item is enabled

Parameters:

auth - auth context

project - name for project oriented items

executionId - execution Id for Execution menu items

Returns:

true if enabled, false if disabled

getEnabledCheck

static java.util.function.Function<MenuItem,java.lang.Boolean> getEnabledCheck(MenuItem.MenuType menuType,
                                                                               UserAndRolesAuthContext authContext,
                                                                               java.lang.String project,
                                                                               java.lang.String executionId)

Parameters:

menuType - menu types to check

authContext - available auth context, if AuthMenuItems should be checked

project - project name, if available and project type should be checked

executionId - execution ID string, if available and execution type should be checked

Returns:

enabled check function given the input values