io.jenkins.plugins.folderauth.roles

Class AbstractRole

java.lang.Object

io.jenkins.plugins.folderauth.roles.AbstractRole

Direct Known Subclasses:

AgentRole, FolderRole, GlobalRole

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public abstract class AbstractRole
extends Object

A role as an immutable object

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() The name of the Role
Set<PermissionWrapper>	getPermissions() The permissions assigned to the role.
Set<String>	getSids() List of sids on which the role is applicable.
String	getSidsCommaSeparated() Return a 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 Detail

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 Detail

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 Set<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.

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 comma separated list of sids assigned to this role

Returns:

a comma separated list of sids assigned to this role