@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public interface AuthorizationContainer
Modifier and Type | Interface and Description |
---|---|
static class |
AuthorizationContainer.IdStrategyComparator |
static class |
AuthorizationContainer.PermissionEntryComparator |
Modifier and Type | Method and Description |
---|---|
default void |
add(Permission permission,
PermissionEntry entry)
Adds to
getGrantedPermissionEntries() . |
default void |
add(Permission permission,
String sid)
Deprecated.
Since 3.0, use
add(Permission, PermissionEntry) instead. |
default void |
add(String shortForm)
Works like
add(Permission, PermissionEntry) but takes both parameters
from a single string of the form PERMISSION_ID:sid (legacy format, implicit 'EITHER' type)
or type:PERMISSION_ID:sid (new since 3.0). |
default List<PermissionEntry> |
getAllPermissionEntries() |
default List<String> |
getAllSIDs()
Deprecated.
Since 3.0, use {
getAllPermissionEntries() } instead. |
Descriptor |
getDescriptor() |
Permission |
getEditingPermission() |
Map<Permission,Set<PermissionEntry>> |
getGrantedPermissionEntries()
Returns a live modifiable map of permissions.
|
default Map<Permission,Set<String>> |
getGrantedPermissions()
Deprecated.
Since 3.0, use {
getGrantedPermissionEntries() } instead. |
Set<String> |
getGroups()
Internal only: Returns all recorded (possible) group sids to allow populating
AuthorizationStrategy.getGroups() . |
default boolean |
hasExplicitPermission(PermissionEntry entry,
Permission p)
Return true if and only if the exact permission entry is explicitly granted the specified permission,
ignoring compatible types (e.g.
|
default boolean |
hasExplicitPermission(String sid,
Permission p)
Deprecated.
|
default boolean |
hasPermission(String sid,
Permission p)
Deprecated.
Use
hasPermission(String, Permission, boolean) instead. |
default boolean |
hasPermission(String sid,
Permission p,
boolean principal)
Checks if the given SID has the given permission.
|
void |
recordGroup(String sid)
Internal only: Record use of a (possible) group sid to be later returned in
getGroups() . |
static final Logger LOGGER
@Deprecated default void add(Permission permission, String sid)
add(Permission, PermissionEntry)
instead.default void add(Permission permission, PermissionEntry entry)
getGrantedPermissionEntries()
. Use of this method should be limited
during construction, as this object itself is considered immutable once
populated.@Deprecated default Map<Permission,Set<String>> getGrantedPermissions()
getGrantedPermissionEntries()
} instead.Map<Permission,Set<PermissionEntry>> getGrantedPermissionEntries()
Set<String> getGroups()
AuthorizationStrategy.getGroups()
.void recordGroup(String sid)
getGroups()
.Descriptor getDescriptor()
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) default void add(String shortForm)
add(Permission, PermissionEntry)
but takes both parameters
from a single string of the form PERMISSION_ID:sid
(legacy format, implicit 'EITHER' type)
or type:PERMISSION_ID:sid
(new since 3.0).@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) Permission getEditingPermission()
@Deprecated default List<String> getAllSIDs()
getAllPermissionEntries()
} instead.default List<PermissionEntry> getAllPermissionEntries()
@Deprecated default boolean hasPermission(String sid, Permission p)
hasPermission(String, Permission, boolean)
instead.default boolean hasPermission(String sid, Permission p, boolean principal)
@Deprecated default boolean hasExplicitPermission(String sid, Permission p)
Permission.impliedBy
.default boolean hasExplicitPermission(PermissionEntry entry, Permission p)
entry
- the entry to check forp
- the permission to check forCopyright © 2016–2022. All rights reserved.