Index (Documents Cleanup - services 1.0.1 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ADDED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupExemptionResult: The node exists and the exemption change was applied: the mixin is now present (keep) or absent (un-keep).
addExemptionMixin(String, String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Adds the exo:cleanupExemption mixin on the node, keeping real modification dates untouched.
addFailure(long, String) - Method in class org.exoplatform.addons.documents.cleanup.model.CleanupBulkResult
ADMINISTRATORS_GROUP - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Administrators group receiving cleanup campaign WebSocket notifications.
aggregateItemsAbsentFromCampaign(long, long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Count and reclaimable-bytes sum of the items of campaignId whose node uuid is ABSENT from otherCampaignId.
aggregateItemsSharedWithCampaign(long, long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Count and reclaimable-bytes sum of the items of campaignId whose node uuid ALSO belongs to otherCampaignId — the 'persisting' bucket of a campaign comparison, computed set-based by the database (never by loading both candidate sets in memory).
applyRetention() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Scheduled-glue entry point: keeps item detail for the last N terminal campaigns only; older reports are archived as CSV (FileService) then their item detail is purged.
applyRevalidation(CleanupCampaignItem, CleanupRevalidation) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupRevalidationUtil: Applies a revalidation outcome to a campaign item: outcome unknown (transient JCR read failure): the item is left UNTOUCHED — never spared, never gone, never deleted on doubt; callers needing a distinct handling (e.g.

B

build(CleanupBulkResult) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupCampaign) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupCampaignItem, IdentityManager) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder: Item DTO WITHOUT its failure detail — the safe default, see CleanupEntityBuilder.build(CleanupCampaignItem, IdentityManager, boolean).
build(CleanupCampaignItem, IdentityManager, boolean) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder: Item DTO, its administrator-only failure DETAIL included only when asked for.
build(CleanupComparison) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupFailureGroup) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupScanUnit) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupScanUnitProgress) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(CleanupUserSummary) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
build(Page<CleanupCampaignItem>, IdentityManager) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder: Page of item DTOs WITHOUT their failure detail — the safe default, see CleanupEntityBuilder.build(Page, IdentityManager, boolean).
build(Page<CleanupCampaignItem>, IdentityManager, boolean) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder: Page of item DTOs, their administrator-only failure detail included only when asked for — same security boundary as CleanupEntityBuilder.build(CleanupCampaignItem, IdentityManager, boolean), read that javadoc before touching this flag.
buildDefaults(CleanupParams, int) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder: The platform DEFAULTS as the creation form consumes them: the same field names a campaign carries, so the form fills from either shape, plus the ceiling the scan-thread input must not exceed.

C

CampaignComparisonRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of a delta between two campaigns' candidate sets.
CampaignComparisonRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignComparisonRestEntity
CampaignFailureGroupRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of one grouped failure of a campaign: the failure message code the console localizes, how many items carry it, and whether a retry would re-attempt them — the SERVER's answer to that last question, so the console never holds its own copy of the retryable rule.
CampaignFailureGroupRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignFailureGroupRestEntity
CampaignItemRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of a cleanup campaign item.
CampaignItemRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignItemRestEntity
CampaignRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of a cleanup campaign.
CampaignRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignRestEntity
CampaignScanUnitProgressRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of a dry run's per-UNIT progress: how many subtrees settled, how deep the retries went, and which ones are in flight.
CampaignScanUnitProgressRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignScanUnitProgressRestEntity
CampaignScanUnitRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of ONE scan unit in flight: the subtree a reader is walking, its own resume checkpoint and its own counts.
CampaignScanUnitRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.CampaignScanUnitRestEntity
cancelCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
cancelCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Cancels a campaign from any non-terminal state.
CANCELLED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
CANDIDATE - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
checkArchiveAvailable(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Availability check of a campaign's CSV report, to run BEFORE a single byte is streamed: once the response body started flowing the HTTP status is already committed, so the not-found outcome has to be settled here.
claimUnit(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: CLAIMS a unit for a walk: a PURE RUNNING flip, spending NOTHING.
CleanupAction - Enum Class in org.exoplatform.addons.documents.cleanup.constant: Action planned by a cleanup campaign on a candidate file.
CleanupBulkFailure - Class in org.exoplatform.addons.documents.cleanup.model: One per-item failure of a bulk keep / un-keep: the item that could not be decided and the message code explaining why.
CleanupBulkFailure() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupBulkFailure
CleanupBulkResult - Class in org.exoplatform.addons.documents.cleanup.model: Outcome of a bulk keep / un-keep: how many items were decided, and which ones failed with which reason.
CleanupBulkResult() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupBulkResult
CleanupCampaign - Class in org.exoplatform.addons.documents.cleanup.model: Domain model of a cleanup campaign.
CleanupCampaign() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupCampaign
CleanupCampaignAggregates - Class in org.exoplatform.addons.documents.cleanup.model: Item aggregates of one campaign (candidate count/bytes, reclaimed bytes, item-rows existence), computed by a single grouped query for a whole campaigns list instead of per-campaign aggregate queries.
CleanupCampaignAggregates() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupCampaignAggregates
CleanupCampaignDAO - Interface in org.exoplatform.addons.documents.cleanup.dao
CleanupCampaignEntity - Class in org.exoplatform.addons.documents.cleanup.entity
CleanupCampaignEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.entity.CleanupCampaignEntity
CleanupCampaignItem - Class in org.exoplatform.addons.documents.cleanup.model: Domain model of a cleanup campaign item (one candidate file and its lifecycle).
CleanupCampaignItem() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupCampaignItem
CleanupCampaignItemDAO - Interface in org.exoplatform.addons.documents.cleanup.dao
CleanupCampaignItemEntity - Class in org.exoplatform.addons.documents.cleanup.entity
CleanupCampaignItemEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.entity.CleanupCampaignItemEntity
CleanupCampaignLifecycle - Class in org.exoplatform.addons.documents.cleanup.service: Single authority over campaign state transitions and their side effects: the allowed-transitions guard, persisting the new state, the WebSocket stateChanged event, and registering/unregistering the JCR freshness observation listener on entry/exit of PUBLISHED.
CleanupCampaignLifecycle() - Constructor for class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignLifecycle
CleanupCampaignRest - Class in org.exoplatform.addons.documents.cleanup.rest
CleanupCampaignRest() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
CleanupCampaignService - Class in org.exoplatform.addons.documents.cleanup.service: Cleanup campaigns lifecycle: dry-run launch, publication (single active campaign platform-wide), grace-deadline locking, execution trigger, cancellation, user exemptions ('keep'/'un-keep'), candidate freshness refresh, campaign comparison, report retention and CSV archiving.
CleanupCampaignService() - Constructor for class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
CleanupCampaignState - Enum Class in org.exoplatform.addons.documents.cleanup.constant: Lifecycle states of a cleanup campaign.
CleanupCampaignStorage - Class in org.exoplatform.addons.documents.cleanup.storage: RDBMS storage of cleanup campaigns and their items: the only layer touching the cleanup DAOs, mapping entities to simple domain models.
CleanupCampaignStorage() - Constructor for class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
CleanupCampaignSummary - Class in org.exoplatform.addons.documents.cleanup.model: Aggregates of a cleanup campaign snapshotted at completion into its summaryJson.
CleanupCampaignSummary() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupCampaignSummary
CleanupCandidate - Class in org.exoplatform.addons.documents.cleanup.model: A file (JCR nt:file node) qualifying for a cleanup action, as computed by a dry-run scan or a revalidation.
CleanupCandidate(String, String, long, long, long, CleanupAction, long, long) - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupCandidate
CleanupComparison - Class in org.exoplatform.addons.documents.cleanup.model: Delta between two campaigns' candidate sets, matched by node uuid.
CleanupComparison() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupComparison
CleanupComparisonBucket - Class in org.exoplatform.addons.documents.cleanup.model: One bucket of a campaign comparison (persisting / new / gone): the item count and reclaimable-bytes sum computed by a single set-based aggregate query.
CleanupComparisonBucket() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupComparisonBucket
CleanupConstants - Class in org.exoplatform.addons.documents.cleanup.util: Single definition of the physical drive layout swept by cleanup campaigns (scan roots, drive-root depths) and of the cleanup-wide static constants.
CleanupCriterionEvaluator - Class in org.exoplatform.addons.documents.cleanup.util: Pure, JCR-free evaluation of the cleanup candidate criterion: a node under an excluded path prefix is never a candidate DELETE: created AND last modified older than the campaign period, and content size above the floor PURGE_VERSIONS: the file owns at least one PURGEABLE version — see CleanupCriterionEvaluator.selectVersionsToRemove(java.util.Map<java.lang.String, java.lang.Long>, java.lang.String, java.lang.String, org.exoplatform.addons.documents.cleanup.model.CleanupParams, long) for the union of the age rule and the count rule that defines the removal set — and the size of that removal set is above the floor An exemption (exo:cleanupExemption mixin) is deliberately NOT evaluated here: an exempted node still qualifying by these criteria is emitted as an exempted-flagged CleanupCandidate, so it stays visible as 'Kept' in every campaign.
CleanupEntityBuilder - Class in org.exoplatform.addons.documents.cleanup.rest.util: Domain model to REST DTO mapping.
CleanupEtaUtil - Class in org.exoplatform.addons.documents.cleanup.util: Single definition of the throughput ETA of a cleanup worker, shared by the dry-run scan and the execution purge — the two workers used to carry the very same arithmetic verbatim, so a change (or a regression) in one of them silently diverged from the other.
CleanupExecutionService - Class in org.exoplatform.addons.documents.cleanup.service: Asynchronous batched purge of a LOCKED campaign, under a JCR system session.
CleanupExecutionService() - Constructor for class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService
CleanupExemptionResult - Enum Class in org.exoplatform.addons.documents.cleanup.constant: Outcome of an exemption mixin change (add or remove) on a JCR node, letting the Service layer distinguish a node that no longer exists (item GONE) from a transient write failure (item state untouched, retryable).
CleanupFailureGroup - Class in org.exoplatform.addons.documents.cleanup.model: One group of a campaign's failed items: the failure message code and how many SKIPPED items carry it, computed by a single grouped aggregate query (the item rows are never loaded).
CleanupFailureGroup() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupFailureGroup
CleanupGraceDeadlineJob - Class in org.exoplatform.addons.documents.cleanup.job: Scheduled glue, no business logic: flips the PUBLISHED campaign to LOCKED once its grace deadline elapsed, enforces report retention, and watchdogs the scan/purge workers (a campaign whose worker thread died mid-run is resumed on the next tick, without a JVM restart).
CleanupGraceDeadlineJob() - Constructor for class org.exoplatform.addons.documents.cleanup.job.CleanupGraceDeadlineJob
CleanupIdentityUtil - Class in org.exoplatform.addons.documents.cleanup.util: Single definition of the owner display name of a cleanup item, shared by the REST DTO builder and the CSV report so the exported name and the one shown in the UI can never disagree.
CleanupItemRest - Class in org.exoplatform.addons.documents.cleanup.rest
CleanupItemRest() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest
CleanupItemState - Enum Class in org.exoplatform.addons.documents.cleanup.constant: State of a single campaign item (candidate file).
CleanupJcrObservationListener - Class in org.exoplatform.addons.documents.cleanup.listener: JCR observation listener registered only while a cleanup campaign is PUBLISHED.
CleanupJcrObservationListener(BiConsumer<String, String>) - Constructor for class org.exoplatform.addons.documents.cleanup.listener.CleanupJcrObservationListener
CleanupJcrStorage - Class in org.exoplatform.addons.documents.cleanup.storage: JCR implementation of CleanupJcrStorage against the collaboration workspace, always through a system session (async cleanup workers carry no user conversation state).
CleanupJcrStorage() - Constructor for class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage
CleanupJcrStorage.ScanBatchConsumer - Interface in org.exoplatform.addons.documents.cleanup.storage: Receives the scanned batches streamed by CleanupJcrStorage.scanRoot(String, String, int, CleanupParams, ScanBatchConsumer).
CleanupNodeFailures - Class in org.exoplatform.addons.documents.cleanup.model: Nodes a scan batch could not EVALUATE, and the first failure that did it.
CleanupNodeFailures() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupNodeFailures
CleanupParams - Class in org.exoplatform.addons.documents.cleanup.model: Parameters of a cleanup campaign.
CleanupParams() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupParams
CleanupPurgeResult - Class in org.exoplatform.addons.documents.cleanup.model: Outcome of a purge operation (hard delete or versions purge) on one item.
CleanupPurgeResult() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult
CleanupRevalidation - Class in org.exoplatform.addons.documents.cleanup.model: Result of re-evaluating a former candidate against the campaign criteria, distinguishing a node that disappeared, one that got exempted, one that no longer qualifies, one still qualifying (candidate != null), and an outcome that could NOT be computed (transient JCR read failure): an unknown outcome must never be mistaken for a spared/gone node — the execution skips the item (never deletes on doubt) and the freshness refresh leaves it untouched.
CleanupRevalidation() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupRevalidation
CleanupRevalidationUtil - Class in org.exoplatform.addons.documents.cleanup.util: Single definition of the revalidation-outcome to item-state mapping, shared by the freshness refresh (observation glue) and the execution-time revalidation so both stay strictly identical.
CleanupScanService - Class in org.exoplatform.addons.documents.cleanup.service: Asynchronous dry-run scan of the collaboration workspace, PARALLELISED over scan UNITS: the tree is partitioned once (see CleanupConstants.SPLIT_SCAN_ROOTS), several reader threads walk their own unit each, and ONE writer thread persists everything they stream through a bounded queue.
CleanupScanService() - Constructor for class org.exoplatform.addons.documents.cleanup.service.CleanupScanService
CleanupScanUnit - Class in org.exoplatform.addons.documents.cleanup.model: One partition of the dry-run scan: the JCR subtree ONE reader thread walks, with its own state, its own path checkpoint and its own counters.
CleanupScanUnit() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupScanUnit
CleanupScanUnitDAO - Interface in org.exoplatform.addons.documents.cleanup.dao
CleanupScanUnitEntity - Class in org.exoplatform.addons.documents.cleanup.entity
CleanupScanUnitEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.entity.CleanupScanUnitEntity
CleanupScanUnitProgress - Class in org.exoplatform.addons.documents.cleanup.model: Per-UNIT breakdown of a campaign's dry run: the state counts, the deepest attempt any unit has spent, and the units currently in flight.
CleanupScanUnitProgress() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupScanUnitProgress
CleanupScanUnitState - Enum Class in org.exoplatform.addons.documents.cleanup.constant: State of a single dry-run scan unit (a partition of the scanned tree walked by ONE reader thread).
CleanupScanUnitStorage - Class in org.exoplatform.addons.documents.cleanup.storage: RDBMS storage of the dry-run scan units: the only layer touching the scan-unit DAO, mapping entities to simple domain models.
CleanupScanUnitStorage() - Constructor for class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
CleanupSettingService - Class in org.exoplatform.addons.documents.cleanup.service: Cleanup campaign settings: platform defaults overridable via exo.properties and persisted overrides in SettingService (GLOBAL context).
CleanupSettingService() - Constructor for class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
CleanupSizeUtil - Class in org.exoplatform.addons.documents.cleanup.util: The ONE definition of what an item's action reclaims, in Java.
CleanupThrowableUtil - Class in org.exoplatform.addons.documents.cleanup.util: Renders a purge failure into the compact diagnostic persisted in the item's FAILURE_DETAIL column — never a full printStackTrace.
CleanupUserOutcome() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupUserSummary.CleanupUserOutcome
CleanupUserSummary - Class in org.exoplatform.addons.documents.cleanup.model: Per-user summary of the currently relevant campaign: their candidates and kept files during the grace period, their outcome once completed.
CleanupUserSummary() - Constructor for class org.exoplatform.addons.documents.cleanup.model.CleanupUserSummary
CleanupUserSummary.CleanupUserOutcome - Class in org.exoplatform.addons.documents.cleanup.model
CleanupWebSocketService - Class in org.exoplatform.addons.documents.cleanup.websocket: Push-only CometD channel notifying connected administrators of campaign progress and state changes.
CleanupWebSocketService() - Constructor for class org.exoplatform.addons.documents.cleanup.websocket.CleanupWebSocketService
CleanupWsMessage - Class in org.exoplatform.addons.documents.cleanup.websocket: Flat WebSocket payload pushed to administrators while a campaign scan or execution progresses.
CleanupWsMessage() - Constructor for class org.exoplatform.addons.documents.cleanup.websocket.CleanupWsMessage
COLLABORATION - Static variable in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage
COMETD_CHANNEL - Static variable in class org.exoplatform.addons.documents.cleanup.websocket.CleanupWebSocketService
compareCampaigns(long, long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
compareCampaigns(long, long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Delta between two campaigns' candidate sets, matched by node uuid.
COMPLETED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
computeEtaSeconds(long, long, long, long) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupEtaUtil: Same as CleanupEtaUtil.computeEtaSeconds(long, long, long, long, long) evaluated against the current server clock.
computeEtaSeconds(long, long, long, long, long) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupEtaUtil: Remaining time of a run, from the throughput measured since it started.
countByCampaignId(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO
countByCampaignIdAndOwnerIdentityIdInAndState(long, List<Long>, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
countByCampaignIdAndState(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
countByCampaignIdAndState(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO
countByState(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Per-STATE unit counts of a campaign, in ONE grouped query (rows: state, unit count) — never by loading the unit rows, whose number is one per space plus one per /Users bucket.
countFailuresByReason(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Per-reason counts of a campaign's SKIPPED items, from ONE grouped aggregate query.
countFailuresByReason(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Per-reason counts of a campaign's FAILED units, from ONE grouped aggregate query — the unit-level twin of CleanupCampaignStorage#countFailuresByReason.
countFailuresByReason(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Per-reason item counts of a campaign's failures, in ONE grouped query (rows: failure reason, item count).
countFailuresByReason(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Per-reason unit counts of a campaign's failed subtrees, in ONE grouped query (rows: failure reason, unit count) — the very shape CleanupCampaignItemDAO#countFailuresByReason answers for items, so the console renders both through the same block.
countFiles(String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage
countItemsByOwnersAndState(long, List<Long>, CleanupItemState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Chunked like CleanupCampaignStorage.getItemsByOwners(long, java.util.List<java.lang.Long>, java.lang.String, org.springframework.data.domain.Pageable), but merging is trivial and EXACT here: the owner sets are disjoint, so the per-chunk counts simply add up.
countItemsByState(long, CleanupItemState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
countSettledFailedUnits(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Failed units of a campaign that spent every walk attempt they had — the SETTLED ones, which no longer hold the completion of the dry-run back.
countSettledFailures(long, String, long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Units of a campaign whose walk failed and which spent every attempt they had: they are SETTLED, so they no longer hold the dry-run's completion back — and they are exactly what makes the produced report INCOMPLETE.
countUnits(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
countUnitsByState(long, CleanupScanUnitState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
createCampaign(String, CleanupParams) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Creates a campaign snapshotting the effective parameters, then launches its dry-run scan.
createCampaign(CleanupCampaign) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
createCampaign(CampaignRestEntity) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: ASYNCHRONOUS: the campaign row is created synchronously, its dry-run scan is handed off to a worker thread — hence the 202.

D

DELETE - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupAction
deleteByCampaignId(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Drops every item row of a campaign in ONE statement.
deleteByCampaignId(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Drops every unit row of a campaign, in ONE statement (declared, not derived — see CleanupCampaignItemDAO#deleteByCampaignId for why that matters).
deleteCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: 204 and not 202, deliberately, although the report rows are dropped asynchronously (see CleanupCampaignService#deleteCampaign): the campaign row is gone before this answers, so the resource really IS deleted and nothing about it is still pending.
deleteCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Deletes a campaign and everything hanging off it: its item rows, its scan unit rows and its archived CSV.
deleteCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Drops the campaign row itself — there is no cascade, by design: a cascade would make a campaign row deletable without anyone deciding what happens to the report and the archived CSV hanging off it.
deleteCampaignRowsTransactional(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Drops the report and scan unit rows of an already-deleted campaign, off the request thread.
deleteItems(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
deleteNode(String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Hard-deletes a file node (no trash): removes pointing symlinks first, then the node, then now-empty ancestor folders up to (excluding) the drive root.
deleteUnits(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Drops the unit rows of a campaign being deleted.
displayName(Identity) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupIdentityUtil: Display name of an owner identity: its profile full name, falling back to its remote id when the profile is missing or unnamed.
DONE - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState
DRAFT - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
drainQueue(CleanupScanService.ScanRun) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Writer body — the ONLY component writing what the scan produces.
drainQueueTransactional(CleanupScanService.ScanRun) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Transactional entry point of the WRITER thread, self-invoked from the runnable started by CleanupScanService.scanUnits(long, org.exoplatform.addons.documents.cleanup.model.CleanupParams, java.util.List<org.exoplatform.addons.documents.cleanup.model.CleanupScanUnit>, java.util.concurrent.ExecutorService, int, long, long): the project weaves @ContainerTransactional with AspectJ, which advises self-calls too — the same property executorService.execute(() -> scanTransactional(id)) already relies on.
DRY_RUN_RUNNING - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState

E

evaluateLazily(long, long, int, String, CleanupParams, long, LongSupplier, LongSupplier) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupCriterionEvaluator: The candidate criterion, with the two sizes supplied lazily: a supplier is invoked ONLY when the decision cannot be reached without it.
executeCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: ASYNCHRONOUS: the campaign is switched to EXECUTING synchronously, the batched purge itself is handed off to a worker thread — hence the 202.
executeCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Triggers the batched purge of a LOCKED campaign.
executeCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService: Execution worker, running as system (no conversation state needed).
executeCampaignTransactional(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService
EXECUTING - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
exempted() - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupRevalidation
EXEMPTED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
existsByCampaignId(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
EXO_CLEANUP_EXEMPTED_BY - Static variable in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage
EXO_CLEANUP_EXEMPTED_DATE - Static variable in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage
EXO_CLEANUP_EXEMPTION - Static variable in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage

F

FAILED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupExemptionResult: The node exists but the exemption change could not be persisted.
FAILED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState
FILE_NAMESPACE - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: File-store namespace the archived CSV reports live in.
findAggregatesByCampaignIds(List<Long>) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Per-campaign, per-state item aggregates of a whole campaigns list in ONE grouped query (rows: campaignId, state, item count, reclaimable bytes sum, reclaimed bytes sum), folded by the Storage layer into one aggregate per campaign — replaces up to 4 aggregate queries PER campaign on the list endpoint.
findByCampaignIdAndIdGreaterThanOrderByIdAsc(long, long, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: KEYSET page of a campaign's items in id order — the CSV export walk.
findByCampaignIdAndNodeUuidIn(long, Collection<String>) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
findByCampaignIdAndPathTouchedBy(long, List<String>, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Items touched by a JCR event path, in two index-friendly directions (the column always stays on the LEFT of the LIKE, the parameter on the right): items that are the event node or one of its ancestors: exact match against the ancestor chain computed in Java by the Storage layer items below the event node (a deleted/moved FOLDER fires a single JCR event for the top-most node only): prefix LIKE on the event path, with its '_'/'%' wildcards escaped by the Storage layer ('|' escape character), so padded segments like /Users/j___/ never wildcard-match unrelated rows
findByCampaignIdAndState(long, String, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
findByFilters(long, Long, String, String, Long, String, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Campaign items matching every provided filter, each one null-tolerant so a single query serves any combination.
findByOwnersAndSearch(long, List<Long>, String, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: The user-review counterpart of CleanupCampaignItemDAO.findByFilters(long, java.lang.Long, java.lang.String, java.lang.String, java.lang.Long, java.lang.String, org.springframework.data.domain.Pageable): the items of the campaign owned by the given identities (the user plus the spaces they manage), optionally narrowed by the same null-tolerant path search — see that method's javadoc for the pattern contract and the index note.
findByState(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: The units of a campaign in one given state, oldest id first.
findByStateIn(List<String>) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignDAO
findByStateOrderedByReclaimableBytes(long, String, Long, long, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: KEYSET page of the items of a campaign in a given state, BIGGEST FIRST — the order the purge worker consumes them in.
findOrphanCampaignIds() - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: Campaign ids that have item rows but NO campaign row — rows nothing can ever read again, every item query being scoped by campaign id.
findOrphanCampaignIds() - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Campaign ids that have unit rows but NO campaign row: the scan-unit half of CleanupCampaignItemDAO#findOrphanCampaignIds, swept at startup for the same reason.
findRetryableFailures(long, String, Collection<String>, long, long, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: KEYSET page of the RETRYABLE failures of a campaign: SKIPPED items whose failure reason belongs to the allowlist the Service owns and whose attempt count is still under the bound.
findStateById(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignDAO: The CURRENT persisted state of a campaign, read as a SCALAR projection: a projection query always goes to the database, unlike findById, which answers the persistence context's cached entity.
findUnitPathsByCampaignId(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Unit PATHS of a campaign, as a projection: planning only needs to know which paths already exist, and loading whole rows to read one column of each would be wasted work on every resume.
findUnitsToProcess(long, String, String, long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: The units of a campaign still to process, oldest id first: everything but DONE, MINUS the settled-failed ones — a unit that FAILED after spending every walk attempt it had.
findUnitsWithEvalFailures(long, Pageable) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: The units of a campaign that lost at least one node, worst first.
formatFailureDetail(Throwable) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupThrowableUtil: Compact diagnostic of a failure: the head exception block, the omitted intermediate-cause count when the chain had any, then the root-cause block — the whole thing capped at CleanupThrowableUtil.MAX_DETAIL_LENGTH characters.

G

getBatchSize() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
getCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
getCampaignArchive(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: STREAMED: the report is written page by page to the response body, so the download starts immediately and a large campaign never materializes its CSV in memory.
getCampaignFailures(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: Grouped failures of a campaign, so the console can show WHY items were skipped and which of those failures a retry would re-attempt — the retryable flag is the SERVER's answer, the client never decides it.
getCampaignFailures(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Grouped failures of a campaign: one entry per distinct failure message code, its SKIPPED item count, and whether a retry would re-attempt it — the flag read from CleanupCampaignService.RETRYABLE_FAILURE_REASONS, so the console never has to hold its own copy of that rule.
getCampaignItems(long, Long, String, String, Long, String, int, int, String) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getCampaignItems(long, Long, CleanupItemState, CleanupAction, Long, String, Pageable) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Campaign items with optional filters, for the admin console.
getCampaigns() - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getCampaigns() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
getCampaigns(Pageable) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
getCampaignsByStates(List<CleanupCampaignState>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
getCampaignScanFailures(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getCampaignScanFailures(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Grouped failures of a campaign's dry-run SCAN: one entry per distinct failure message code, with the number of SUBTREES that carry it.
getCampaignScanUnitProgress(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Per-unit breakdown of a campaign's dry run, resolving the campaign here so an unknown id answers 404 like every other campaign endpoint.
getCampaignScanUnits(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: Grouped failures of a campaign's dry-run SCAN, so the console can say that the report the administrator is about to publish does NOT cover the whole tree, and WHY — one entry per subtree failure reason, with how many subtrees carry it.
getCampaignState(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: The CURRENT persisted state of a campaign, bypassing the persistence context (see CleanupCampaignDAO.findStateById(long)): what the abort polls and the transition guard must read, an entity load answering a possibly hours-old snapshot inside the workers' long-lived transactions.
getDefaultParams() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
getDefaultParams() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getDefaults() - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getDriveMinDepth(String) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Depth of the drive-root node the empty-ancestors sweep of a deleted file must stop at (the drive root itself is preserved, only deeper empty folders may be removed): space drive: /Groups/spaces/<space>/Documents, always at CleanupConstants.SPACE_DRIVE_MIN_DEPTH user drive: the user home's Private (or Public) folder.
getEffectiveParams(CleanupParams) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getGoneItems(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Items of the other campaign absent from the base one ('gone' bucket of a comparison): the very same query as CleanupCampaignStorage.getNewItems(long, long) with the campaigns swapped, so the bytes are read from the other campaign's rows.
getItem(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
getItemAggregates(List<Long>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Item aggregates of a whole campaigns list, computed by ONE grouped query (see the DAO) instead of per-campaign aggregate queries: a campaign absent from the returned map simply has no item rows anymore.
getItems(long, Long, CleanupItemState, CleanupAction, Long, String, Pageable) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Campaign items matching the provided filters, any of them nullable.
getItemsAfterId(long, long, int) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: KEYSET page of a campaign's items in id order, for the CSV export walk — see CleanupCampaignItemDAO.findByCampaignIdAndIdGreaterThanOrderByIdAsc(long, long, org.springframework.data.domain.Pageable) on why this is not an offset Page.
getItemsByOwners(long, List<Long>, String, Pageable) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Items of the campaign owned by the given identities, optionally narrowed by the same path search as CleanupCampaignStorage.getItems(long, java.lang.Long, org.exoplatform.addons.documents.cleanup.constant.CleanupItemState, org.exoplatform.addons.documents.cleanup.constant.CleanupAction, java.lang.Long, java.lang.String, org.springframework.data.domain.Pageable).
getItemsByState(long, CleanupItemState, Pageable) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
getItemsByStateBiggestFirst(long, CleanupItemState, Long, long, int) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: KEYSET page of the items of a campaign in a given state, BIGGEST FIRST — see the DAO javadoc for why the cursor is a (reclaimableBytes, id) pair rather than an id, and why that still cannot revisit a row.
getItemsTouchedByPath(long, String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Items touched by a JCR event path: the event node itself, its ancestors (exact match against the ancestor chain, computed here) and its descendants (escaped prefix LIKE, so a deleted/moved folder event matches the candidate files below it).
getMaxScanThreads() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
getMaxScanThreads() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Upper bound a campaign may ask for, which is the platform ceiling and NOT the configured default: an administrator tuning one run may go above what exo.properties sets, and no further.
getMyItems(HttpServletRequest, String, int, int, String) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getMyItems(String, String, Pageable) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Items of the currently relevant campaign owned by the user (own files and files of spaces they manage).
getMyItemsSummary(HttpServletRequest) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
getMyItemsSummary(String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Per-user summary of the currently relevant campaign.
getNewItems(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Items of the base campaign absent from the other one ('new' bucket of a comparison).
getOrphanItemCampaignIds() - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Campaign ids whose item rows outlived their campaign row — see CleanupCampaignItemDAO#findOrphanCampaignIds.
getOrphanUnitCampaignIds() - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Campaign ids whose unit rows outlived their campaign row — see CleanupScanUnitDAO#findOrphanCampaignIds.
getPersistingItems(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Items of the base campaign whose node uuid is ALSO a candidate of the other campaign ('persisting' bucket of a comparison).
getPurgeBatchSize() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getReportRetentionCampaigns() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getRetryableFailures(long, Set<String>, long, long, int) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: KEYSET page of the SKIPPED items of a campaign whose failure reason is one of failureReasons and whose attempt count is still below maxAttemptCount — the retry candidates.
getScanFailures(CleanupCampaign) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Grouped failures of a campaign's SCAN, one entry per distinct failure message code with the number of subtrees that carry it — the unit-level twin of CleanupCampaignService#getCampaignFailures, so the console renders both through the same block.
getScanThreads() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService
getScanUnitProgress(CleanupCampaign) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Per-unit breakdown of a campaign's dry run.
getUnitProgress(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Per-unit breakdown of a campaign's dry run, for the console to tell a scan that RESUMES from one that is STUCK — the node percentage cannot, see CleanupScanUnitProgress.
getUnitsToProcess(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: The work list of a run: everything but DONE, MINUS the settled-failed units — the ones that FAILED after spending every walk attempt they had.
getUnitsWithEvalFailures(long, int) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
gone() - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult
gone() - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupRevalidation
GONE - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
GRACE_EDITABLE_STATES - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: States in which the GRACE PERIOD of a campaign may still be edited.

H

hashUnitPath(String) - Static method in class org.exoplatform.addons.documents.cleanup.entity.CleanupScanUnitEntity: Hashes a unit path into the value of CleanupScanUnitEntity.unitPathHash.
hasItems(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage

I

init() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
init() - Method in class org.exoplatform.addons.documents.cleanup.websocket.CleanupWebSocketService
isEmpty() - Method in class org.exoplatform.addons.documents.cleanup.model.CleanupNodeFailures
isTerminal() - Method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState

K

keepItem(long, String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: User decision to keep a candidate file: checks ownership (own file, or manager of the owning space), adds the exemption mixin and marks the item EXEMPTED.
keepItem(HttpServletRequest, long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest
KeepItemFailureRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.KeepItemsResultRestEntity.KeepItemFailureRestEntity
keepItems(HttpServletRequest, KeepItemsRestEntity) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest: Answers 200 with the per-item outcomes, NEVER a blanket 204: a bulk keep continues past individual failures, so the UI has to be able to warn instead of reporting a success when nothing was actually kept.
keepItems(List<Long>, String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Bulk variant of CleanupCampaignService.keepItem(long, String), continuing past individual failures and REPORTING them: a caller that answered a blanket success would tell the user their files are kept while none of them is.
KeepItemsRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: Bulk keep request body: {"itemIds": [...]}.
KeepItemsRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.KeepItemsRestEntity
KeepItemsResultRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of a bulk keep / un-keep outcome: the UI needs the per-item failures to warn instead of reporting a success when nothing was actually kept.
KeepItemsResultRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.KeepItemsResultRestEntity
KeepItemsResultRestEntity.KeepItemFailureRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model

L

listScanUnits() - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Enumerates the PARTITIONS of a dry-run scan — the subtrees a reader thread each walks on its own — by applying the per-root policy of CleanupConstants: the direct children of a split root (CleanupConstants.SPLIT_SCAN_ROOTS) become units, an unsplit root (CleanupConstants.UNSPLIT_SCAN_ROOTS) is itself one unit.
LOCKED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
lockExpiredPublishedCampaign() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Scheduled-glue entry point: flips the PUBLISHED campaign to LOCKED once its grace deadline elapsed.

M

MAX_DETAIL_LENGTH - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupThrowableUtil: Hard cap of the WHOLE rendered detail, enforced last.
MAX_FRAMES - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupThrowableUtil: Stack frames kept per rendered block, the rest being counted, not shown.
MAX_NAME_LENGTH - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Maximum campaign name length, mirroring the NAME column of DOCUMENTS_CLEANUP_CAMPAIGN — NVARCHAR(250) NOT NULL.
MAX_PURGE_BATCH_SIZE - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Upper bound of the purge checkpoint batch.
MAX_REPORTED_EVAL_FAILURES - Static variable in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Units carrying evaluation failures reported at once.
MAX_RETRY_ATTEMPTS - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: RETRIES an item may spend AFTER its initial purge attempt — three of them, so a doomed item is purge-attempted four times in all.
MAX_SCAN_THREADS - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Upper bound of the dry-run scan reader-thread count.
MAX_SCAN_UNIT_ATTEMPTS - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: FAILED walks a scan unit may spend IN TOTAL, the first walk included — THREE walks that each reached a FAILED outcome, not one walk plus three retries.
maxAttemptCount(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Deepest walk attempt any unit of a campaign has spent — how many times the most-retried subtree was re-walked, which is what tells an administrator that a scan is going round in circles rather than progressing.
MIN_PURGE_BATCH_SIZE - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Lower bound of the purge checkpoint batch: never a batch of zero item.
MIN_SCAN_THREADS - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Lower bound of the dry-run scan reader-thread count: never zero reader.
MyItemsSummaryRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: REST representation of the per-user summary of the currently relevant campaign.
MyItemsSummaryRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.MyItemsSummaryRestEntity
MyItemsSummaryRestEntity.OutcomeRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model

N

NOT_FOUND - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupExemptionResult: The node doesn't exist anymore.
NOT_OWNER_FAILURE_CODE - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Localizable message code reported for an ACL refusal in a bulk outcome, in place of the IllegalAccessException raw English message.

O

of(CleanupCandidate) - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupRevalidation
onBatch(List<CleanupCandidate>, String, int, CleanupNodeFailures) - Method in interface org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage.ScanBatchConsumer
onEvent(EventIterator) - Method in class org.exoplatform.addons.documents.cleanup.listener.CleanupJcrObservationListener
org.exoplatform.addons.documents.cleanup.constant - package org.exoplatform.addons.documents.cleanup.constant
org.exoplatform.addons.documents.cleanup.dao - package org.exoplatform.addons.documents.cleanup.dao
org.exoplatform.addons.documents.cleanup.entity - package org.exoplatform.addons.documents.cleanup.entity
org.exoplatform.addons.documents.cleanup.job - package org.exoplatform.addons.documents.cleanup.job
org.exoplatform.addons.documents.cleanup.listener - package org.exoplatform.addons.documents.cleanup.listener
org.exoplatform.addons.documents.cleanup.model - package org.exoplatform.addons.documents.cleanup.model
org.exoplatform.addons.documents.cleanup.rest - package org.exoplatform.addons.documents.cleanup.rest
org.exoplatform.addons.documents.cleanup.rest.model - package org.exoplatform.addons.documents.cleanup.rest.model
org.exoplatform.addons.documents.cleanup.rest.util - package org.exoplatform.addons.documents.cleanup.rest.util
org.exoplatform.addons.documents.cleanup.service - package org.exoplatform.addons.documents.cleanup.service
org.exoplatform.addons.documents.cleanup.storage - package org.exoplatform.addons.documents.cleanup.storage
org.exoplatform.addons.documents.cleanup.util - package org.exoplatform.addons.documents.cleanup.util
org.exoplatform.addons.documents.cleanup.websocket - package org.exoplatform.addons.documents.cleanup.websocket
OutcomeRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.MyItemsSummaryRestEntity.OutcomeRestEntity

P

PagedResult<T> - Class in org.exoplatform.addons.documents.cleanup.rest.model: Paged REST wrapper: {items, page, size, totalItems}.
PagedResult() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.PagedResult
PENDING - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState
planUnits(long, List<String>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Plans the units of a campaign, inserting as PENDING the paths not recorded yet and SKIPPING those already there: one paths query plus one saveAll, exactly like CleanupCampaignStorage#saveCandidates, backed by the UK_DOC_CLEANUP_SCAN_UNIT_PATH unique constraint.
postPoisonPill(CleanupScanService.ScanRun) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Hands the writer its terminal signal, UNCONDITIONALLY.
PROGRESS_EVENT - Static variable in class org.exoplatform.addons.documents.cleanup.websocket.CleanupWsMessage
publishCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest
publishCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Publishes a SIMULATED campaign, starting its grace period.
PUBLISHED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
PURGE_VERSIONS - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupAction
purged(long) - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult
PURGED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
purgeVersions(String, CleanupParams) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Purges the versions of a file selected by CleanupCriterionEvaluator.selectVersionsToRemove(java.util.Map<java.lang.String, java.lang.Long>, java.lang.String, java.lang.String, org.exoplatform.addons.documents.cleanup.model.CleanupParams, long): those older than the campaign period by their OWN creation date, plus — of the versions remaining inside the period — the oldest ones still exceeding maxVersionsPerFile.

R

readUnit(CleanupScanService.ScanRun, CleanupScanUnit) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Reader body: walks ONE unit and posts everything it finds on the queue, WRITING nothing (it reads, through Social, to resolve owners — see CleanupScanService.readUnitTransactional(org.exoplatform.addons.documents.cleanup.service.CleanupScanService.ScanRun, org.exoplatform.addons.documents.cleanup.model.CleanupScanUnit)).
readUnitTransactional(CleanupScanService.ScanRun, CleanupScanUnit) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Transactional entry point of a READER thread, self-invoked from the runnable submitted by CleanupScanService.scanUnits(long, org.exoplatform.addons.documents.cleanup.model.CleanupParams, java.util.List<org.exoplatform.addons.documents.cleanup.model.CleanupScanUnit>, java.util.concurrent.ExecutorService, int, long, long) — same AspectJ self-call property as CleanupScanService.drainQueueTransactional(org.exoplatform.addons.documents.cleanup.service.CleanupScanService.ScanRun).
RECLAIMABLE_BYTES - Static variable in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: The same column spliced into JPQL text, i.e.
RECLAIMABLE_BYTES_PROPERTY - Static variable in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO: The persisted reclaimable figure of an item — the bytes the item's OWN action frees: DELETE: the content size PLUS versionsSize.
RECLAIMABLE_SORT_KEY - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Logical sort key naming the RECLAIMABLE ordering of campaign items — the one and only name for it, shared by the REST sortable-field allowlist and by the Storage translating it into an ORDER BY on CleanupCampaignItemDAO#RECLAIMABLE_BYTES (the very column every reclaimable aggregate sums).
reclaimableBytes(String, long, long) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupSizeUtil
reclaimableBytes(CleanupAction, long, long) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupSizeUtil
record(Throwable) - Method in class org.exoplatform.addons.documents.cleanup.model.CleanupNodeFailures: Records one node the scan could not evaluate.
refreshCandidate(String, String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Freshness refresh (UX only, not the correctness guarantee), called by the JCR observation glue while a campaign is PUBLISHED.
registerObservationListener(BiConsumer<String, String>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Registers a JCR observation listener forwarding (nodePath, eventType) pairs for changes under the scanned roots.
removeExemptionMixin(String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Removes the exo:cleanupExemption mixin from the node (un-keep), mirroring CleanupJcrStorage.addExemptionMixin(String, String): a checked-in versionable node is checked out first, and real modification dates stay untouched.
restartCoordinatorTransaction() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: The COORDINATOR's own seam, third of the family for the same reason the reader's is separate from the writer's: it commits once per run — right before the terminal transition, so that write never flows through a persistence context as old as the run itself — and sharing the writer's seam would make every assertion on the writer's per-batch commit count silently include it.
restartReaderTransaction() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: The READER's twin of CleanupScanService.restartTransaction(), kept as a separate seam on purpose rather than reusing that one: the two commit on different threads for different reasons — the writer to make its batch durable, a reader only to let go of a pooled connection before it blocks (see CleanupScanService.commitThenPost(org.exoplatform.addons.documents.cleanup.service.CleanupScanService.ScanRun, org.exoplatform.addons.documents.cleanup.service.CleanupScanService.ScanBatch)) — and one shared seam would make every assertion on the writer's commit count silently depend on how many batches the readers happened to emit.
restartTransaction() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService: Commits the current batch and opens a fresh transaction.
restartTransaction() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Commits the current batch and opens a fresh transaction.
resumeExecution(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService: Resumes after a restart the purge of a campaign left EXECUTING: the worker is naturally resumable, it iterates the remaining CANDIDATE items.
resumeStalledWorkers() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Resumes the workers of the campaigns left DRY_RUN_RUNNING or EXECUTING without a live worker — the dry-run scan resumes from its persisted path checkpoint, the purge is naturally resumable (it iterates the remaining CANDIDATE items).
RETRYABLE_FAILURE_REASONS - Static variable in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Failure message codes a retry may re-attempt.
retryCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: A sub-resource POST, unlike the rename PATCH next to it: a retry is an ACTION with a lifecycle transition behind it (COMPLETED back to EXECUTING), not the update of an attribute.
retryCampaign(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Re-attempts the RETRYABLE failed items of a COMPLETED campaign: no new scan, no new grace period, no new campaign.
revalidate(String, CleanupParams) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Re-evaluates a node against the campaign criteria, at execution or refresh time.
run() - Method in class org.exoplatform.addons.documents.cleanup.job.CleanupGraceDeadlineJob
RUNNING - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState

S

saveCampaign(CleanupCampaign) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
saveCandidates(long, List<CleanupCandidate>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Saves scan candidates as campaign items, ignoring node uuids already recorded for the campaign (scan resume may replay a batch): one bulk existence query plus one saveAll per batch, backed by the UK_DOC_CLEANUP_ITEM_NODE unique constraint.
saveItem(CleanupCampaignItem) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
scan(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Scan coordinator, running as system (no conversation state needed), in four phases: PLAN the units, ESTIMATE their sizes in parallel, SCAN them with readers + one writer, then COMPLETE.
SCAN_ROOTS - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Roots scanned (and watched) by cleanup campaigns.
scanRoot(String, String, int, CleanupParams, CleanupJcrStorage.ScanBatchConsumer) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Scans the path-ordered nt:file nodes under the given root with a SINGLE query, streaming the qualifying cleanup candidates to the consumer in batches of batchSize scanned nodes (the last batch may cover fewer).
scanTransactional(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Transactional entry point of the COORDINATOR: planning, per-unit estimation and the terminal transition run in ONE container transaction, exactly like the execution purge (CleanupExecutionService.executeCampaignTransactional(long)).
selectVersionsToRemove(Map<String, Long>, String, String, CleanupParams, long) - Static method in class org.exoplatform.addons.documents.cleanup.util.CleanupCriterionEvaluator: Selects the versions of a versionable file to remove, as the UNION of the TWO purge rules — an age rule and a count rule — the architect ruled on: neither replaces the other.
sendToAdministrators(CleanupWsMessage) - Method in class org.exoplatform.addons.documents.cleanup.websocket.CleanupWebSocketService: Pushes a message to every connected member of /platform/administrators.
shutdown() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService
shutdown() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService
shutdown() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService
SIMULATED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState
skipped(String) - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult: A skip with NO exception behind it — a deterministic refusal such as cleanup.notVersionable, whose message code already says everything there is to say.
skipped(String, String) - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult: A skip that reclaimed nothing at all.
skipped(String, String, long) - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupPurgeResult: A PARTIAL purge: the item stays SKIPPED and keeps its failure reason (an administrator must still see that the file needs attention), but the bytes really reclaimed before the failure are CARRIED, so the campaign's reclaimed total reports the work actually done instead of silently under-reporting it.
SKIPPED - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
SPACE_DRIVE_MIN_DEPTH - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Depth (JCR semantics: '/' = 0) of the space drive-root node /Groups/spaces/<space>/Documents: the empty-ancestors sweep of a deleted space file must stop at (and never remove) this node.
SPACES_ROOT - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Root of the space drives in the collaboration workspace.
SPARED_BY_MODIFICATION - Enum constant in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState
SPLIT_SCAN_ROOTS - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Scan roots whose DIRECT CHILDREN are the parallel scan units — depth 1, and deliberately not deeper.
startExecution(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupExecutionService: Switches a campaign to EXECUTING and launches the asynchronous purge.
startScan(long) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupScanService: Starts (or resumes after a restart) the dry-run scan of a campaign.
STATE_CHANGED_EVENT - Static variable in class org.exoplatform.addons.documents.cleanup.websocket.CleanupWsMessage
sumEvalFailureCount(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Nodes the scan of a campaign walked but could not EVALUATE, summed over its units — the count of files silently missing from its report.
sumEvalFailureCount(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
sumReclaimableBytesByOwnersAndState(long, List<Long>, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
sumReclaimableBytesByOwnersAndState(long, List<Long>, CleanupItemState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Chunked and additively merged, see CleanupCampaignStorage.countItemsByOwnersAndState(long, java.util.List<java.lang.Long>, org.exoplatform.addons.documents.cleanup.constant.CleanupItemState).
sumReclaimableBytesByState(long, String) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
sumReclaimableBytesByState(long, CleanupItemState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
sumReclaimedBytes(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
sumReclaimedBytes(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage
sumReclaimedBytesByOwners(long, List<Long>) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupCampaignItemDAO
sumReclaimedBytesByOwners(long, List<Long>) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Chunked and additively merged, see CleanupCampaignStorage.countItemsByOwnersAndState(long, java.util.List<java.lang.Long>, org.exoplatform.addons.documents.cleanup.constant.CleanupItemState).
sumScannedCount(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Scanned-nodes sum over the units of a campaign — the progress numerator, computed by the database.
sumScannedCount(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
sumTotalCount(long) - Method in interface org.exoplatform.addons.documents.cleanup.dao.CleanupScanUnitDAO: Counted-nodes sum over the units of a campaign — the ETA denominator.
sumTotalCount(long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
sweepOrphanRows() - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Drops the item and scan unit rows whose campaign row no longer exists.

T

toParamOverrides(CampaignRestEntity) - Static method in class org.exoplatform.addons.documents.cleanup.rest.util.CleanupEntityBuilder
transition(CleanupCampaign, CleanupCampaignState) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignLifecycle: Variant of CleanupCampaignLifecycle.transition(CleanupCampaign, CleanupCampaignState, BiConsumer) for transitions never entering PUBLISHED.
transition(CleanupCampaign, CleanupCampaignState, BiConsumer<String, String>) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignLifecycle: Applies a campaign state transition with all its side effects: guards it against the allowed-transitions map, persists the new state, registers/unregisters the JCR freshness observation listener on entry/exit of PUBLISHED (a campaign leaving PUBLISHED or getting cancelled never leaks the listener) and broadcasts the stateChanged WebSocket event.
TRASH_ROOT - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants

U

unkeepItem(long, String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: User decision to un-keep a previously kept file (undo of CleanupCampaignService.keepItem(long, String)): checks ownership (own file, or manager of the owning space), removes the exemption mixin, then revalidates the node through the shared revalidation mapping — still qualifying goes back to CANDIDATE, modified meanwhile to SPARED_BY_MODIFICATION, disappeared to GONE.
unkeepItem(HttpServletRequest, long) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest
unkeepItems(HttpServletRequest, KeepItemsRestEntity) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupItemRest: Answers 200 with the per-item outcomes, mirroring CleanupItemRest.keepItems(HttpServletRequest, KeepItemsRestEntity).
unkeepItems(List<Long>, String) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Bulk variant of CleanupCampaignService.unkeepItem(long, String), continuing past individual failures and REPORTING them (see CleanupCampaignService.keepItems(List, String)).
unknown() - Static method in class org.exoplatform.addons.documents.cleanup.model.CleanupRevalidation
unregisterObservationListener() - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupJcrStorage: Unregisters the JCR observation listener, if registered, and logs out the session that owned it.
UNSPLIT_SCAN_ROOTS - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Scan roots taken WHOLE as a single unit, never partitioned: /Trash already has a dedicated trash cleaner on the platform, so splitting it buys nothing — it is scanned for the report only.
updateCampaign(long, String, Integer) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: PARTIAL update of a campaign's editable attributes: its name, its grace period, or both.
updateCampaign(long, UpdateCampaignRestEntity) - Method in class org.exoplatform.addons.documents.cleanup.rest.CleanupCampaignRest: PATCH on the campaign resource rather than an {id}/rename or {id}/grace sub-resource: this updates ATTRIBUTES of the campaign, it triggers no action and no lifecycle transition — unlike the publish / execute sub-resources next to it, which do.
UpdateCampaignRestEntity - Class in org.exoplatform.addons.documents.cleanup.rest.model: Partial-update request body: {"name": "..."} and/or {"graceDays": N}.
UpdateCampaignRestEntity() - Constructor for class org.exoplatform.addons.documents.cleanup.rest.model.UpdateCampaignRestEntity
updateDefaultParams(CleanupParams) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupSettingService: Persists new platform defaults (overriding exo.properties values).
updateEditableAttributes(long, String, Integer, Long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: TARGETED write of the attributes an administrator PATCH owns: the NAME, and the grace period together with the grace DEADLINE derived from it.
updateProgress(long, long, long, long, String, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupCampaignStorage: Persists the scan/execution progress counters and the scan resume checkpoint: checkpointPath is the last processed node path (or a bare scan-root path marking a root not started yet), the ONLY positioning information; checkpointOffset is the scanned-in-root count, kept for progress/ETA display only.
updateUnitFailure(long, String) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Marks a unit FAILED with its localizable reason, truncated to the column width (see CleanupScanUnitStorage.MAX_FAILURE_REASON_LENGTH) — and SPENDS the walk attempt, in the same write.
updateUnitProgress(long, String, long, CleanupNodeFailures) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage: Checkpoints a unit and folds in the nodes the batch could not evaluate, in the SAME entity write: one load and one save per batch, exactly as before the failures existed.
updateUnitState(long, CleanupScanUnitState) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
updateUnitTotal(long, long) - Method in class org.exoplatform.addons.documents.cleanup.storage.CleanupScanUnitStorage
USER_PRIVATE_FOLDER - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Name of the user drive-root folder holding private documents.
USER_PUBLIC_FOLDER - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Name of the user drive-root folder holding public documents.
USERS_ROOT - Static variable in class org.exoplatform.addons.documents.cleanup.util.CleanupConstants: Root of the user drives in the collaboration workspace.

V

valueOf(String) - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupAction: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupExemptionResult: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupAction: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupCampaignState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupExemptionResult: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupItemState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.exoplatform.addons.documents.cleanup.constant.CleanupScanUnitState: Returns an array containing the constants of this enum class, in the order they are declared.

W

writeArchiveCsv(long, OutputStream) - Method in class org.exoplatform.addons.documents.cleanup.service.CleanupCampaignService: Streams the CSV report of a campaign: generated page by page while item detail is retained (each page is flushed, so the first rows reach the client immediately and the whole report is never materialized in memory), copied from the FileService archive afterwards.

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form