oracle.ifs.beans

Class DirectoryObject

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.DirectoryObject

All Implemented Interfaces:

Comparable, DirectoryObjectInterface, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieDirectoryObject

public class DirectoryObject
extends TiePublicObject
implements DirectoryObjectInterface

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).

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME Class name for this class.
static String	CREDENTIALMANAGER_ATTRIBUTE The name of the CredentialManager for this DirectoryObject.
static String	DISTINGUISHEDNAME_ATTRIBUTE The name by which the CredentialManager for this DirectoryObject refers to this user or group.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirectoryObject(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a DirectoryObject object.

Method Summary

Modifier and Type	Method and Description
protected static DirectoryObject	constructDirectoryObject(LibrarySession sess, S_LibraryObjectData data) Constructs a DirectoryObject from a S_LibraryObjectData.
protected static DirectoryObject[]	constructDirectoryObjectArray(LibrarySession sess, Long[] ids) Construct a DirectoryObject array from an array of object IDs.
protected static Vector	constructDirectoryObjectVector(LibrarySession sess, Vector vector) Constructs a DirectoryObject Vector from a Vector of S_DirectoryObjectData.
Long[]	getAllAncestorIds() Gets the IDs of all ancestors to this DirectoryObject.
DirectoryGroup[]	getAllAncestors() Gets all ancestors to this DirectoryObject.
DirectoryGroup	getAllAncestors(int index) Deprecated. iFS 9.0.3 Use getAllAncestors() to get entire array
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.
String	getCredentialManager() Gets the credential manager of this DirectoryObject.
DirectoryGroup[]	getDirectAncestors() Gets the direct ancestors to this DirectoryObject.
DirectoryGroup	getDirectAncestors(int index) Deprecated. iFS 9.0.3 Use getDirectAncestors() and index into the resultant array
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.
String	getDistinguishedName() Gets the distinguished name for this DirectoryObject.
boolean	isMemberOf(DirectoryObject parent) See if the target is the same as or is a member of the specified object.
void	resetAllAncestors() Deprecated. iFS 9.0.3 No longer has any effect
void	resetDirectAncestors() Deprecated. iFS 9.0.3 No longer has any effect
void	setCredentialManager(String credentialManager) Sets the credential manager of this DirectoryObject.
void	setDistinguishedName(String name) Sets the distinguished name of this DirectoryObject.
protected static DirectoryObject	vectorDirectoryObjectElement(Vector vector, int index) Returns a DirectoryObject element from the Vector of DirectoryObject at the specified index.
protected static DirectoryObject[]	vectorToDirectoryObjectArray(Vector vector) Converts a Vector of DirectoryObject to an array of DirectoryObject.

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postCreate, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preFree, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

Class name for this class.

Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

DISTINGUISHEDNAME_ATTRIBUTE

public static final String DISTINGUISHEDNAME_ATTRIBUTE

The name by which the CredentialManager for this DirectoryObject refers to this user or group.

See Also:

Constant Field Values

(Published)

CREDENTIALMANAGER_ATTRIBUTE

public static final String CREDENTIALMANAGER_ATTRIBUTE

The name of the CredentialManager for this DirectoryObject.

See Also:

Constant Field Values

(Published)

Constructor Detail

DirectoryObject

protected DirectoryObject(LibrarySession session,
                          Long id,
                          Long classId,
                          S_LibraryObjectData data)
                   throws IfsException

Constructs a DirectoryObject object.

Parameters:

session - the session

id - the id

classId - the class id

data - the DirectoryObject data

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getCredentialManager

public String getCredentialManager()
                            throws IfsException

Gets the credential manager of this DirectoryObject.

Returns:

the credential manager

Throws:

IfsException - if operation fails.

(Published)

getDistinguishedName

public String getDistinguishedName()
                            throws IfsException

Gets the distinguished name for this DirectoryObject.

Returns:

the distinguished name

Throws:

IfsException - if operation fails.

(Published)

getAllMembers

public DirectoryObject[] getAllMembers()
                                throws IfsException

Gets all members belonging to this DirectoryObject.

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.

Returns:

array of member DirectoryObjects

Throws:

IfsException - if operation fails.

(Published)

getAllMembers

public DirectoryObject getAllMembers(int index)
                              throws IfsException

Gets a specific memeber at the specified index in array of DirectoryObject.

For the DirectoryObject class, the only valid index is zero(0), which will return this object.

Parameters:

index - index into the array of DirectoryObjects

Returns:

the requested DirectoryGroup

Throws:

IfsException - if operation fails.

(Published)

getAllUserMembers

public DirectoryUser[] getAllUserMembers()
                                  throws IfsException

Gets all DirectoryUser members belonging to this DirectoryObject.

This list is the full set of member DirectoryUsers that are members (directly or indirectly) of this DirectoryGroup.

Returns:

array of member DirectoryUsers

Throws:

IfsException - if operation fails.

(Published)

getAllUserMembers

public DirectoryUser getAllUserMembers(int index)
                                throws IfsException

Gets a specific DirectoryUser Member at the specified index in array of DirectoryObject.

Parameters:

index - index into the array of DirectoryGroups

Returns:

the requested DirectoryObject

Throws:

IfsException - if operation fails.

(Published)

getDirectMembers

public DirectoryObject[] getDirectMembers()
                                   throws IfsException

Gets the direct members belonging to this DirectoryObject.

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.

Returns:

array of direct member DirectoryObjects

Throws:

IfsException - if operation fails.

(Published)

getDirectMembers

public DirectoryObject getDirectMembers(int index)
                                 throws IfsException

Gets the specific direct member at the specified index in array of DirectoryObject.

Parameters:

index - index into the array of DirectoryObjects

Returns:

the requested DirectoryObject

Throws:

IfsException - if operation fails.

(Published)

getDirectAncestors

public DirectoryGroup[] getDirectAncestors()
                                    throws IfsException

Gets the direct ancestors to this DirectoryObject.

Returns:

array of DirectoryGroup

Throws:

IfsException - if operation fails.

(Published)

getDirectAncestors

public DirectoryGroup getDirectAncestors(int index)
                                  throws IfsException

Deprecated. iFS 9.0.3 Use getDirectAncestors() and index into the resultant array

Gets the direct ancestors to this DirectoryObject at the specified index.

Parameters:

index - index into the array of DirectoryGroup

Returns:

the requested DirectoryGroup

Throws:

IfsException - if operation fails.

(Unpublished)

getAllAncestorIds

public Long[] getAllAncestorIds()
                         throws IfsException

Gets the IDs of all ancestors to this DirectoryObject.

Returns:

array of DirectoryGroup IDs representing ancestors

Throws:

IfsException - if operation fails.

(Published)

getAllAncestors

public DirectoryGroup[] getAllAncestors()
                                 throws IfsException

Gets all ancestors to this DirectoryObject.

Returns:

array of DirectoryGroup

Throws:

IfsException - if operation fails.

(Published)

getAllAncestors

public DirectoryGroup getAllAncestors(int index)
                               throws IfsException

Deprecated. iFS 9.0.3 Use getAllAncestors() to get entire array

Gets all ancestors to this DirectoryObject at the specified index.

Parameters:

index - index into the array of DirectoryGroup

Returns:

the requested DirectoryGroup

Throws:

IfsException - if operation fails.

(Unpublished)

isMemberOf

public boolean isMemberOf(DirectoryObject parent)
                   throws IfsException

See if the target is the same as or is a member of the specified object.

Parameters:

parent - the object to compare against

Returns:

true if the target object is equivalent to the specified object, or is a member of it.

Throws:

IfsException - if operation fails.

(Unpublished)

setDistinguishedName

public void setDistinguishedName(String name)
                          throws IfsException

Sets the distinguished name of this DirectoryObject.

Parameters:

name - the distinguished name

Throws:

IfsException - if the operation fails.

(Published)

setCredentialManager

public void setCredentialManager(String credentialManager)
                          throws IfsException

Sets the credential manager of this DirectoryObject.

Parameters:

credentialManager - the name of the credential manager

Throws:

IfsException - if the operation fails.

(Published)

constructDirectoryObjectVector

protected static Vector constructDirectoryObjectVector(LibrarySession sess,
                                                       Vector vector)
                                                throws IfsException

Constructs a DirectoryObject Vector from a Vector of S_DirectoryObjectData.

Parameters:

sess - current LibrarySession

vector - vector of DirectoryObject objects

Returns:

Vector of DirectoryObject

Throws:

IfsException - if the operation fails

(Unpublished)

constructDirectoryObjectArray

protected static DirectoryObject[] constructDirectoryObjectArray(LibrarySession sess,
                                                                 Long[] ids)
                                                          throws IfsException

Construct a DirectoryObject array from an array of object IDs. This will throw an exception if any of the IDs cannot be converted into a PublciObject.

Parameters:

sess - the requesting session

ids - the array of object IDs

Returns:

the array of DirectoryObjects

Throws:

IfsException - if operation fails.

(Unpublished)

constructDirectoryObject

protected static DirectoryObject constructDirectoryObject(LibrarySession sess,
                                                          S_LibraryObjectData data)
                                                   throws IfsException

Constructs a DirectoryObject from a S_LibraryObjectData.

Parameters:

sess - current LibrarySession

data - data component

Returns:

the constructed DirectoryObject

Throws:

IfsException - if the operation fails

(Unpublished)

vectorToDirectoryObjectArray

protected static DirectoryObject[] vectorToDirectoryObjectArray(Vector vector)
                                                         throws IfsException

Converts a Vector of DirectoryObject to an array of DirectoryObject.

Parameters:

vector - Vector of DirectoryObject

Returns:

array of DirectoryObject that corresponds to the given Vector

Throws:

IfsException - if the operation fails

(Unpublished)

vectorDirectoryObjectElement

protected static DirectoryObject vectorDirectoryObjectElement(Vector vector,
                                                              int index)
                                                       throws IndexOutOfBoundsException

Returns a DirectoryObject element from the Vector of DirectoryObject at the specified index.

Parameters:

vector - Vector of DirectoryObject

index - index into DirectoryObject

Returns:

the specified DirectoryObject

Throws:

IndexOutOfBoundsException - if invalid index specified.

(Unpublished)

resetDirectAncestors

public void resetDirectAncestors()
                          throws IfsException

Deprecated. iFS 9.0.3 No longer has any effect

Clears locally cached list of direct ancestors.

This must be called to force a new array of getDirectAncestors to be fetched from the server.

Throws:

IfsException - if operation fails.

(Unpublished)

resetAllAncestors

public void resetAllAncestors()
                       throws IfsException

Deprecated. iFS 9.0.3 No longer has any effect

Clears locally cached list of all ancestors.

Throws:

IfsException - if the operation fails

(Unpublished)