edu.mit.stellar.api.group
Interface SGroup

All Superinterfaces:

java.security.acl.Group, java.security.Principal

All Known Subinterfaces:

SGroupM

All Known Implementing Classes:

AbstractPrincipalSGroupM, AbstractSGroupM, PrincipalSGroupMImpl

public interface SGroup
extends java.security.acl.Group

SGroup. Simple 'group' interface. Initial designs created a generalized 'group' interface, supporting and unifying three different models of 'group'.

• named user set set: of userids (user guids or other id)
• named principal set: set of userids or other "named principal set"s, as in javax.security.acl.Group, which extends javax.security.acl.Principal
  When used in an ACL, either of these types of groups may have an implicit or explicit RBAC-Role.
• named categorized-user set Set of (userid, categoryref) pairs, where the same user may appear in the set multiple times with different categoryrefs. The category is often a role of some form. This pattern appears in IMS Enterprise groups, and Sakai AuthzGroups. Instead, these are separated into the "named principal set" with a list of userid-based principals as one case, and a model of mapping principals to organizations by defining "relationships" with different types (categories above). In this latter model, "groups" are derived dynamically based on the relationship data. This is in the "roster" package. While this extends Group, the methods for adding and removing members should not be used since there is no guarantee that the underlying implementation represents a modifiable group.

  Version:

  $Revision: 30001 $, $Date: 2008-02-11 00:20:04 -0500 (Mon, 11 Feb 2008) $

  Author:

  MIT Stellar team

  Method Summary

  boolean	addMember(java.security.Principal member) Deprecated. Use SGroupM interface for a modifiable group.
  java.security.Principal	getAdministrator() Deprecated. need for this is under review
  java.lang.String	getDescription() localized description explaining this group.
  java.lang.String	getGroupId() Id for this group.
  java.lang.String	getGroupManagerId() Id of the manager/provider for this group, for system configuration.
  java.security.Principal	getOwner() Deprecated. need for this is under review
  java.util.Set<java.security.Principal>	getPrincipalSet() Get the set of Principals in this group.
  java.lang.String	getTitle() Short, localized, human-readable title or display name for this group.
  boolean	removeMember(java.security.Principal member) Deprecated. Use SGroupM interface for a modifiable group.

  Methods inherited from interface java.security.acl.Group

  isMember, members

  Methods inherited from interface java.security.Principal

  equals, getName, hashCode, toString

  Method Detail

  getGroupManagerId

  java.lang.String getGroupManagerId()

  Id of the manager/provider for this group, for system configuration. Id should have no spaces or special characters (e.g. &, *, %) and must not have any / , but it need not be a UUID.

  getGroupId

  java.lang.String getGroupId()

  Id for this group. Id must uniquely identify the group within the manager/provider. It need not be a UUID.

  Returns:

  Id string.

  getTitle

  java.lang.String getTitle()

  Short, localized, human-readable title or display name for this group.

  Returns:

  localized title.

  getDescription

  java.lang.String getDescription()

  localized description explaining this group.

  Returns:

  localized group description.

  addMember

  boolean addMember(java.security.Principal member)

  Deprecated. Use SGroupM interface for a modifiable group.

  Specified by:

  addMember in interface java.security.acl.Group

  See Also:

  java.security.act.Group#addMember(java.security.Principal)

  removeMember

  boolean removeMember(java.security.Principal member)

  Deprecated. Use SGroupM interface for a modifiable group.

  Specified by:

  removeMember in interface java.security.acl.Group

  See Also:

  java.security.act.Group#removeMember(java.security.Principal)

  getOwner

  java.security.Principal getOwner()

  Deprecated. need for this is under review

  Get the "Owner" (user or group) of this group. The Owner is intended to be the Principal which has full rights to modifying the group. Owner may default to the group itself.

  Returns:

  Owner Principal

  getAdministrator

  java.security.Principal getAdministrator()

  Deprecated. need for this is under review

  Get the "Administrator" (user or group) of this group. The Administrator is intended to be the Principal which has only the ability to add and remove members. Administrator may default to the Owner.

  Returns:

  Administrator Principal

  getPrincipalSet

  java.util.Set<java.security.Principal> getPrincipalSet()

  Get the set of Principals in this group. Use may be more efficient than using the members() method of java.security.acl.Group which returns an Enumeration.

  Returns:

  Set of Principals