oracle.ifs.beans

Class ContentQuota

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.ContentQuota

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieContentQuota

public class ContentQuota
extends TieApplicationObject

A ContentQuota contains information that defines how much storage space in iFS is allocated and consumed by the DirectoryUser. For quota enforcement, the ContentQuota object must be enabled.

Version:

2.0

Author:

Dave Long

See Also:

ContentQuotaDefinition

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOCATEDSTORAGE_ATTRIBUTE The amount of storage space allocated by this ContentQuota to the DirectoryUser.
static String	ASSOCIATEDPUBLICOBJECT_ATTRIBUTE The DirectoryUser that has allocated/consumed the storage space represented by this ContentQuota.
static String	CLASS_NAME This class name for this class.
static String	CONSUMEDSTORAGE_ATTRIBUTE The amount of storage space currently consumed by the DirectoryUser.
static String	ENABLED_ATTRIBUTE An indicator of whether the ContentQuota is enabled or disabled.
static String	UNIQUENAME_ATTRIBUTE A system-set attribute used to ensure each ContentQuota has a unique name.

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	ContentQuota(LibrarySession session, Long id, Long classid, S_LibraryObjectData data) Construct a ContentQuota object - standard variant.

Method Summary

Modifier and Type	Method and Description
void	calculateConsumedStorage() Calculates the current consumed storage for the DirectoryUser and updates this ContentQuota object.
protected static ContentQuota	constructContentQuota(LibrarySession sess, S_LibraryObjectData data) Constructs a ContentQuota for the specified data.
protected static Vector	constructContentQuotaVector(LibrarySession sess, Vector vector) Constructs a vector of ContentQuota from vector of S_LOData.
long	getAllocatedStorage() Gets the amount of allocated storage.
PublicObject	getAssociatedPublicObject() Gets the PublicObject associated with this ContentQuota object.
long	getConsumedStorage() Gets the amount of consumed storage.
boolean	isEnabled() Determines whether quota enforcement is enabled.
void	postConsumptionChangeEvent(long payload) Post a consumption change event on the ContentQuota.
void	setAllocatedStorage(long value) Sets the amount of allocated storage.
void	setEnabled(boolean enable) ContentQuota can be enabled or disabled.
protected static ContentQuota	vectorContentQuotaElement(Vector vector, int index) Extracts an element of a Vector of ContentQuota.
protected static ContentQuota[]	vectorToContentQuotaArray(Vector vector) Converts a Vector of ContentQuota to an array of ContentQuota.

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, postCreate, preFree, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, 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, 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, postSecurityChangedEvent, postUpdate, preCopy, preCreate, 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, 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, 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

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

ASSOCIATEDPUBLICOBJECT_ATTRIBUTE

public static final String ASSOCIATEDPUBLICOBJECT_ATTRIBUTE

The DirectoryUser that has allocated/consumed the storage space represented by this ContentQuota.

See Also:

Constant Field Values

(Published)

ALLOCATEDSTORAGE_ATTRIBUTE

public static final String ALLOCATEDSTORAGE_ATTRIBUTE

The amount of storage space allocated by this ContentQuota to the DirectoryUser.

See Also:

Constant Field Values

(Published)

CONSUMEDSTORAGE_ATTRIBUTE

public static final String CONSUMEDSTORAGE_ATTRIBUTE

The amount of storage space currently consumed by the DirectoryUser.

See Also:

Constant Field Values

(Published)

ENABLED_ATTRIBUTE

public static final String ENABLED_ATTRIBUTE

An indicator of whether the ContentQuota is enabled or disabled.

See Also:

Constant Field Values

(Published)

UNIQUENAME_ATTRIBUTE

public static final String UNIQUENAME_ATTRIBUTE

A system-set attribute used to ensure each ContentQuota has a unique name.

See Also:

Constant Field Values

(Published)

Constructor Detail

ContentQuota

protected ContentQuota(LibrarySession session,
                       Long id,
                       Long classid,
                       S_LibraryObjectData data)
                throws IfsException

Construct a ContentQuota object - standard variant.

Parameters:

session - the session

id - the id

classid - the class id

data - the object data

Throws:

IfsException

(Unpublished)

Method Detail

getAssociatedPublicObject

public PublicObject getAssociatedPublicObject()
                                       throws IfsException

Gets the PublicObject associated with this ContentQuota object.

Returns:

the PublicObject

Throws:

IfsException - if operation fails

(Published)

getAllocatedStorage

public long getAllocatedStorage()
                         throws IfsException

Gets the amount of allocated storage. Returns 0 if no storage value is set.

Returns:

allocated storage (in bytes)

Throws:

IfsException - if operation fails.

(Published)

setAllocatedStorage

public void setAllocatedStorage(long value)
                         throws IfsException

Sets the amount of allocated storage.

Parameters:

value -

Throws:

IfsException - if operation fails.

(Published)

getConsumedStorage

public long getConsumedStorage()
                        throws IfsException

Gets the amount of consumed storage. Returns 0 if no storage value is set.

Overrides:

getConsumedStorage in class PublicObject

Returns:

Consumed storage (in bytes)

Throws:

IfsException - if operation fails.

(Published)

calculateConsumedStorage

public void calculateConsumedStorage()
                              throws IfsException

Calculates the current consumed storage for the DirectoryUser and updates this ContentQuota object.

Throws:

IfsException - if operation fails.

(Published)

isEnabled

public boolean isEnabled()
                  throws IfsException

Determines whether quota enforcement is enabled.

Returns:

true if quota enabled

Throws:

IfsException - if the operation fails

(Published)

setEnabled

public void setEnabled(boolean enable)
                throws IfsException

ContentQuota can be enabled or disabled.

Parameters:

enable - true if quota should be effective

Throws:

IfsException - if the operation fails

(Published)

postConsumptionChangeEvent

public void postConsumptionChangeEvent(long payload)
                                throws IfsException

Post a consumption change event on the ContentQuota.

Parameters:

payload - the increase in quota consumed, or zero if no increase

Throws:

IfsException - if the operation fails

(Unpublished)

constructContentQuotaVector

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

Constructs a vector of ContentQuota from vector of S_LOData.

Parameters:

sess - session

vector - Vector of S_LOData

Returns:

the Vector of ContentQuota

Throws:

IfsException - if operation fails.

(Unpublished)

constructContentQuota

protected static ContentQuota constructContentQuota(LibrarySession sess,
                                                    S_LibraryObjectData data)
                                             throws IfsException

Constructs a ContentQuota for the specified data.

Parameters:

sess - the session

data - the ContentQuota data

Returns:

the ContentQuota

Throws:

IfsException - if an error occurs

(Unpublished)

vectorToContentQuotaArray

protected static ContentQuota[] vectorToContentQuotaArray(Vector vector)

Converts a Vector of ContentQuota to an array of ContentQuota.

Parameters:

vector - Vector of ContentQuota objects

Returns:

array of ContentQuota objects that corresponds to Vector

(Unpublished)

vectorContentQuotaElement

protected static ContentQuota vectorContentQuotaElement(Vector vector,
                                                        int index)

Extracts an element of a Vector of ContentQuota.

Parameters:

vector - Vector of ContentQuota objects.

index - Index into the Vector of ContentQuota objects.

Returns:

instance of the corresponding ContentQuota

Throws:

IndexOutOfBoundsException - if invalid index specified.

(Unpublished)