-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #103 from usnistgov/feature/cache-expiry-check
Add CacheExpiryCheck for automated removal of expired cached data
- Loading branch information
Showing
12 changed files
with
362 additions
and
33 deletions.
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
src/main/java/gov/nist/oar/distrib/cachemgr/CacheExpiryCheck.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| package gov.nist.oar.distrib.cachemgr; | ||
|
|
||
| import gov.nist.oar.distrib.StorageVolumeException; | ||
|
|
||
| import java.time.Instant; | ||
|
|
||
| /** | ||
| * Implements a cache object check to identify and remove objects that have been in the cache | ||
| * longer than a specified duration, specifically two weeks. This check helps in | ||
| * managing cache integrity by ensuring that stale or outdated data are removed | ||
| * from the cache. | ||
| */ | ||
| public class CacheExpiryCheck implements CacheObjectCheck { | ||
|
|
||
| private StorageInventoryDB inventoryDB; | ||
|
|
||
| public CacheExpiryCheck(StorageInventoryDB inventoryDB) { | ||
| this.inventoryDB = inventoryDB; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if a cache object is expired and removes it from the cache if it is. | ||
| * The method uses the {@code expires} metadata field to determine the expiration status. | ||
| * The expiration time is calculated based on the {@code LastModified} time plus the {@code expires} duration. | ||
| * If the current time is past the calculated expiry time, the object is removed from the inventory database. | ||
| * | ||
| * @param co The cache object to check for expiration. | ||
| * @throws IntegrityException If the object is found to be corrupted during the check. | ||
| * @throws StorageVolumeException If there's an error accessing the storage volume during the check. | ||
| * @throws CacheManagementException If there's an error managing the cache, including removing the expired object. | ||
| */ | ||
| @Override | ||
| public void check(CacheObject co) throws IntegrityException, StorageVolumeException, CacheManagementException { | ||
| if (co == null || inventoryDB == null) { | ||
| throw new IllegalArgumentException("CacheObject or StorageInventoryDB is null"); | ||
| } | ||
|
|
||
| if (co.hasMetadatum("expires")) { | ||
| long expiresDuration = co.getMetadatumLong("expires", -1L); | ||
| if (expiresDuration == -1L) { | ||
| throw new IntegrityException("Invalid 'expires' metadata value"); | ||
| } | ||
|
|
||
| long lastModified = co.getLastModified(); | ||
| if (lastModified == -1L) { | ||
| throw new IntegrityException("CacheObject 'lastModified' time not available"); | ||
| } | ||
|
|
||
| long expiryTime = lastModified + expiresDuration; | ||
| long currentTime = Instant.now().toEpochMilli(); | ||
|
|
||
| // Check if the object is expired | ||
| if (expiryTime < currentTime) { | ||
| try { | ||
| boolean removed = removeObject(co); | ||
| if (!removed) { | ||
| throw new CacheManagementException("Failed to remove expired object: " + co.name); | ||
| } | ||
| } catch (InventoryException e) { | ||
| throw new CacheManagementException("Error removing expired object from inventory database: " + co.name, e); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Attempts to remove a cache object from both its physical volume and the inventory database. | ||
| * Synchronization ensures thread-safe removal operations. | ||
| * | ||
| * @param co The cache object to be removed. | ||
| * @return true if the object was successfully removed from its volume, false otherwise. | ||
| * @throws StorageVolumeException if an error occurs accessing the storage volume. | ||
| * @throws InventoryException if an error occurs updating the inventory database. | ||
| */ | ||
| protected boolean removeObject(CacheObject co) throws StorageVolumeException, InventoryException { | ||
| synchronized (inventoryDB) { | ||
| boolean out = co.volume.remove(co.name); | ||
| inventoryDB.removeObject(co.volname, co.name); | ||
| return out; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.