com.agapsys.security

Class Role

java.lang.Object

com.agapsys.security.TreeObject<Role>

com.agapsys.security.Role

All Implemented Interfaces:

NamedObject, Serializable

public final class Role
extends TreeObject<Role>
implements NamedObject

Represents an role. Role is a permission for an action execution In order to create a role use RoleRepository

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addChild(Role... roles) Adds given roles as children of this object
void	addChild(String... roleNames) Adds given roles as children of this object.
boolean	equals(Object obj)
String	getName()
int	hashCode()
String	toString()

Methods inherited from class com.agapsys.security.TreeObject

addChild, belongsTo, belongsTo, clearChildren, getChildren, hasChild, hasChildren, hasChildren, removeChild

Methods inherited from class java.lang.Object

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

Method Detail

addChild

public final void addChild(Role... roles)
                    throws IllegalArgumentException,
                           DuplicateException

Adds given roles as children of this object

Parameters:

roles - roles to be added

Throws:

IllegalArgumentException - if roles.length == 0 or any given role is null

DuplicateException - if any of given roles was already added as a child (direct of indirect) of this instance

addChild

public final void addChild(String... roleNames)
                    throws DuplicateException,
                           IllegalArgumentException,
                           RoleNotFoundException

Adds given roles as children of this object. Children instance will be obtained through RoleRepository.

Parameters:

roleNames - name of the roles used to obtain instances

Throws:

IllegalArgumentException - if roleNames.length == 0 or any of given roleNames is null/empty

RoleNotFoundException - if given role is not registered in RoleRepository

DuplicateException - if any of given roles was already added as a child (direct of indirect) of this instance

getName

public String getName()

Specified by:

getName in interface NamedObject

Returns:

The name associated with this instance.

hashCode

public int hashCode()

Overrides:

hashCode in class TreeObject<Role>

equals

public boolean equals(Object obj)

Overrides:

equals in class TreeObject<Role>

toString

public String toString()

Overrides:

toString in class Object