|
|||||||||
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
A DirectoryObject represents an iFS user or group of users.
This class is essentially abstract. The two major subclasses of this class are DirectoryUser and DirectoryGroup. Many operations require some user or group entity, and therefore use DirectoryObject to represent this. For example, security grant and revoke operations can use either a user or group as the grantee, and therefore take a DirectoryObject argument.
DirectoryObject is a subclass of PublicObject; hence, DirectoryObject can have associated AccessControlLists to manage security on the DirectoryObjects. Typically, DirectoryUser objects are accessible to all users (that is, their ACL has Discover granted to the "World" group).
Field Summary | |
static java.lang.String |
CLASS_NAME
Class name for this class. |
Method Summary | |
DirectoryGroup[] |
getAllAncestors()
Gets all ancestors to this DirectoryObject. |
DirectoryGroup |
getAllAncestors(int index)
Gets all ancestors to this DirectoryObject at the specified index. |
DirectoryObject[] |
getAllMembers()
Gets all members belonging to this DirectoryObject. |
DirectoryObject |
getAllMembers(int index)
Gets a specific memeber at the specified index in array of DirectoryObject. |
DirectoryUser[] |
getAllUserMembers()
Gets all DirectoryUser members belonging to this DirectoryObject. |
DirectoryUser |
getAllUserMembers(int index)
Gets a specific DirectoryUser Member at the specified index in array of DirectoryObject. |
DirectoryGroup[] |
getDirectAncestors()
Gets the direct ancestors to this DirectoryObject. |
DirectoryGroup |
getDirectAncestors(int index)
Gets the direct ancestors to this DirectoryObject at the specified index. |
DirectoryObject[] |
getDirectMembers()
Gets the direct members belonging to this DirectoryObject. |
DirectoryObject |
getDirectMembers(int index)
Gets the specific direct member at the specified index in array of DirectoryObject. |
void |
handleEvent(IfsEvent event)
Handles the specified event. |
void |
resetAllAncestors()
Clears locally cached list of all ancestors. |
void |
resetDirectAncestors()
Clears locally cached list of direct ancestors. |
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.
Method Detail |
public DirectoryObject[] getAllMembers() throws IfsException
For DirectoryGroup, this method is overridden to produce the full set of member DirectoryObjects that are members (directly or indirectly) of that DirectoryGroup.
For DirectoryUser, the array only contains the target object.
IfsException
- if operation fails.public DirectoryObject getAllMembers(int index) throws IfsException
For the DirectoryObject class, the only valid index is zero(0), which will return this object.
index
- index into the array of DirectoryObjectsIfsException
- if operation fails.public DirectoryUser[] getAllUserMembers() throws IfsException
This list is the full set of member DirectoryUsers that are members (directly or indirectly) of this DirectoryGroup.
IfsException
- if operation fails.public DirectoryUser getAllUserMembers(int index) throws IfsException
index
- index into the array of DirectoryGroupsIfsException
- if operation fails.public DirectoryObject[] getDirectMembers() throws IfsException
For DirectoryGroup objects, this method is overridden to return the set of direct members of that DirectoryGroup.
For DirectoryUser obejects, a null array is returned.
IfsException
- if operation fails.public DirectoryObject getDirectMembers(int index) throws IfsException
index
- index into the array of DirectoryObjectsIfsException
- if operation fails.public DirectoryGroup[] getDirectAncestors() throws IfsException
IfsException
- if operation fails.public DirectoryGroup getDirectAncestors(int index) throws IfsException
index
- index into the array of DirectoryGroupIfsException
- if operation fails.public void resetDirectAncestors() throws IfsException
This must be called to force a new array of getDirectAncestors to be fetched from the server.
IfsException
- if operation fails.public DirectoryGroup[] getAllAncestors() throws IfsException
IfsException
- if operation fails.public DirectoryGroup getAllAncestors(int index) throws IfsException
index
- index into the array of DirectoryGroupIfsException
- if operation fails.public void resetAllAncestors() throws IfsException
This must be called to force a new array of getAllAncestors to be fetched from the server.
IfsException
- if the operation failspublic void handleEvent(IfsEvent event) throws IfsException
This override resets the directAncestor and allAncestor cache held by this instance.
handleEvent
in class PublicObject
event
- the specific event to be handledIfsException
- if the operation fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |