PowerPurge

A Java file cleanup utility. Allows defining file purge/archive rules per directory and executes them. Can be used for cleaning up old data files, log files, etc.

The program runs based on a specified config file that contains the purge rules and associated paths.

Command Parameters

The PowerPurge class takes the following command parameters:

-report Run in report mode; no changes will be made, but total file size will be reported.
-config {config-file} {config-file...} Config file(s) specifying rules to be processed.

Config File

The config file is a .json file with the following structure:

[
    {
        "name": "My purge rule",
        "filePattern": "*.*",
        "recursive": true,
        "fileAgeDays": 30,
        "archiveAgeDays": 90,
        "paths": [
            "/path1/sub1",
            "/path2/sub2"
        ]
    },
    {
        "name": "Another purge rule",
        ...
    }
]

Rule Properties:

• name: The name of the rule. It can be anything and doesn't have to be unique.
• filePattern: a list of file/wildcard patterns to be purged. Default value is "*" (all files). Multiple patterns can be specified by separating the list with semicolons. For example: "*.txt;*.log;*.xml"
• recursive: a flag indicating whether to apply these rules to all child folders (default=false)
• fileAgeDays: files older than this number of days will be purged (default=-1, meaning do not purge)
• archiveAgeDays: if greater than zero, deleted files will be placed into an archive zip file in the folder they were deleted from. The archive filename will be "archive-{date}_{time}.zip". These archive files will be removed by PowerPurge once they are archiveAgeDays old. If zero (the default), archives will not be created.
• paths: The list of paths to apply the purge rule to. If the recursive option is set, then all subdirectories under each path will also have the rule applied.

Directory Overrides:

You can customize the purge rules for an individual subdirectory when the recursive option is used. To override the rule properties for a subdirectory, create a file called .purge-config.json in that directory. The JSON structure is identical to the command config file, except that it specifies only a single object instead of an array. Any properties not specified in the directory override config file will use their value from the command config file. For example, to override a folder to use a 180 day archive, create the following file:

.purge-config.json

{
  "archiveAgeDays": 180
}