com.michelin.cio.hudson.plugins.rolestrategy

Class Role

java.lang.Object

com.michelin.cio.hudson.plugins.rolestrategy.Role

All Implemented Interfaces:

Comparable

public final class Role
extends Object
implements Comparable

Class representing a role, which holds a set of Permissions.

Author:

Thomas Maurel

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL_ROLE_PATTERN

Constructor Summary

Constructors

Constructor and Description
Role(String name, String pattern, Set<String> permissionIds, String description)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compare role names.
boolean	equals(Object obj)
String	getDescription() Gets the role description.
String	getName() Getter for the role name.
Pattern	getPattern() Getter for the regexp pattern.
Set<hudson.security.Permission>	getPermissions() Getter for the Permissions set.
Boolean	hasAnyPermission(Set<hudson.security.Permission> permissions) Checks if the role holds any of the given Permission.
int	hashCode()
Boolean	hasPermission(hudson.security.Permission permission) Checks if the role holds the given Permission.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_ROLE_PATTERN

public static final String GLOBAL_ROLE_PATTERN

See Also:

Constant Field Values

Constructor Detail

Role

@DataBoundConstructor
public Role(@Nonnull
                                  String name,
                                  @CheckForNull
                                  String pattern,
                                  @CheckForNull
                                  Set<String> permissionIds,
                                  @CheckForNull
                                  String description)

Method Detail

getName

public final String getName()

Getter for the role name.

Returns:

The role name

getPattern

public final Pattern getPattern()

Getter for the regexp pattern.

Returns:

The pattern associated to the role

getPermissions

public final Set<hudson.security.Permission> getPermissions()

Getter for the Permissions set.

Returns:

Permissions set

getDescription

@CheckForNull
public String getDescription()

Gets the role description.

Returns:

Role description. null if not set

hasPermission

public final Boolean hasPermission(hudson.security.Permission permission)

Checks if the role holds the given Permission.

Parameters:

permission - The permission you want to check

Returns:

True if the role holds this permission

hasAnyPermission

public final Boolean hasAnyPermission(Set<hudson.security.Permission> permissions)

Checks if the role holds any of the given Permission.

Parameters:

permissions - A Permissions set

Returns:

True if the role holds any of the given Permissions

compareTo

public int compareTo(Object o)

Compare role names. Used to sort the sets. We presume that any role name is being used once and only once.

Specified by:

compareTo in interface Comparable

Parameters:

o - The object you want to compare this instance to

Returns:

Comparison of role names

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object