com.sun.enterprise.security.acl

Class RoleMapper

java.lang.Object

com.sun.enterprise.security.acl.RoleMapper

All Implemented Interfaces:

Serializable, SecurityRoleMapper

public class RoleMapper
extends Object
implements Serializable, SecurityRoleMapper

This class maintains a mapping of users and groups to application specific roles.

Using this class the mapping information can be maintained and queried at a later time.

Author:

Harpreet Singh

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RoleMapper(RoleMapper r) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	assignRole(Principal p, Role r, RootDeploymentDescriptor rdd) Assigns a Principal to the specified role.
Enumeration<Group>	getGroupsAssignedTo(Role r) Returns an enumeration of Groups assigned to the given role
String	getName()
Iterator<String>	getRoles() Returns an enumeration of roles for this rolemapper.
Map<String,Subject>	getRoleToSubjectMapping() Returns the RoleToSubjectMapping for the RoleMapping
Enumeration<Principal>	getUsersAssignedTo(Role r) Returns an enumeration of Principals assigned to the given role
void	setName(String name) Set the role mapper application name
String	toString()
void	unassignPrincipalFromRole(Role role, Principal principal) Remove the given role-principal mapping
void	unassignRole(Role r) Remove all the role mapping information for this role

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleMapper

public RoleMapper(RoleMapper r)

Copy constructor. This is called from the JSR88 implementation. This is not stored into the internal rolemapper maps.

Method Detail

getName

public String getName()

Specified by:

getName in interface SecurityRoleMapper

Returns:

The application/module name for this RoleMapper

setName

public void setName(String name)

Description copied from interface: SecurityRoleMapper

Set the role mapper application name

Specified by:

setName in interface SecurityRoleMapper

Parameters:

name - The application/module name

unassignPrincipalFromRole

public void unassignPrincipalFromRole(Role role,
                                      Principal principal)

Remove the given role-principal mapping

Specified by:

unassignPrincipalFromRole in interface SecurityRoleMapper

Parameters:

role, - Role object

principal, - the principal

getRoleToSubjectMapping

public Map<String,Subject> getRoleToSubjectMapping()

Returns the RoleToSubjectMapping for the RoleMapping

Specified by:

getRoleToSubjectMapping in interface SecurityRoleMapper

Returns:

Map of role->subject mapping

assignRole

public void assignRole(Principal p,
                       Role r,
                       RootDeploymentDescriptor rdd)

Assigns a Principal to the specified role. This method delegates work to internalAssignRole() after checking for conflicts. RootDeploymentDescriptor added as a fix for: https://glassfish.dev.java.net/issues/show_bug.cgi?id=2475 The first time this is called, a new Mapping object is created to store the role mapping information. When called again from a different module, the old mapping information is checked and stored and a new Mapping object is created.

Specified by:

assignRole in interface SecurityRoleMapper

Parameters:

p - The principal that needs to be assigned to the role.

r - The Role the principal is being assigned to.

rdd - The descriptor of the module containing the role mapping

getRoles

public Iterator<String> getRoles()

Returns an enumeration of roles for this rolemapper.

Specified by:

getRoles in interface SecurityRoleMapper

Returns:

an iterator on all the assigned roles

getGroupsAssignedTo

public Enumeration<Group> getGroupsAssignedTo(Role r)

Returns an enumeration of Groups assigned to the given role

Specified by:

getGroupsAssignedTo in interface SecurityRoleMapper

Parameters:

The - Role to which the groups are assigned to.

getUsersAssignedTo

public Enumeration<Principal> getUsersAssignedTo(Role r)

Returns an enumeration of Principals assigned to the given role

Specified by:

getUsersAssignedTo in interface SecurityRoleMapper

Parameters:

The - Role to which the principals are assigned to.

unassignRole

public void unassignRole(Role r)

Description copied from interface: SecurityRoleMapper

Remove all the role mapping information for this role

Specified by:

unassignRole in interface SecurityRoleMapper

toString

public String toString()

Overrides:

toString in class Object

Returns:

String. String representation of the RoleToPrincipal Mapping