org.jboss.security.identity.plugins

Class SimpleRoleGroup

java.lang.Object

org.jboss.security.identity.plugins.SimpleRole

org.jboss.security.identity.plugins.SimpleRoleGroup

All Implemented Interfaces:

Serializable, Cloneable, Role, RoleGroup

public class SimpleRoleGroup
extends SimpleRole
implements RoleGroup

Simple Role Group

Since:

Nov 16, 2007

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jboss.security.identity.plugins.SimpleRole

ANYBODY, ANYBODY_ROLE

Constructor Summary

Constructors

Constructor and Description
SimpleRoleGroup(Group rolesGroup)
SimpleRoleGroup(Set<Principal> rolesAsPrincipals)
SimpleRoleGroup(String roleName)
SimpleRoleGroup(String roleName, Collection<Role> roles)

Method Summary

Modifier and Type	Method and Description
void	addAll(Collection<Role> roles) Adds all specified roles to the role group.
void	addRole(Role role) Add a role
void	clearRoles() Clear all the roles
Object	clone()
boolean	containsAll(Role anotherRole) Indicate whether the argument role is equal or contained depending on the role-type
boolean	containsAtleastOneRole(RoleGroup anotherRole) Validates whether there is at least one matching role in "anotherRoleGroup"
boolean	containsRole(Role role) Validates whether a simple role is available
Collection<Role>	getRoles() Get the roles contained in the RoleGroup.
RoleType	getType() Get type of role
void	removeRole(Role role) Remove a role
String	toString()

Methods inherited from class org.jboss.security.identity.plugins.SimpleRole

equals, getParent, getRoleName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.security.identity.Role

getParent, getRoleName

Constructor Detail

SimpleRoleGroup

public SimpleRoleGroup(String roleName)

SimpleRoleGroup

public SimpleRoleGroup(String roleName,
                       Collection<Role> roles)

SimpleRoleGroup

public SimpleRoleGroup(Group rolesGroup)

SimpleRoleGroup

public SimpleRoleGroup(Set<Principal> rolesAsPrincipals)

Method Detail

getType

public RoleType getType()

Description copied from interface: Role

Get type of role

Specified by:

getType in interface Role

Overrides:

getType in class SimpleRole

Returns:

simple,group

addRole

public void addRole(Role role)

Description copied from interface: RoleGroup

Add a role

Specified by:

addRole in interface RoleGroup

addAll

public void addAll(Collection<Role> roles)

Description copied from interface: RoleGroup

Adds all specified roles to the role group.

Specified by:

addAll in interface RoleGroup

Parameters:

roles - the list of roles to be added.

removeRole

public void removeRole(Role role)

Description copied from interface: RoleGroup

Remove a role

Specified by:

removeRole in interface RoleGroup

clearRoles

public void clearRoles()

Description copied from interface: RoleGroup

Clear all the roles

Specified by:

clearRoles in interface RoleGroup

getRoles

public Collection<Role> getRoles()

Description copied from interface: RoleGroup

Get the roles contained in the RoleGroup. The returned List should be unmodifiable as the RoleGroup interface provides methods to add and remove roles.

Specified by:

getRoles in interface RoleGroup

Returns:

a unmodifiable Collection containing the RoleGroup's roles.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class SimpleRole

Throws:

CloneNotSupportedException

containsAll

public boolean containsAll(Role anotherRole)

Description copied from interface: Role

Indicate whether the argument role is equal or contained depending on the role-type

Specified by:

containsAll in interface Role

Overrides:

containsAll in class SimpleRole

Returns:

true or false

See Also:

Role#contains(Role)

containsAtleastOneRole

public boolean containsAtleastOneRole(RoleGroup anotherRole)

Description copied from interface: RoleGroup

Validates whether there is at least one matching role in "anotherRoleGroup"

Specified by:

containsAtleastOneRole in interface RoleGroup

Parameters:

anotherRole - another role group

Returns:

containsRole

public boolean containsRole(Role role)

Description copied from interface: RoleGroup

Validates whether a simple role is available

Specified by:

containsRole in interface RoleGroup

Parameters:

role - simple role

Returns:

toString

public String toString()

Overrides:

toString in class SimpleRole