public class FolderIndexOperations extends ScriptOperations
ScriptOperations.ClassObjectOptions, ScriptOperations.JdbcExecutor, ScriptOperations.SavedSearchResult, ScriptOperations.ServerDefinition, ScriptOperations.ServiceDefinition
INDENT
Constructor and Description |
---|
FolderIndexOperations(ScriptDriver driver)
Constructs an FolderIndexOperations.
|
Modifier and Type | Method and Description |
---|---|
protected long |
applyDeferredUpdates(LibrarySession session,
String prefix)
Apply deferred updates.
|
protected void |
changeUpdateMode(LibrarySession session,
boolean isSync,
String prefix)
Change update mode to either synchronous or asynchronous.
|
protected void |
completeIndexCreation(LibrarySession session,
boolean deferCreate,
String prefix)
Completes the creation of the folder index.
|
void |
createFolderIndex(AttributeValueTable avt)
Create a Folder index.
|
protected void |
createFolderIndexTables(LibrarySession session,
int maxLevel,
String prefix)
Create the tables that comprise the folder index.
|
protected void |
createInitialFolderIndexRows(LibrarySession session,
String prefix)
Create the initial self-reference rows for the folder index.
|
void |
dropFolderIndex(AttributeValueTable avt)
Drop the current Folder index.
|
protected void |
dropIndex(LibrarySession session,
String prefix)
Drop the folder index.
|
protected int |
getMaxLevel(LibrarySession session)
Get the maximum folder index level.
|
void |
identifyFolderIndexPropertyBundle(String pbTag)
Identify the "Folder Index PropertyBundle".
|
protected boolean |
isIndexEnabled(LibrarySession session)
Return true if there is a folder index enabled currently.
|
protected boolean |
isUpdateModeSynchronous(LibrarySession session)
Return true if the update mode of the folder index is synchronous.
|
protected void |
promoteFolder(LibrarySession session,
Folder folder,
int newLevel,
String prefix)
Promote a folder to a higher index level.
|
protected void |
promoteFoldersByPath(LibrarySession session,
String[] paths,
int newLevel,
String prefix)
Promote folders to a higher index level.
|
protected void |
rebuildIndex(LibrarySession session,
String prefix)
Rebuild the folder index.
|
protected void |
resetFolderIndexRows(LibrarySession session,
String prefix)
Delete all rows form the folder index except for the "self" rows
used to register each existing folder.
|
protected void |
setUseExistsClause(LibrarySession session,
boolean useExists,
String prefix)
Update the 'UseExistsClause' property on the FolderIndex
propertyBundle event target.
|
void |
updateFolderIndex(AttributeValueTable avt)
Update the Folder index.
|
abortTransaction, acquireLock, acquireManualLock, activateAuditHandlerSpecification, activateAuditSpecification, activateOperationActionSpecification, activateServerSpecification, activateSystemObject, addAttachment, addAttribute, addAuditEventProperty, addAuditType, addAuditTypesForClass, addBooleanHandlerProperty, addCategory, addDefinitionAuditEntryType, addDefinitionAuditEntryTypesForClass, addDefinitionAuditEntryTypesUnderClass, addDefinitionBooleanProperty, addDefinitionDoubleProperty, addDefinitionIntegerProperty, addDefinitionLongProperty, addDefinitionProperties, addDefinitionProperty, addDefinitionStringArrayProperty, addDefinitionStringProperty, addDocumentDefinitionCharacterSet, addDocumentDefinitionContent, addDocumentDefinitionContentBfileReference, addDocumentDefinitionLanguage, addGlobalOperationActionSpecification, addGroupMember, addGroupMembers, addIntegerHandlerProperty, addLifecyclePolicyEntryDefinition, addLifecyclePolicyEntryDefinition, addLongHandlerProperty, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServiceDeclaration, addManagedServiceDeclaration, addPreparedSelectorBindValue, addPreparedSelectorBooleanBindValue, addPreparedSelectorIntegerBindValue, addPreparedSelectorLibraryObjectBindValue, addPreparedSelectorLongBindValue, addPreparedSelectorStringBindValue, addPublicObjectDefinitionCategory, addSchemaObjectDefinitionCategory, addStringArrayHandlerProperty, addStringHandlerProperty, addSystemObjectDefinitionBooleanProperty, addSystemObjectDefinitionCategory, addSystemObjectDefinitionIntegerProperty, addSystemObjectDefinitionLongProperty, addSystemObjectDefinitionStringArrayProperty, addSystemObjectDefinitionStringProperty, addToDocumentDefinition, addToPublicObjectDefinition, applyLogLevelOverride, applyNamedFreezeLock, applySingletonLock, assignClassDomain, assignLifecyclePolicyByCategory, assignValueDefault, assignValueDomain, beginTransaction, businessObjectExists, clearImpersonateUser, clearSharedCaches, cloneCurrentSession, cloneDefinition, cloneDefinition, comment, comment, compareObjects, completeTransaction, concatenateObjectId, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToUpperStrings, concatenateToUpperStrings, concatenateToUpperStrings, connect, connect, constructAuditEvent, constructPreparedSelectorGenerator, constructPreparedSelectorGenerator, convertPropertyDefinitionsToHashtable, convertStringArray, convertToBoolean, convertToBoolean, convertToDouble, convertToDouble, convertToInteger, convertToInteger, convertToLong, convertToLong, convertToRelativePath, copy, create, createAccessControlList, createAndApplyAuditTypeList, createApplicationToken, createApplicationToken, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditTypeList, createAuditTypeList, createAutoFolderingActionSpecification, createAutoFolderingActionSpecification, createCategorizedDocument, createClassDomain, createClassObject, createClassObject, createCustomLockEntry, createCustomMediaDriverSpecification, createCustomMediaDriverSpecification, createDefinition, createDefinitionFromDefinitionObject, createDefinitionFromObject, createDefinitionObject, createDependentView, createDocument, createDocument, createDocument, createDocumentBatch, createDocuments, createEntireAuditSpecification, createExtendedPermission, createExtendedUserProfile, createFolder, createFolder, createFolder, createFolderLink, createFolderTree, createFormat, createGroup, createGuestSession, createLibraryObject, createLibraryObject, createLifecycleDateRuleSpecification, createLifecycleDateRuleSpecification, createLifecyclePolicy, createLifecyclePolicy, createLifecyclePolicyActionSpecification, createLifecyclePolicyActionSpecification, createLifecyclePolicyEntryDefinition, createLink, createLink, createLink, createLockTypeLookupTables, createMedia, createMedia, createNamedFreezeLock, createNamedPropertyBundle, createNodeConfiguration, createNodeConfiguration, createOperationActionSpecification, createOperationActionSpecification, createOrUpdateClassObject, createPermissionBundle, createPolicy, createPolicyList, createPropertyBundle, createQueue, createRetentionPolicy, createServerConfiguration, createServerConfiguration, createServerSpecification, createServiceConfiguration, createServiceConfiguration, createSession, createSession, createSimplePropertyTable, createSimplePropertyTableList, createStorageGroup, createStorageGroup, createSystemLockObject, createUser, createUserSession, createValueDefault, createValueDomain, deactivateAuditHandlerSpecification, deactivateAuditSpecification, deactivateOperationActionSpecification, deactivateServerSpecification, deactivateSystemObject, deactivateUnknownOperationActionSpecifications, defineAttribute, defineAuditHandlerSpecificationDefinition, defineAuditHandlerSpecificationDefinition, defineAuditTargetSpecificationDefinition, defineAuditTypeListDefinition, defineAuditTypeListDefinition, defineClassObject, defineExistingClassObject, definitionExists, deleteAllCategories, deleteAuditSpecification, deleteNamedFreezeLock, deleteRepositoryParameter, deleteUser, deregisterBusinessObject, deregisterCustomLockType, deregisterDefinition, deregisterLockType, deregisterObject, deregisterSession, deregisterTransaction, determinePrimaryObjectColumnAlias, ensureFreed, executeAutocommitSql, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectFromJson, executePreparedSelectResults, exists, existsRelative, extractContentForIndexing, findOrCreateCompositeGroup, freeClassDomain, freeClassObject, freeExtendedPermission, freeFolder, freeFormat, freeNamedPropertyBundle, freeNamedPropertyBundle, freeNodeConfiguration, freeNodeConfiguration, freeObject, freePermissionBundle, freePolicy, freeServerConfiguration, freeServerConfiguration, freeServiceConfiguration, freeServiceConfiguration, freeUnreferencedContent, freeValueDefault, freeValueDomain, generateClassObjectDefinitionTag, getAbsolutePath, getAclValueForConfigurationObjects, getAttributeValue, getAttributeValue, getAttributeValue, getAuditDriverHelper, getAuditEventDispatcher, getAuditingStartingId, getAuxiliaryTargets, getBindValues, getBypassSecurityAliases, getClassObjectCreationMode, getConsoleInputBoolean, getConsoleInputString, getConsoleInputString, getConsoleInputString, getConsoleSecureInputString, getContentPath, getCurrentSession, getDriver, getIncludedFileSettings, getLogWriter, getManagedServerDeclarations, getManagedServiceDeclarations, getParameterTable, getSavedSearchResultPrimaryObjects, getSavedSearchResults, getShowDates, getStringArray, getStringsFromArrayToken, getStripNumbersFromAuditEventProperties, handleEventPostedForCustomAuditHistory, handleTimerExpiredForCustomAuditHistory, identifyAcl, identifyAcl, identifyApplicationToken, identifyAttribute, identifyAttributePropertyBundle, identifyAuditHandlerSpecification, identifyAuditSpecification, identifyAuditTargetSpecification, identifyAuditTypeList, identifyAuditTypeListBySpecification, identifyAutoFolderingActionSpecification, identifyByAttribute, identifyByPath, identifyByRelativePath, identifyCategory, identifyCategory, identifyClassAcl, identifyClassDomain, identifyClassObject, identifyClassPolicyBundle, identifyClassPropertyBundle, identifyCompositeGroup, identifyCustomLock, identifyCustomMediaDriverSpecification, identifyDependentView, identifyExtendedPermission, identifyFormat, identifyGlobalAuditSpecification, identifyGlobalAuditTypeList, identifyGroup, identifyGuestUser, identifyInstancePropertyBundle, identifyLibraryObject, identifyLifecycleDateRuleSpecification, identifyLifecyclePolicy, identifyLifecyclePolicyActionSpecification, identifyLifecyclePolicyEntry, identifyMedia, identifyMessageEntry, identifyMessageList, identifyNamedFreezeLock, identifyNamedPropertyBundle, identifyNodeConfiguration, identifyObjectAuditSpecification, identifyObjectProperty, identifyOperationActionSpecification, identifyPermissionBundle, identifyPolicy, identifyPolicyList, identifyPrimaryUserProfile, identifyPropertyBundle, identifyQueue, identifyQueueTypeMapBundle, identifyRetentionPolicy, identifyServerConfiguration, identifyServerSpecification, identifyServiceConfiguration, identifySingletonLockType, identifyStorageGroup, identifySystemAcl, identifySystemLockObject, identifySystemUser, identifyUser, identifyValueDefault, identifyValueDomain, identifyWorldGroup, impersonateUser, impersonateUser, initializeManualTextIndexingRetainedEvents, isBootstrapModeEnabled, isDomainScopeImpliedForSearch, isInArray, log, log, lookupAcl, lookupApplicationToken, lookupAuditDomainContext, lookupAuditSpecification, lookupAutoFolderingActionSpecification, lookupBusinessObject, lookupBusinessObjectHashtable, lookupBusinessObjectList, lookupClassAcl, lookupDatatype, lookupDatatypeString, lookupDefinition, lookupDefinition, lookupDirectoryObject, lookupDocument, lookupFolder, lookupFormat, lookupFormatFromCollection, lookupGroup, lookupMedia, lookupMessageEntry, lookupObject, lookupObject, lookupObjectAttributeValue, lookupObjectId, lookupOperationActionSpecification, lookupPublicObject, lookupQueue, lookupSessionByTag, lookupSystemAcl, lookupSystemLockObject, lookupTagBySessionId, lookupUser, lookupUserFromCollection, makeDefinitionReadOnly, markCurrentAuditingId, modifyClassObject, move, moveCategory, normalizeBooleanString, notifyCustomAuditHistoryHandler, objectExists, postCustomAuditEvent, postCustomAuditEvent, postCustomAuditEvent, postSystemAuditEvent, postSystemAuditEvent, preprocessDocumentSettings, preprocessPublicObjectSettings, printStackTrace, processManualTextIndexingRetainedEvents, processRawAuditEvents, purgeGlobalAuditHistory, reactivateUnknownOperationActionSpecifications, readDocumentContent, refreshDependentView, registerAllNonCustomAuditTypes, registerAuditEventType, registerAuditEventType, registerBusinessObject, registerCustomAuditType, registerCustomLockType, registerDefinition, registerLockType, registerNewSession, registerObject, registerTransaction, releaseLock, releaseManualLock, removeAcesForFreedGrantees, removeAllAttachments, removeAttachment, removeAttribute, removeClassProperty, removeCustomLockEntry, removeGroupMembers, removeNamedFreezeLock, removeProperties, removeServerFromNodeConfiguration, removeServiceFromNodeConfiguration, removeSession, removeSessionState, removeSingletonLock, removeTag, rename, replaceMediaLookupsByFormat, replaceSession, resetFolderCountInfo, restoreGlobalOperationActionSpecification, runSchemaCreator, runScript, saveGlobalOperationActionSpecification, saveSearchResultPrimaryObjects, saveSearchResults, searchAuditHistory, searchAuditHistory, searchAuditHistory, sessionExists, setAdminMode, setAdminMode, setArrayTokenDelimiter, setAuditingStartingId, setAuditSpecificationAuditHandlerSpecificationDefinition, setAuditSpecificationAuditTargetSpecificationDefinition, setAuditSpecificationAuditTypeListDefinition, setAuditTargetSpecificationDefinitionTarget, setBooleanInstanceProperty, setClassObjectCreationMode, setClassPolicyList, setClassProperty, setCreateCategoriesServerSideOption, setCurrentSession, setCurrentSession, setDateFormat, setDefaultAuditEventSortClause, setDefaultMedia, setDefaultScriptOperationsClass, setDefaultStorageGroup, setDefinitionAttribute, setDefinitionAttribute, setDefinitionBooleanAttribute, setDefinitionClassObjectAttribute, setDefinitionDateAttribute, setDefinitionDirectoryObjectArrayAttribute, setDefinitionDirectoryObjectAttribute, setDefinitionDoubleAttribute, setDefinitionIntegerAttribute, setDefinitionLongAttribute, setDefinitionNullStringAttribute, setDefinitionObjectAttribute, setDefinitionSchemaObjectArrayAttribute, setDefinitionSchemaObjectAttribute, setDefinitionStringArrayAttribute, setDefinitionStringAttribute, setDefinitionSystemObjectAttribute, setDocumentDefinitionContentObjectDefinition, setGlobalAuditTypeList, setGlobalOperationActionSpecifications, setInstallationMode, setInstallationMode, setInstanceProperty, setIntegerInstanceProperty, setLifecyclePolicyDefinitionDeleteEntriesOption, setLocale, setLongInstanceProperty, setLongSessionState, setMainSessionAsCurrentSession, setMediaLookupByFormat, setNumberFormat, setObjectProperty, setPreventSessionTimeouts, setPreventSessionTimeouts, setProperty, setPublicObjectInstanceProperty, setRepositoryParameter, setStringInstanceProperty, setStringSessionState, setSubstitutionPrefix, setSystemAdminMode, setSystemAdminMode, setSystemObjectInstanceProperty, setTimeoutPeriodOption, setTimeZone, setUserCreateOptions, setUserDefaultAcl, setUserDeleteOptions, showAcl, showAggregateAuditEventColumns, showAllAutoFolderingActionSpecifications, showAllClassAcls, showAllClassDomains, showAllClassObjects, showAllCustomAuditSpecifications, showAllCustomMediaDriverSpecifications, showAllDependentViews, showAllExtendedPermissions, showAllExternalRetentionPolicies, showAllFormats, showAllLifecycleDateRuleSpecifications, showAllLifecyclePolicies, showAllLifecyclePolicyActionSpecifications, showAllMedias, showAllNodeConfigurations, showAllNodeConfigurations, showAllOperationActionSpecifications, showAllPermissionBundles, showAllPolicies, showAllPolicyLists, showAllRepositoryParameters, showAllRetentionPolicies, showAllServerConfigurations, showAllServerConfigurations, showAllServerSpecifications, showAllServiceConfigurations, showAllServiceConfigurations, showAllStorageGroups, showAllSystemAcls, showAllValueDefaults, showAllValueDomains, showApplicationToken, showApplicationTokens, showAttachments, showAttribute, showAttribute, showAuditCertificates, showAuditEventOperationTypes, showAuditSpecification, showAuditTypeList, showAuditTypesForClass, showAuditTypesForCreateOperations, showAuditTypesForFreeOperations, showAuditTypesUnderClass, showAutoFolderingActionSpecification, showCapabilities, showClassDomain, showClassDomain, showClassObject, showClassObjectAndSubNames, showClassObjectAndSubs, showCompositeGroup, showCreateClassObjectScript, showCurrentUser, showCustomAuditHistory, showCustomAuditHistory, showCustomAuditTypes, showCustomMediaDriverSpecification, showDefaultMedia, showDefaultStorageGroup, showDefineAttributeScript, showDefinition, showDefinitionObject, showDependentView, showDocument, showDocumentCharacterSet, showDocumentContentInfo, showDocumentContents, showDocumentContents, showDocumentContents, showDocumentLanguage, showDocumentsWithLifecyclePolicy, showExpandedAuditTypeList, showExtendedPermission, showFolder, showFolder, showFolderCountInfo, showFormat, showGlobalAuditHistory, showGlobalAuditHistory, showGlobalAuditSpecification, showGlobalAuditTypeList, showGlobalOperationActionSpecifications, showGroup, showInstanceProperty, showInstancePropertyBundle, showLibraryObject, showLibraryObject, showLifecycleDateRuleSpecification, showLifecyclePolicy, showLifecyclePolicyActionSpecification, showLifecyclePolicyEntry, showLink, showLocalizer, showLockEntry, showLockEntryInfo, showLockTypeLookupTables, showMedia, showMediaLookupByFormatMappings, showMessageEntry, showMessageList, showNamedPropertyBundle, showNodeConfiguration, showNodeConfiguration, showObject, showObjectAuditHistory, showObjectAuditHistory, showObjectAuditSpecification, showOperationActionSpecification, showParsedArrayToken, showParsedOperationString, showPermissionBundle, showPolicy, showPolicyList, showPreparedSelector, showPreparedSelector, showProperty, showPropertyBundle, showRepositoryParameter, showRetentionPolicy, showRuntimeStatistics, showSavedSearchResultPrimaryObjects, showSavedSearchResults, showServerConfiguration, showServerConfiguration, showServerSpecification, showServiceConfiguration, showServiceConfiguration, showServiceStatistics, showSessionCacheStatistics, showSessionState, showSimplePropertyTable, showSimplePropertyTableList, showStorageGroup, showUser, showValueDefault, showValueDefault, showValueDomain, showValueDomain, sleep, syncContentIndex, syncIndex, testJsonString, tokenToDirectoryObjectArray, tokenToDirectoryUserArray, tokenToDocumentArray, transactionExists, unregisterAuditEventType, unregisterCustomAuditType, update, updateAccessControlList, updateClassDomain, updateDefinitionObject, updateLibraryObject, updateLibraryObject, updateLibraryObject, updateNodeConfiguration, updateNodeConfiguration, updateServerConfiguration, updateServerConfiguration, updateServiceConfiguration, updateServiceConfiguration, updateUserPassword, updateValueDefault, updateValueDomain, verifyBusinessObjectTagNotExists, verifyDefinitionTagNotExists, verifyDefinitionWriteable, verifyObjectTagNotExists, writeConsoleOutputString, writeConsoleOutputString, writeDocumentContentToFile, zeroPad
public FolderIndexOperations(ScriptDriver driver)
driver
- the main script driver instancepublic void dropFolderIndex(AttributeValueTable avt) throws IfsException
The keys supported by this operation:
avt
- the named argumentsIfsException
- if the operation failspublic void createFolderIndex(AttributeValueTable avt) throws IfsException
The keys supported by this operation:
avt
- the named argumentsIfsException
- if the operation failspublic void updateFolderIndex(AttributeValueTable avt) throws IfsException
The keys supported by this operation:
avt
- the named argumentsIfsException
- if the operation failspublic void identifyFolderIndexPropertyBundle(String pbTag) throws IfsException
pbTag
- the tag to useIfsException
- if the operation failsprotected boolean isIndexEnabled(LibrarySession session) throws IfsException
session
- the sessionIfsException
- if operation failsprotected int getMaxLevel(LibrarySession session) throws IfsException
Will return -1 if no index exists.
session
- the sessionIfsException
- if operation failsprotected boolean isUpdateModeSynchronous(LibrarySession session) throws IfsException
This also returns true if there is no folder index.
session
- the sessionIfsException
- if operation failsprotected void createFolderIndexTables(LibrarySession session, int maxLevel, String prefix) throws IfsException
Also initialize the table with "self" rows for all existing folders. All entries are initialized at level 0 of the folder index.
session
- the sessionmaxLevel
- the max levelprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void createInitialFolderIndexRows(LibrarySession session, String prefix) throws IfsException
session
- the sessionprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void resetFolderIndexRows(LibrarySession session, String prefix) throws IfsException
session
- the sessionprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void dropIndex(LibrarySession session, String prefix) throws IfsException
This method has no effect if there is no index to drop.
session
- the sessionprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void completeIndexCreation(LibrarySession session, boolean deferCreate, String prefix) throws IfsException
This must be called to remove the "partially created" flag on the index.
session
- the sessiondeferCreate
- whether creation is being deferred to the agentprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void changeUpdateMode(LibrarySession session, boolean isSync, String prefix) throws IfsException
If the specified mode is the same as the current mode of the index, no change takes place (and no exception is thrown)
session
- the sessionisSync
- the desired update mode:
true = synchronous, false = asynchronousprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void promoteFolder(LibrarySession session, Folder folder, int newLevel, String prefix) throws IfsException
session
- the sessionfolder
- the folder to promotenewLevel
- the new levelprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void promoteFoldersByPath(LibrarySession session, String[] paths, int newLevel, String prefix) throws IfsException
The folders are specifed by absolute folder path.
session
- the sessionpaths
- the paths for the folders to promotenewLevel
- the new levelprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void rebuildIndex(LibrarySession session, String prefix) throws IfsException
Assume that the index has been either reset back to a state where only self rows exist, or that a new index has been created, but only self rows currently exist.
session
- the sessionprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected long applyDeferredUpdates(LibrarySession session, String prefix) throws IfsException
session
- the sessionprefix
- the indentation prefix for log messagesIfsException
- if operation failsprotected void setUseExistsClause(LibrarySession session, boolean useExists, String prefix) throws IfsException
session
- the sessionuseExists
- the desired value for the search propertyprefix
- the indentation prefix for log messagesIfsException
- if operation failsCopyright © 2023. All rights reserved.