Package com.cloudbees.hudson.plugins.folder.properties

Class AuthorizationMatrixProperty

java.lang.Object

hudson.model.AbstractDescribableImpl<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>

com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

com.cloudbees.hudson.plugins.folder.properties.AuthorizationMatrixProperty

All Implemented Interfaces:

ExtensionPoint, Describable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>, ReconfigurableDescribable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>, AuthorizationContainer, AuthorizationProperty

public class AuthorizationMatrixProperty
extends com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>
implements AuthorizationProperty

Holds ACL for ProjectMatrixAuthorizationStrategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AuthorizationMatrixProperty.ConverterImpl	Persist AuthorizationMatrixProperty as a list of IDs that represent AuthorizationContainer.getGrantedPermissions().
static class	AuthorizationMatrixProperty.DescriptorImpl
static class	AuthorizationMatrixProperty.ItemListenerImpl	Ensure that the user creating a folder has Read and Configure permissions

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

AuthorizationContainer.IdStrategyComparator, AuthorizationContainer.PermissionEntryComparator

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

AuthorizationProperty.DslEntry, AuthorizationProperty.DslGroup, AuthorizationProperty.DslUser, AuthorizationProperty.DslUserOrGroup

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

owner

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthorizationMatrixProperty()
	AuthorizationMatrixProperty(List<AuthorizationProperty.DslEntry> entries)	Exists for reflective Job DSL / Pipeline use only.
	AuthorizationMatrixProperty(Map<Permission,? extends Set<String>> grantedPermissions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
SidACL	getACL()
Permission	getEditingPermission()
List<AuthorizationProperty.DslEntry>	getEntries()	Getter supporting nicer DSL syntax for Job DSL and Pipeline job property definitions.
Map<Permission,Set<PermissionEntry>>	getGrantedPermissionEntries()	Returns a live modifiable map of permissions.
Set<String>	getGroups()	Internal only: Returns all recorded (possible) group sids to allow populating AuthorizationStrategy.getGroups().
InheritanceStrategy	getInheritanceStrategy()
void	recordGroup(String sid)	Internal only: Record use of a (possible) group sid to be later returned in AuthorizationContainer.getGroups().
void	setInheritanceStrategy(InheritanceStrategy inheritanceStrategy)
protected void	setOwner(com.cloudbees.hudson.plugins.folder.AbstractFolder<?> owner)

Methods inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty

getDescriptor, getHealthMetrics, getHealthReports, getItemContainerOverrides, getOwner, reconfigure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

add, add, add, getAllPermissionEntries, getAllSIDs, getDescriptor, getGrantedPermissions, hasExplicitPermission, hasExplicitPermission, hasPermission, hasPermission

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

isBlocksInheritance, setBlocksInheritance, setEntries

Constructor Details

AuthorizationMatrixProperty

protected AuthorizationMatrixProperty()

AuthorizationMatrixProperty

@Deprecated
public AuthorizationMatrixProperty(Map<Permission,? extends Set<String>> grantedPermissions)

Deprecated.

AuthorizationMatrixProperty

@DataBoundConstructor
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public AuthorizationMatrixProperty(List<AuthorizationProperty.DslEntry> entries)

Exists for reflective Job DSL / Pipeline use only.

Method Details

getGroups

public Set<String> getGroups()

Description copied from interface: AuthorizationContainer

Internal only: Returns all recorded (possible) group sids to allow populating AuthorizationStrategy.getGroups().

Specified by:

getGroups in interface AuthorizationContainer

recordGroup

public void recordGroup(String sid)

Description copied from interface: AuthorizationContainer

Internal only: Record use of a (possible) group sid to be later returned in AuthorizationContainer.getGroups().

Specified by:

recordGroup in interface AuthorizationContainer

getGrantedPermissionEntries

public Map<Permission,Set<PermissionEntry>> getGrantedPermissionEntries()

Description copied from interface: AuthorizationContainer

Returns a live modifiable map of permissions. This return value needs to be treated as unmodifiable from shortly after object construction (even though it isn't for practical reasons).

Specified by:

getGrantedPermissionEntries in interface AuthorizationContainer

getEditingPermission

public Permission getEditingPermission()

Specified by:

getEditingPermission in interface AuthorizationContainer

setOwner

protected void setOwner(@NonNull
 com.cloudbees.hudson.plugins.folder.AbstractFolder<?> owner)

Overrides:

setOwner in class com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<com.cloudbees.hudson.plugins.folder.AbstractFolder<?>>

getEntries

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public List<AuthorizationProperty.DslEntry> getEntries()

Description copied from interface: AuthorizationProperty

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

Specified by:

getEntries in interface AuthorizationProperty

Returns:

a list of AuthorizationProperty.DslEntry

getACL

public SidACL getACL()

setInheritanceStrategy

@DataBoundSetter
public void setInheritanceStrategy(InheritanceStrategy inheritanceStrategy)

Specified by:

setInheritanceStrategy in interface AuthorizationProperty

getInheritanceStrategy

public InheritanceStrategy getInheritanceStrategy()

Specified by:

getInheritanceStrategy in interface AuthorizationProperty