fathom.authz

Class Role

java.lang.Object

fathom.authz.Role

All Implemented Interfaces:

Serializable

public class Role
extends Object
implements Serializable

A simple representation of a security role that has a name and a collection of permissions. This object can be used internally by Realms to maintain authorization state.

This class was adapted from Apache Shiro.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected Set<Permission>	permissions

Constructor Summary

Constructors

Constructor and Description
Role(String name)
Role(String name, Set<Permission> permissions)
Role(String name, String... permissions)

Method Summary

Modifier and Type	Method and Description
Role	addPermission(Permission permission)
Role	addPermission(String permission)
Role	addPermissions(Collection<Permission> perms)
Role	addPermissions(String... perms)
boolean	equals(Object o)
String	getName()
Set<Permission>	getPermissions()
int	hashCode()
boolean	isPermitted(Permission permission)
boolean	isPermitted(String permission)
void	setPermissions(Set<Permission> permissions)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

permissions

protected final Set<Permission> permissions

Constructor Detail

Role

public Role(String name)

Role

public Role(String name,
            String... permissions)

Role

public Role(String name,
            Set<Permission> permissions)

Method Detail

getName

public String getName()

getPermissions

public Set<Permission> getPermissions()

setPermissions

public void setPermissions(Set<Permission> permissions)

addPermission

public Role addPermission(String permission)

addPermission

public Role addPermission(Permission permission)

addPermissions

public Role addPermissions(String... perms)

addPermissions

public Role addPermissions(Collection<Permission> perms)

isPermitted

public boolean isPermitted(String permission)

isPermitted

public boolean isPermitted(Permission permission)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object