public class LockEntry extends TiePublicObject
Modifier and Type | Field and Description |
---|---|
static String |
ASSOCIATEDPUBLICOBJECT_ATTRIBUTE
The name of the Attribute used to reference
the PublicObject that this LockEntry is associated with.
|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
DAVOWNER_ATTRIBUTE
The name of the Attribute used to reference
the DAV owner field for this LockEntry.
|
static String |
DEPTH_ATTRIBUTE
The name of the Attribute used to reference
the depth value for locks on folders.
|
static String |
EXCEPTEDSESSION_ATTRIBUTE
The name of the Attribute used to reference
the session for which the restrictions described by this LockEntry
do not apply.
|
static String |
EXCEPTEDUSER_ATTRIBUTE
The name of the Attribute used to reference
the DirectoryUser for which the restrictions described by this LockEntry
do not apply.
|
static String |
INFO_ATTRIBUTE
The name of the Attribute used to reference
an information object that describes the LockEntry.
|
static int |
LOCKTYPE_UNKNOWN
Represents the "unknown" LockEntry type.
|
static String |
RESTRICTION_ATTRIBUTE
The name of the Attribute used to reference
the permissions restricted on the associated
PublicObject(s) because of this LockEntry.
|
static String |
TIMEOUT_ATTRIBUTE
The name of the Attribute used to reference
the timeout of a lock.
|
static String |
TOKEN_ATTRIBUTE
The name of the Attribute used to reference
the token for this LockEntry.
|
static String |
TYPE_ATTRIBUTE
The name of the Attribute used to reference
the type of lock this LockEntry describes.
|
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
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Modifier | Constructor and Description |
---|---|
protected |
LockEntry(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a LockEntry object.
|
Modifier and Type | Method and Description |
---|---|
PublicObject |
getAssociatedPublicObject()
Gets the PublicObject that this LockEntry is associated with.
|
static Long |
getClassId(LibrarySession session)
Get the ID of the ClassObject representing LOCKENTRY.
|
String |
getDavOwner()
Gets the DAV owner for this LockEntry.
|
int |
getDepth()
Gets the depth value for locks on folders.
|
long |
getExceptedSession()
Gets the session for which the restrictions described by this LockEntry
do not apply.
|
DirectoryUser |
getExceptedUser()
Gets the DirectoryUser for which the restrictions described by this LockEntry
do not apply.
|
PublicObject |
getInfo()
Gets an information object that describes the LockEntry.
|
long |
getResolvedRestriction(Long userId,
Long sessId)
Gets the resolved permissions restricted on the associated
PublicObject(s) because of this LockEntry, on behalf of a
specified user and session.
|
long |
getRestriction()
Gets the permissions restricted on the associated
PublicObject(s) because of this LockEntry.
|
Date |
getTimeout()
Gets the time at which the LockEntry will timeout.
|
String |
getToken()
Gets the token for this LockEntry.
|
int |
getType()
Gets the type of lock this LockEntry describes.
|
static int |
releaseExpiredLocks(LibrarySession session,
int batchSize)
Release expired LockEntries.
|
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
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String ASSOCIATEDPUBLICOBJECT_ATTRIBUTE
public static final String TYPE_ATTRIBUTE
public static final String RESTRICTION_ATTRIBUTE
public static final String TIMEOUT_ATTRIBUTE
public static final String EXCEPTEDUSER_ATTRIBUTE
public static final String EXCEPTEDSESSION_ATTRIBUTE
public static final String INFO_ATTRIBUTE
public static final String DAVOWNER_ATTRIBUTE
public static final String TOKEN_ATTRIBUTE
public static final String DEPTH_ATTRIBUTE
public static final int LOCKTYPE_UNKNOWN
protected LockEntry(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic static Long getClassId(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation failspublic PublicObject getAssociatedPublicObject() throws IfsException
IfsException
- if operation failspublic int getType() throws IfsException
IfsException
- if operation failspublic long getRestriction() throws IfsException
IfsException
- if operation failspublic Date getTimeout() throws IfsException
A null value indicates that the lock does not timeout.
IfsException
- if operation failspublic DirectoryUser getExceptedUser() throws IfsException
IfsException
- if operation failspublic long getExceptedSession() throws IfsException
A value of zero is returned if there is no excepted session.
IfsException
- if operation failspublic PublicObject getInfo() throws IfsException
IfsException
- if operation failspublic String getDavOwner() throws IfsException
IfsException
- if operation failspublic String getToken() throws IfsException
IfsException
- if operation failspublic int getDepth() throws IfsException
This information is only used for certain types of locks, such as DAV locks on folders.
IfsException
- if operation failspublic long getResolvedRestriction(Long userId, Long sessId) throws IfsException
userId
- the user the check is forsessId
- the session the check is forIfsException
- if operation failspublic static int releaseExpiredLocks(LibrarySession session, int batchSize) throws IfsException
session
- session contextbatchSize
- batch size to select the items; a
value of 0 implies a default batchsizeIfsException
- if operation fails.Copyright © 2023. All rights reserved.