Package hudson.security

Class PermissionGroup

java.lang.Object

hudson.security.PermissionGroup

All Implemented Interfaces:

Comparable<PermissionGroup>, Iterable<Permission>

public final class PermissionGroup
extends Object
implements Iterable<Permission>, Comparable<PermissionGroup>

Group of Permissions that share the same owner. Sortable by the owner class name.

Field Summary

Fields

Modifier and Type	Field	Description
final Class	owner
final org.jvnet.localizer.Localizable	title	Human readable title of this permission group.

Constructor Summary

Constructors

Constructor	Description
PermissionGroup(Class owner, org.jvnet.localizer.Localizable title)	Both creates a registers a new permission group.
PermissionGroup(String id, Class owner, org.jvnet.localizer.Localizable title)	Both creates a registers a new permission group.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PermissionGroup that)
boolean	equals(Object o)
Permission	find(String name)	Finds a permission that has the given name.
static PermissionGroup	get(Class owner)	Gets the PermissionGroup whose owner is the given class.
static List<PermissionGroup>	getAll()	Returns all the PermissionGroups available in the system.
String	getId()	Gets ID of the permission group.
String	getOwnerClassName()
List<Permission>	getPermissions()	Lists up all the permissions in this group.
int	hashCode()
boolean	hasPermissionContainedBy(PermissionScope scope)
Iterator<Permission>	iterator()
int	size()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

owner

@NonNull
public final Class owner

title

public final org.jvnet.localizer.Localizable title

Human readable title of this permission group. This should be short.

Constructor Details

PermissionGroup

public PermissionGroup(@NonNull
 Class owner,
 org.jvnet.localizer.Localizable title)
                throws IllegalStateException

Both creates a registers a new permission group.

Parameters:

owner - sets owner

title - sets title

Throws:

IllegalStateException - if this group was already registered

PermissionGroup

public PermissionGroup(String id,
 @NonNull
 Class owner,
 org.jvnet.localizer.Localizable title)
                throws IllegalStateException

Both creates a registers a new permission group.

Parameters:

owner - sets owner

title - sets title

Throws:

IllegalStateException - if this group was already registered

Since:

2.127

Method Details

getId

public String getId()

Gets ID of the permission group.

Returns:

Non-localizable ID of the permission group.

getOwnerClassName

public String getOwnerClassName()

iterator

public Iterator<Permission> iterator()

Specified by:

iterator in interface Iterable<Permission>

getPermissions

public List<Permission> getPermissions()

Lists up all the permissions in this group.

hasPermissionContainedBy

public boolean hasPermissionContainedBy(PermissionScope scope)

find

public Permission find(String name)

Finds a permission that has the given name.

compareTo

public int compareTo(PermissionGroup that)

Specified by:

compareTo in interface Comparable<PermissionGroup>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

size

public int size()

toString

public String toString()

Overrides:

toString in class Object

getAll

public static List<PermissionGroup> getAll()

Returns all the PermissionGroups available in the system.

Returns:

always non-null. Read-only.

get

@CheckForNull
public static PermissionGroup get(Class owner)

Gets the PermissionGroup whose owner is the given class.

Returns:

null if not found.