|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObject | +--oracle.ifs.beans.TieLibraryObject | +--oracle.ifs.beans.PublicObject | +--oracle.ifs.beans.TiePublicObject | +--oracle.ifs.beans.DirectoryObject | +--oracle.ifs.beans.TieDirectoryObject | +--oracle.ifs.beans.DirectoryGroup
A DirectoryGroup represents an iFS group of users and/or other groups.
This class enables defining membership relationships by providing methods to add or or remove instances of the GroupMembershiprelationship class.
Also provided are methods to fetch the direct members of this group (that is, DirectoryObejcts that have a GroupMembershiprelationship associated with this object), and "all members" (also known as "fully resolved members") of the group, which is the union of the direct members and the fully resolved members of each of the direct members.
There is one special instance of DirectoryGroup, known as the "World" group. This group has an implied set of direct members that includes all DirectoryUsers defined in the server.
Field Summary | |
static java.lang.String |
ALLMEMBERS_ATTRIBUTE
A system-set attribute containing the DirectoryObjects that are members of this DirectoryGroup, either directly or indirectly. |
static java.lang.String |
CLASS_NAME
Class name for this class. |
Method Summary | |
void |
addMember(DirectoryObject member)
Adds a direct member to the group. |
void |
addMembers(DirectoryObject[] members)
Adds a set of direct members to the group. |
DirectoryObject[] |
getAllMembers()
Returns array of DirectoryObject that define the list of all members for this instance. |
DirectoryObject |
getAllMembers(int index)
Gets the member at the specified index of this group. |
DirectoryUser[] |
getAllUserMembers()
Gets the array of DirectoryUser that define the list of all DirectoryUser members for this instance. |
DirectoryUser |
getAllUserMembers(int index)
Gets the member DirectoryUser at the specified index of this group. |
DirectoryObject[] |
getDirectMembers()
Gets the direct members of this instance. |
DirectoryObject |
getDirectMembers(int index)
Gets the direct member at the specified index of this group. |
void |
handleEvent(IfsEvent event)
Handles the specified event and clears the cache of direct members. |
boolean |
isMember(DirectoryObject obj)
Determines if the specified DirecotryObject is a member of the group. |
boolean |
isWorldGroup()
Tests whether this group is the World group (the virtual group that contains all users). |
void |
removeMember(DirectoryObject member)
Removes a direct member from the group. |
void |
removeMembers(DirectoryObject[] members)
Removes a set of direct members from the group. |
Methods inherited from class oracle.ifs.beans.DirectoryObject |
getAllAncestors, getAllAncestors, getDirectAncestors, getDirectAncestors, resetAllAncestors, resetDirectAncestors |
Methods inherited from class oracle.ifs.beans.LibraryObject |
equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update |
Methods inherited from interface oracle.ifs.common.LibraryObjectInterface |
getId |
Methods inherited from interface oracle.ifs.common.Traceable |
getTraceLogger, isTraced, trace |
Field Detail |
public static final java.lang.String CLASS_NAME
Useful for methods that take a class name argument.
public static final java.lang.String ALLMEMBERS_ATTRIBUTE
Method Detail |
public boolean isWorldGroup() throws IfsException
IfsException
- if operation fails.public void addMember(DirectoryObject member) throws IfsException
The member must not be the World group, nor can it already be a member of this group.
Also, it is not legal to add a DirectoryGroup to this * instance. Doing so would result in cyclic membership definition. For example, if DirectoryGroup A had a direct member of DirectoryGroup B, and DirectoryGroup B had a direct member of DirectoryGroup C, then it would be illegal to add DirectoryGroup A as a direct member of DirectoryGroup C.
member
- the member to add to this DirectoryGroupIfsException
- if the operation fails.public void addMembers(DirectoryObject[] members) throws IfsException
The membership restrictions are the same as outlined in the addMember method. If any member specified does not qualify as a valid member, the entire operation is not performed.
members
- the members to add as direct members to this instanceIfsException
- if the operation fails.public void removeMember(DirectoryObject member) throws IfsException
The member must not be the World group, and must already be a member of this group.
member
- the member to remove from this DirectoryGroupIfsException
- if the operation fails.public void removeMembers(DirectoryObject[] members) throws IfsException
The member specified must comply with the restrictions outlined in the removeMember method. If any member specified is not valid, the entire operation is not performed.
members
- the members to add as direct members to this instanceIfsException
- if the operation fails.public DirectoryObject[] getAllMembers() throws IfsException
This list is the full set of DirectoryObject that are members (directly or indirectly) of this DirectoryGroup.
getAllMembers
in class DirectoryObject
IfsException
- if operation fails.public DirectoryObject getAllMembers(int index) throws IfsException
getAllMembers
in class DirectoryObject
index
- index into the array of DirectoryObjectsIfsException
- if operation fails.public DirectoryUser[] getAllUserMembers() throws IfsException
This list is the full set of DirectoryUser that are members (directly or indirectly) of this DirectoryGroup.
getAllUserMembers
in class DirectoryObject
IfsException
- if operation fails.public DirectoryUser getAllUserMembers(int index) throws IfsException
getAllUserMembers
in class DirectoryObject
index
- index into the array of AllUserMembersIfsException
- if operation fails.public DirectoryObject[] getDirectMembers() throws IfsException
getDirectMembers
in class DirectoryObject
IfsException
- if operation fails.public DirectoryObject getDirectMembers(int index) throws IfsException
getDirectMembers
in class DirectoryObject
index
- index into the array of DirectoryObjectsIfsException
- if operation fails.public boolean isMember(DirectoryObject obj) throws IfsException
id
- a DirectoryObjectIfsException
- if the operation failspublic void handleEvent(IfsEvent event) throws IfsException
handleEvent
in class DirectoryObject
event
- the eventIfsException
- if the operation fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |