org.seedstack.seed.security

Class Role

java.lang.Object

org.seedstack.seed.security.Role

All Implemented Interfaces:

Serializable

public class Role
extends Object
implements Serializable

Represents a Role and optionally a collection of scopes on which it is given. This scope must be given to all the permissions this role grants.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Role(String name) Constructor with name

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName()
Set<Permission>	getPermissions()
Collection<Scope>	getScopes()
<S extends Scope> Set<S>	getScopesByType(Class<S> scopeType) Filters the scopes corresponding to a type
int	hashCode()
static Role	unmodifiableRole(Role role) Convenient method to get an unmodifiable role from a role

Methods inherited from class java.lang.Object

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

Constructor Detail

Role

public Role(String name)

Constructor with name

Parameters:

name - the name

Method Detail

unmodifiableRole

public static Role unmodifiableRole(Role role)

Convenient method to get an unmodifiable role from a role

Parameters:

role - the role to protect

Returns:

the unmodifiable role

getName

public String getName()

Returns:

the name

getScopes

public Collection<Scope> getScopes()

Returns:

the scopes

getPermissions

public Set<Permission> getPermissions()

Returns:

the permissions

getScopesByType

public <S extends Scope> Set<S> getScopesByType(Class<S> scopeType)

Filters the scopes corresponding to a type

Type Parameters:

S - the type of the scope to filter.

Parameters:

scopeType - the type of scope

Returns:

the scopes of the given type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object