Package org.jenkinsci.plugins.rolestrategy.casc

Class RoleDefinition

java.lang.Object

org.jenkinsci.plugins.rolestrategy.casc.RoleDefinition

All Implemented Interfaces:

Comparable<RoleDefinition>

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

Role definition. Used for custom formatting

Since:

2.11

Author:

Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoleDefinition.RoleDefinitionEntry	Maps a permission entry to the casc line.

Field Summary

Fields

Modifier and Type	Field	Description
static Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
RoleDefinition(String name, String description, String pattern, Collection<String> permissions)	Creates a RoleDefinition.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RoleDefinition o)
boolean	equals(Object o)
Collection<String>	getAssignments()	Deprecated, always returns null.
String	getDescription()
SortedSet<RoleDefinition.RoleDefinitionEntry>	getEntries()
String	getName()
String	getPattern()
Set<String>	getPermissions()
Role	getRole()	Returns the corresponding Role object.
String	getTemplateName()
int	hashCode()
void	setAssignments(Collection<String> assignments)	Deprecated. Use setEntries(java.util.Collection) instead.
void	setEntries(Collection<RoleDefinition.RoleDefinitionEntry> entries)	Setter for entries.
void	setTemplateName(String templateName)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final Logger LOGGER

Constructor Detail

RoleDefinition

@DataBoundConstructor
public RoleDefinition(String name,
                      String description,
                      String pattern,
                      Collection<String> permissions)

Creates a RoleDefinition.

Parameters:

name - Role name

description - Role description

pattern - Role pattern

permissions - Assigned permissions

Method Detail

setAssignments

@DataBoundSetter
@Deprecated
public void setAssignments(Collection<String> assignments)

Deprecated.

Use setEntries(java.util.Collection) instead.

Legacy setter for string based assignments.

Parameters:

assignments - The assigned sids

setEntries

@DataBoundSetter
public void setEntries(Collection<RoleDefinition.RoleDefinitionEntry> entries)

Setter for entries.

Parameters:

entries - The permission entries

getRole

public final Role getRole()

Returns the corresponding Role object.

Returns:

Role

getName

@NonNull
public String getName()

getDescription

public String getDescription()

getPattern

public String getPattern()

getTemplateName

public String getTemplateName()

setTemplateName

@DataBoundSetter
public void setTemplateName(String templateName)

getPermissions

public Set<String> getPermissions()

getAssignments

public Collection<String> getAssignments()

Deprecated, always returns null.

Returns:

null

getEntries

public SortedSet<RoleDefinition.RoleDefinitionEntry> getEntries()

compareTo

public int compareTo(@NonNull
                     RoleDefinition o)

Specified by:

compareTo in interface Comparable<RoleDefinition>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object