oracle.ifs.server
Class S_DirectoryGroup

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryObject
        |
        +--oracle.ifs.server.S_TieLibraryObject
              |
              +--oracle.ifs.server.S_PublicObject
                    |
                    +--oracle.ifs.server.S_TiePublicObject
                          |
                          +--oracle.ifs.server.S_DirectoryObject
                                |
                                +--oracle.ifs.server.S_TieDirectoryObject
                                      |
                                      +--oracle.ifs.server.S_DirectoryGroup

All Implemented Interfaces:

DirectoryObjectInterface, IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:

S_TieDirectoryGroup

public class S_DirectoryGroup

extends S_TieDirectoryObject

A S_DirectoryGroup is the server-side representation of a group of users and/or other groups.

See Also:

S_LibraryService, S_LibrarySession

Method Summary

void	addMember(S_DirectoryObject member, S_LibraryObjectDefinition sdef) Adds a member to a group, using a definition to define the membership relationship.
void	addMembers(S_DirectoryObject[] members) Adds members to the group.
void	addMembers(S_DirectoryObject[] members, S_LibraryObjectDefinition reldef) Adds members to the group.
protected void	deriveDefinition(S_LibraryObjectDefinition def) Adds to the S_LibraryObjectDefinition for this class.
protected void	extendedPreFree(OperationState opState, S_LibraryObjectDefinition def) Performs operations before freeing an object.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition def) Updates any system attributes appropriate for creating this object; in this case, invoke a name uniqueness enforcement method if specified by a Policy.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition def) Update any system attributes appropriate for updating this ACL
S_DirectoryObject[]	getAllMembers() Gets all members of the group, direct or indirect.
S_DirectoryObject[]	getAllUserMembers() Gets all user members of the group, direct or indirect.
java.lang.Long[]	getDirectMemberIds() Gets the direct members of this group.
S_DirectoryObject[]	getDirectMembers() Gets the direct members of this DIRECTORYOBJECT.
static S_DirectoryGroup	getWorldDirectoryGroup(S_LibrarySession session) Gets the DirectoryGroup that represents World access.
boolean	isMember(S_DirectoryObject obj) Determines if the specified DirecotryObject is a member of the group.
void	removeMember(S_DirectoryObject member) Removes a member from the group.
void	removeMembers(S_DirectoryObject[] members, boolean bypass) Removes members from a group.

Methods inherited from class oracle.ifs.server.S_DirectoryObject

extendedPostInsert, getAllAncestors, getDirectAncestorIds, getDirectAncestors

Methods inherited from class oracle.ifs.server.S_PublicObject

addRelationship, checkAccess, extendedPostUpdate, getCategories, getCategories, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getReferencingFolders, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getVersionDescriptions, hasNameAttribute, isLocked, isVersionable, removeRelationship, verifyCanUseContentQuota

Methods inherited from class oracle.ifs.server.S_LibraryObject

equals, free, getAttribute, getAttributeByUpperCaseName, getClassId, getClassObject, getId, getSession, handleEvent, isTraced, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Method Detail

getWorldDirectoryGroup

public static S_DirectoryGroup getWorldDirectoryGroup(S_LibrarySession session)
                                               throws IfsException

Gets the DirectoryGroup that represents World access.

Parameters:

session - the session

Returns:

the World group

Throws:

IfsException - if operation fails.

deriveDefinition

protected void deriveDefinition(S_LibraryObjectDefinition def)
                         throws IfsException

Adds to the S_LibraryObjectDefinition for this class.

This this called by getDefinition() on S_LibraryObject.

This must call super.deriveDefinition() before applying any class-specific changes to S_LibraryObjectDefinition.

Overrides:

deriveDefinition in class S_PublicObject

Parameters:

def - the S_LibraryObjectDefinition that contains the definition of the target object.

Throws:

IfsException - if operation fails.

extendedPreInsert

protected void extendedPreInsert(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Updates any system attributes appropriate for creating this object; in this case, invoke a name uniqueness enforcement method if specified by a Policy.

Overrides:

extendedPreInsert in class S_PublicObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPreUpdate

protected void extendedPreUpdate(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Update any system attributes appropriate for updating this ACL

Overrides:

extendedPreUpdate in class S_PublicObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPreFree

protected void extendedPreFree(OperationState opState,
                               S_LibraryObjectDefinition def)
                        throws IfsException

Performs operations before freeing an object.

This is overridden by classes that need to perform operations after successfully deleting the rows for the freed instance.

Overrides:

extendedPreFree in class S_DirectoryObject

Throws:

IfsException - if operation fails.

addMember

public void addMember(S_DirectoryObject member,
                      S_LibraryObjectDefinition sdef)
               throws IfsException

Adds a member to a group, using a definition to define the membership relationship.

Parameters:

member - the DirectoryObject to be added to the DirectoryGroup

reldef - the def for the relationships

Throws:

IfsException - if any other aspect of the operation fails.

addMembers

public void addMembers(S_DirectoryObject[] members)
                throws IfsException

Adds members to the group.

Parameters:

members - the members to be added to the DirectoryGroup

Throws:

IfsException - if any other aspect of the operation fails.

addMembers

public void addMembers(S_DirectoryObject[] members,
                       S_LibraryObjectDefinition reldef)
                throws IfsException

Adds members to the group.

Parameters:

members - the members to be added to the DirectoryGroup

reldef - the def for the relationships

Throws:

IfsException - if the operation fails.

removeMember

public void removeMember(S_DirectoryObject member)
                  throws IfsException

Removes a member from the group.

Parameters:

member - the member to be removed from the group

Throws:

IfsException - if operation fails

removeMembers

public void removeMembers(S_DirectoryObject[] members,
                          boolean bypass)
                   throws IfsException

Removes members from a group.

Parameters:

members - members to be removed from the DirectoryGroup

bypass - true if security is to be bypassed

Throws:

IfsException - if the operation fails.

getAllMembers

public S_DirectoryObject[] getAllMembers()
                                  throws IfsException

Gets all members of the group, direct or indirect.

Overrides:

getAllMembers in class S_DirectoryObject

Returns:

array of S_DirectoryObject representing group members

Throws:

IfsException - if the operation fails

getAllUserMembers

public S_DirectoryObject[] getAllUserMembers()
                                      throws IfsException

Gets all user members of the group, direct or indirect.

Returns:

array of S_DirectoryObject representing user members

Throws:

IfsException - if the operation fails

isMember

public boolean isMember(S_DirectoryObject obj)
                 throws IfsException

Determines if the specified DirecotryObject is a member of the group.

Parameters:

obj - the DirectoryObject

Returns:

true if the specified DirectoryObject is a member of the group; false otherwise

Throws:

IfsException - if the operation fails

getDirectMembers

public S_DirectoryObject[] getDirectMembers()
                                     throws IfsException

Gets the direct members of this DIRECTORYOBJECT.

Overrides:

getDirectMembers in class S_DirectoryObject

Returns:

array of S_DirectoryObject

Throws:

IfsException - if the operation fails

getDirectMemberIds

public java.lang.Long[] getDirectMemberIds()
                                    throws IfsException

Gets the direct members of this group.

Returns:

array of IDs

Throws:

IfsException - if the operation fails