org.jboss.security
Class NestablePrincipal

java.lang.Object
  org.jboss.security.SimplePrincipal (src) 
      org.jboss.security.NestablePrincipal

All Implemented Interfaces:

java.security.acl.Group, java.security.Principal, java.io.Serializable

public class NestablePrincipal

extends SimplePrincipal (src)

implements java.security.acl.Group

An implementation of Group that allows that acts as a stack of Principals with a single Principal Group member active at any time. When one adds a Principal to a NestablePrincipal the Principal is pushed onto the active Princpal stack and any of the Group methods operate as though the Group contains only the Principal. When removing the Principal that corresponds to the active Principal, the active Principal is popped from the stack and the new active Principal is effectively set to the new top of the stack. The typical usage of this class is when doing a JAAS LoginContext login to runAs a new Principal with a new CallerPrincipal identity without destroying the current CallerPrincipal identity and roles.

See Also:

Serialized Form

NestablePrincipal

public NestablePrincipal(java.lang.String name)

Creates new NestablePrincipal with the given name

members

public java.util.Enumeration members()

Returns an enumeration that contains the single active Principal.

Specified by:

members in interface java.security.acl.Group

Returns:

an Enumeration of the single active Principal.

removeMember

public boolean removeMember(java.security.Principal user)

Removes the first occurence of user from the Principal stack.

Specified by:

removeMember in interface java.security.acl.Group

Parameters:

user - the principal to remove from this group.

Returns:

true if the principal was removed, or false if the principal was not a member.

addMember

public boolean addMember(java.security.Principal user)

Pushes the user onto the Principal stack and makes it the active Principal.

Specified by:

addMember in interface java.security.acl.Group

Returns:

true always.

isMember

public boolean isMember(java.security.Principal member)

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned.

Specified by:

isMember in interface java.security.acl.Group

Parameters:

member - the principal whose membership is to be checked.

Returns:

true if the principal is a member of this group, false otherwise.