Package org.jenkinsci.plugins.matrixauth

Interface AuthorizationProperty

All Superinterfaces:

AuthorizationContainer

All Known Implementing Classes:

AuthorizationMatrixNodeProperty, AuthorizationMatrixProperty, AuthorizationMatrixProperty

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public interface AuthorizationProperty
extends AuthorizationContainer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AuthorizationProperty.DslEntry	Common superclass for AuthorizationProperty.DslUser, AuthorizationProperty.DslGroup, and AuthorizationProperty.DslUserOrGroup, supporting nicer DSLs for Job DSL and Pipeline Job definitions/reconfigurations.
static class	AuthorizationProperty.DslGroup	Represents a group being assigned permissions.
static class	AuthorizationProperty.DslUser	Represents a user being assigned permissions.
static class	AuthorizationProperty.DslUserOrGroup	Represents a user or group being assigned permissions.

Nested classes/interfaces inherited from interface org.jenkinsci.plugins.matrixauth.AuthorizationContainer

AuthorizationContainer.IdStrategyComparator, AuthorizationContainer.PermissionEntryComparator

Field Summary

Fields inherited from interface org.jenkinsci.plugins.matrixauth.AuthorizationContainer

LOGGER

Method Summary

Modifier and Type	Method	Description
default List<AuthorizationProperty.DslEntry>	getEntries()	Getter supporting nicer DSL syntax for Job DSL and Pipeline job property definitions.
InheritanceStrategy	getInheritanceStrategy()
default boolean	isBlocksInheritance()	Deprecated. Use getInheritanceStrategy() instead.
default void	setBlocksInheritance(boolean blocksInheritance)	Deprecated. Use InheritanceStrategy instead.
default void	setEntries(List<AuthorizationProperty.DslEntry> entries)	Set entries from DSL in Job DSL or Pipeline plugins.
void	setInheritanceStrategy(InheritanceStrategy inheritanceStrategy)

Methods inherited from interface org.jenkinsci.plugins.matrixauth.AuthorizationContainer

add, add, add, getAllPermissionEntries, getAllSIDs, getDescriptor, getEditingPermission, getGrantedPermissionEntries, getGrantedPermissions, getGroups, hasExplicitPermission, hasExplicitPermission, hasPermission, hasPermission, recordGroup

Method Details

setInheritanceStrategy

void setInheritanceStrategy(InheritanceStrategy inheritanceStrategy)

getInheritanceStrategy

InheritanceStrategy getInheritanceStrategy()

setBlocksInheritance

@Deprecated
default void setBlocksInheritance(boolean blocksInheritance)

Deprecated.

Use InheritanceStrategy instead.

Sets the flag to block inheritance. Since the introduction of inheritance strategies, set the inheritance strategy roughly matching the previous behavior, i.e. false will set the NonInheritingStrategy, true will set the InheritGlobalStrategy. Note that for items nested inside folders, this will change behavior significantly.

Since:

2.0

isBlocksInheritance

@Deprecated
default boolean isBlocksInheritance()

Deprecated.

Use getInheritanceStrategy() instead.

Returns true if the authorization matrix is configured to block inheritance from the parent. Since the introduction of inheritance strategies, returns true if and only if the selected inheritance strategy is NonInheritingStrategy.

Since:

2.0

setEntries

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
default void setEntries(List<AuthorizationProperty.DslEntry> entries)

Set entries from DSL in Job DSL or Pipeline plugins.

Parameters:

entries - list of entries to use for permission assignment

getEntries

default List<AuthorizationProperty.DslEntry> getEntries()

Getter supporting nicer DSL syntax for Job DSL and Pipeline job property definitions.

Returns:

a list of AuthorizationProperty.DslEntry