Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radarsh/raroscope
A pure Java library for scanning and enumerating RAR archive contents
https://github.com/radarsh/raroscope
compression java rar-archives
Last synced: 16 days ago
JSON representation
A pure Java library for scanning and enumerating RAR archive contents
- Host: GitHub
- URL: https://github.com/radarsh/raroscope
- Owner: radarsh
- License: apache-2.0
- Created: 2015-06-29T20:13:08.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2019-04-28T16:15:02.000Z (over 5 years ago)
- Last Synced: 2024-10-12T20:23:04.889Z (about 1 month ago)
- Topics: compression, java, rar-archives
- Language: Java
- Homepage:
- Size: 72.3 KB
- Stars: 33
- Watchers: 6
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
[  ](https://bintray.com/adarshr/maven/raroscope/_latestVersion)
[](https://maven-badges.herokuapp.com/maven-central/com.adarshr/raroscope)
[](https://circleci.com/gh/radarsh/gradle-test-logger-plugin)
Ever faced the challenge to be able to scan RAR archives using Java? Wished the API was as simple and easy to use as the ones provided for ZIP and JAR handling in Java? Don't want the hassles of including expensive native code into your Java application?
RARoScope is here to solve all these woes. The following lines are all you've to write to list out all the entries of a RAR file, say, `D:/Data.rar`.
```java
// Construct the RARFile object using the file path
RARFile file = new RARFile("D:/Data.rar");
// Get the handle to the Enumeration
Enumeration entries = file.entries();
// Iterate and print
while (entries.hasMoreElements()) {
RAREntry entry = entries.nextElement();
System.out.println(entry.getName());
}
```
Impressed? I sure was thrilled when I first wrote the library! Go ahead, download RARoScope and start using it in your applications right now.
## Usage
### Gradle
```groovy
compile 'com.adarshr:raroscope:1.0.2'
```
### Maven
```xml
com.adarshr
raroscope
1.0.2
```
## What RARoScope can do
Exposing a simple API, RARoScope packs the following rich features.
### Enhanced checking for true RAR archives
RARoScope ensures false RAR archives such as files with just a ".rar" extension do not interrupt further processing by reading and verifying the RAR marker header block and throwing exceptions where appropriate.
### A rich RAREntry class
RARoScope reads almost all the information available in a RAR archive and loads them into the RAREntry instances. Following are the file metadata retrieved.
- Full file name including the path
- Date and Time the file was modified/created
- Compressed file size
- Uncompressed file size
- The CRC checksum for the file
- Whether a file is a directory
- The operating system on which the file was added to the archive
- The compression method used
- The RAR version required to decompress and retrieve the file
### Optimized for performance
RARoScope has been designed to make efficient use of the underlying byte buffer so that very few I/O reads happen in each cycle. An effect of this is improved performance with very small cycle iteration times.
## What RARoScope can't do
However, because of various factors, RARoScope does have its limitations and can't do the following.
### Creating RAR archives
Because of the proprietary nature of the RAR archive format, RARoScope can't be used to create RAR archives.
### Reading file contents/decompressing
Since RARoScope has been poised as more of a "RAR scanning library" rather than a "RAR decompressor" for Java, it can't do the decompressing part. However, this is open to change in the near future. Depending on the response I get, I might implement a decompressing logic.
### Reading RAR entries with comments
RARoScope doesn't support reading comments and entries with comments as of now.
### Multi-volume RAR archives
RARoScope doesn't support reading multi-volume archives yet.