Package io.jenkins.plugins.folderauth.roles

Class AbstractRole

java.lang.Object

io.jenkins.plugins.folderauth.roles.AbstractRole

All Implemented Interfaces:

Comparable<AbstractRole>

Direct Known Subclasses:

AgentRole, FolderRole, GlobalRole

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public abstract class AbstractRole
extends Object
implements Comparable<AbstractRole>

A role as an immutable object

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name	The unique name of the role.
protected final Set<String>	sids	The sids on which this role is applicable.

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractRole other)
boolean	equals(Object o)
String	getName()	The name of the Role
SortedSet<PermissionWrapper>	getPermissions()	The permissions assigned to the role.
Set<PermissionWrapper>	getPermissionsUnsorted()	The permissions assigned to the role in an unsorted order.
Set<String>	getSids()	List of sids on which the role is applicable.
String	getSidsCommaSeparated()	Return a sorted comma separated list of sids assigned to this role
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

name

@NonNull
protected final String name

The unique name of the role.

sids

@NonNull
protected final Set<String> sids

The sids on which this role is applicable.

Method Details

compareTo

public int compareTo(@NonNull
 AbstractRole other)

Specified by:

compareTo in interface Comparable<AbstractRole>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

@NonNull
public String getName()

The name of the Role

Returns:

the name of the role

getPermissions

@NonNull
public SortedSet<PermissionWrapper> getPermissions()

The permissions assigned to the role.

This method, however, does not return all permissions implied by this AbstractRole

Returns:

the permissions assigned to the role.

See Also:

• when the permissions are not needed in a sorted order.

getPermissionsUnsorted

@NonNull
public Set<PermissionWrapper> getPermissionsUnsorted()

The permissions assigned to the role in an unsorted order.

Returns:

permissions in an unsorted order.

See Also:

• when permissions are needed in a sorted order.

getSids

@NonNull
public Set<String> getSids()

List of sids on which the role is applicable.

Returns:

list of sids on which this role is applicable.

getSidsCommaSeparated

@NonNull
public String getSidsCommaSeparated()

Return a sorted comma separated list of sids assigned to this role

Returns:

a sorted comma separated list of sids assigned to this role