Skip to content

Add comparison to Apache Commons Compress in README #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add comparison to Apache Commons Compress in README #391

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0c036c
Initial plan
Copilot Oct 5, 2025
93f550c
Add comparison to Commons Compress in README
Copilot Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,59 @@ Plexus-archiver

The current master is now at https://github.com/codehaus-plexus/plexus-archiver

## What is Plexus Archiver?

Plexus Archiver is a high-level Java API for creating and extracting archives (ZIP, JAR, TAR, etc.). It provides a simple, unified interface for working with various archive formats, abstracting away the low-level details of archive manipulation.

## Comparison to Apache Commons Compress

Plexus Archiver builds on top of [Apache Commons Compress](https://commons.apache.org/proper/commons-compress/) (since version 2.5) and provides additional capabilities:

### Apache Commons Compress

Commons Compress is a low-level library that provides:
- Direct access to archive formats and compression algorithms
- Fine-grained control over archive entries and their attributes
- Support for a wide range of archive formats (ZIP, TAR, AR, CPIO, etc.)
- Streaming API for memory-efficient processing

### Plexus Archiver

Plexus Archiver is a higher-level abstraction layer that adds:

**Simplified API**: Easy-to-use builder-style interface for common archiving tasks without dealing with low-level stream handling.

**Advanced Features**:
- File selectors and filtering capabilities
- Automatic handling of file permissions and attributes
- Built-in support for directory scanning with includes/excludes patterns
- Reproducible builds support (configurable timestamps and ordering)
- Duplicate handling strategies
- File mappers for transforming entry names during archiving/unarchiving
- Protection against ZIP bombs (configurable output size limits)

**Build Tool Integration**: Designed for integration with build tools like Maven, with support for:
- Modular JAR creation (Java 9+ modules)
- Manifest generation and customization
- Archive finalizers for post-processing

**Dependency Injection Ready**: Includes JSR-330 annotations for easy integration with dependency injection frameworks.

### When to Use Which?

**Use Apache Commons Compress when:**
- You need fine-grained control over archive format details
- You're working with streaming data or large archives
- You need to support specialized or uncommon archive formats
- Memory efficiency is critical
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LOL, that is one of our current problem with plexus-archiver :-)


**Use Plexus Archiver when:**
- You want a simple, declarative API for common archiving tasks
- You're building a Maven plugin or similar build tool
- You need reproducible builds with consistent archive ordering
- You want built-in file filtering and selection capabilities
- You need to create modular JARs or other specialized Java archives

## Important Hint

Based on a hint of snyk.io security team they have found a possible security issue.
Expand Down
Loading