Package org.apache.fulcrum.security.model.dynamic.entity.impl

Class DynamicRoleImpl

java.lang.Object

org.apache.fulcrum.security.entity.impl.SecurityEntityImpl

org.apache.fulcrum.security.model.dynamic.entity.impl.DynamicRoleImpl

All Implemented Interfaces:

Serializable, Role, SecurityEntity, DynamicRole

public class DynamicRoleImpl
extends SecurityEntityImpl
implements DynamicRole

Represents the "simple" model where permissions are related to roles, roles are related to groups and groups are related to users, all in many to many relationships.

Version:

$Id: DynamicRole.java 437451 2006-08-27 20:20:44Z tv $

Author:

Eric Pugh

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DynamicRoleImpl()

Method Summary

Modifier and Type	Method	Description
void	addGroup(Group group)	This method should only be used by a RoleManager.
void	addPermission(Permission permission)	This method should only be used by a RoleManager.
GroupSet	getGroups()	Get the groups this role belongs to
<T extends Group> Set<T>	getGroupsAsSet()	Get the groups this role belongs to as a Set
PermissionSet	getPermissions()	Get the permission that are part of this role
<T extends Permission> Set<T>	getPermissionsAsSet()	Get the permission that are part of this role as Set
void	removeGroup(Group group)	This method should only be used by a RoleManager.
void	removePermission(Permission permission)	This method should only be used by a RoleManager.
void	setGroups(GroupSet groupSet)	Set the groups this role belongs to
<T extends Group> void	setGroupsAsSet(Set<T> groups)	Set the groups this role belongs to as a Set
void	setPermissions(PermissionSet permissionSet)	Set the permission that are part of this role
<T extends Permission> void	setPermissionsAsSet(Set<T> permissions)	Set the permission that are part of this role as Set

Methods inherited from class org.apache.fulcrum.security.entity.impl.SecurityEntityImpl

equals, getId, getName, hashCode, setId, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity

getId, getName, setId, setName

Constructor Detail

DynamicRoleImpl

public DynamicRoleImpl()

Method Detail

getPermissions

public PermissionSet getPermissions()

Get the permission that are part of this role

Specified by:

getPermissions in interface DynamicRole

Returns:

a set of permissions

getPermissionsAsSet

public <T extends Permission> Set<T> getPermissionsAsSet()

Get the permission that are part of this role as Set

Specified by:

getPermissionsAsSet in interface DynamicRole

Returns:

a set of permissions

setPermissions

public void setPermissions(PermissionSet permissionSet)

Set the permission that are part of this role

Specified by:

setPermissions in interface DynamicRole

Parameters:

permissionSet - a set of permissions

setPermissionsAsSet

public <T extends Permission> void setPermissionsAsSet(Set<T> permissions)

Set the permission that are part of this role as Set

Specified by:

setPermissionsAsSet in interface DynamicRole

Parameters:

permissions - a set of permissions

addPermission

public void addPermission(Permission permission)

This method should only be used by a RoleManager. Not directly.

Specified by:

addPermission in interface DynamicRole

Parameters:

permission - the Permission to add

removePermission

public void removePermission(Permission permission)

This method should only be used by a RoleManager. Not directly.

Specified by:

removePermission in interface DynamicRole

Parameters:

permission - the Permission to remove

getGroups

public GroupSet getGroups()

Get the groups this role belongs to

Specified by:

getGroups in interface DynamicRole

Returns:

a set of groups

setGroups

public void setGroups(GroupSet groupSet)

Set the groups this role belongs to

Specified by:

setGroups in interface DynamicRole

Parameters:

groupSet - the set of groups

removeGroup

public void removeGroup(Group group)

This method should only be used by a RoleManager. Not directly.

Specified by:

removeGroup in interface DynamicRole

Parameters:

group - the Group to remove

addGroup

public void addGroup(Group group)

This method should only be used by a RoleManager. Not directly.

Specified by:

addGroup in interface DynamicRole

Parameters:

group - the Group to add

setGroupsAsSet

public <T extends Group> void setGroupsAsSet(Set<T> groups)

Set the groups this role belongs to as a Set

Specified by:

setGroupsAsSet in interface DynamicRole

Parameters:

groups - the set of groups

getGroupsAsSet

public <T extends Group> Set<T> getGroupsAsSet()

Get the groups this role belongs to as a Set

Specified by:

getGroupsAsSet in interface DynamicRole

Returns:

a set of groups