com.agapsys.security

Class RoleBasedObject

java.lang.Object

com.agapsys.security.RoleBasedObject

Direct Known Subclasses:

AbstractAction, AbstractUser

public abstract class RoleBasedObject
extends Object

Represents an object with association to roles.

Constructor Summary

Constructors

Constructor and Description
RoleBasedObject() Constructor.
RoleBasedObject(Role... roles) Constructor.
RoleBasedObject(String... roleNames) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRole(Role... roles) Associates given roles to this object
void	addRole(String... roleNames) Associates given roles to this object
void	clearRoles() Removes all role associations.
Set<Role>	getRoles()
void	removeRole(Role... roles) Removes the association of a role with this instance.
void	removeRole(String... roleNames) Removes the association of a role with this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleBasedObject

public RoleBasedObject()

Constructor. Creates an object without any associated role.

RoleBasedObject

public RoleBasedObject(Role... roles)
                throws IllegalArgumentException,
                       DuplicateException

Constructor.

Parameters:

roles - default roles associated to this object

Throws:

IllegalArgumentException - if any of given roles is null

DuplicateException - if there is an attempt to register the same role more than once (either directly of as a child of any associated role).

RoleBasedObject

public RoleBasedObject(String... roleNames)
                throws IllegalArgumentException,
                       DuplicateException,
                       RoleNotFoundException

Constructor.

Parameters:

roleNames - default role names associated to this object. Role instances will be obtained through RoleRepository

Throws:

IllegalArgumentException - if any of given role names is null/empty

DuplicateException - if there is an attempt to register the same role more than once (either directly of as a child of any associated role).

RoleNotFoundException - if any of given roleNames is not registered in RoleRepository

Method Detail

getRoles

public Set<Role> getRoles()

Returns:

a read-only set of roles associated to this instance.

addRole

public void addRole(Role... roles)
             throws DuplicateException,
                    IllegalArgumentException

Associates given roles to this object

Parameters:

roles - to be associated

Throws:

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

DuplicateException - if given role was already associated to this object (either directly or as child of any associated role)

addRole

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

Associates given roles to this object

Parameters:

roleNames - roles to be added. Role instances will be obtained through RoleRepository

Throws:

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

DuplicateException - if given role was already associated to this object (either directly or as child of any associated role)

RoleNotFoundException - if any of given roleNames is not registered in RoleRepository

removeRole

public void removeRole(Role... roles)
                throws IllegalArgumentException

Removes the association of a role with this instance.

Parameters:

roles - role to be removed from association set. If given role is not associated to this instance, nothing happens.

Throws:

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

removeRole

public void removeRole(String... roleNames)
                throws IllegalArgumentException,
                       RoleNotFoundException

Removes the association of a role with this instance.

Parameters:

roleNames - role to be removed from association set. If given role is not associated to this instance, nothing happens. Role instances will be obtained through RoleRepository

Throws:

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

RoleNotFoundException - if any given role is not registered in RoleRepository

clearRoles

public void clearRoles()

Removes all role associations.