# srikanth-lingala/zip4j architecture

> Architecture diagram of the GitHub repository srikanth-lingala/zip4j, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/srikanth-lingala/zip4j
- Repository: https://github.com/srikanth-lingala/zip4j

## Overview

##### Project type and purpose
- This is an open-source Java library (Zip4j) for creating, reading, updating, and encrypting ZIP files and streams.
- It exposes a simple API centered around the ZipFile class and ZipInputStream/ZipOutputStream classes, hiding all the boilerplate of Java’s built-in zip support.

##### File structure
- Top-level: pom.xml + build config, README, CI workflows.
- src/main/java/net/lingala/zip4j: core code, organized into packages:
- zip4j (ZipFile API entry point)
- crypto (encryption/decryption abstractions, AES & standard zip, PBKDF2)
- headers (reading/writing ZIP headers and central directory)
- io/inputstream & io/outputstream (stream implementations that layer decompression, encryption, splitting, etc.)
- model (in-memory representation of ZIP metadata: ZipModel, FileHeader, ZipParameters, extra data records, enums)
- tasks (unit of work: AddFileTask, ExtractTask, RenameTask, progress in background threads)
- util & exception (helper functions, ZipException, constants)
- progress (ProgressMonitor for reporting status to callers)
- src/test: comprehensive integration and unit tests + test archives and files.

##### README for additional insights
- Describes API usage, feature set (stream support, AES & standard encryption, Zip64, split archives, Unicode).

##### Elements
- Labels: each major package or class (e.g., ZipFile, TaskManager, HeaderWriter, AesCipherOutputStream).
- ZipFile → ProgressMonitor → Client
- Task → CryptoEngine
- API layer (blue),
- Processing & tasks (green),
- Streams & decorators (orange),
- Crypto engines (red),
- Model & util (gray).

##### Detailed capture of essential elements
- Decorator flow: base FileOutputStream wrapped by split/crypto/compression/zip streams.
- How header read/write happens before/after payload streaming.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% API Layer
    subgraph "API Layer"
        ZipFile["ZipFile"]:::api
        ZipInputStream["ZipInputStream"]:::api
        ZipOutputStream["ZipOutputStream"]:::api
    end

    %% Task Manager
    subgraph "Task Manager"
        AbstractAdd["AbstractAddFileToZipTask"]:::tasks
        AbstractExtract["AbstractExtractFileTask"]:::tasks
        AbstractModify["AbstractModifyFileTask"]:::tasks
        AddFilesTask["AddFilesToZipTask"]:::tasks
        ExtractTask["ExtractFileTask"]:::tasks
        RenameTask["RenameFilesTask"]:::tasks
        RemoveTask["RemoveFilesFromZipTask"]:::tasks
        AsyncTask["AsyncZipTask"]:::tasks
    end

    %% Header Processor
    subgraph "Header Processor"
        HeaderReader["HeaderReader"]:::processing
        HeaderWriter["HeaderWriter"]:::processing
        FileHeaderFactory["FileHeaderFactory"]:::processing
    end

    %% Stream Pipeline
    subgraph "Stream Pipeline"
        subgraph "Input Streams"
            AesCipherInput["AesCipherInputStream"]:::streams
            DecompressedInput["DecompressedInputStream"]:::streams
            SplitFileInput["SplitFileInputStream"]:::streams
            ZipEntryInput["ZipEntryInputStream"]:::streams
        end
        subgraph "Output Streams"
            SplitOutput["SplitOutputStream"]:::streams
            AesCipherOutput["AesCipherOutputStream"]:::streams
            CompressedOutput["CompressedOutputStream"]:::streams
            ZipEntryOutput["ZipEntryOutputStream"]:::streams
        end
    end

    %% Crypto Engines
    subgraph "Crypto Engines"
        Encrypter["Encrypter"]:::crypto
        Decrypter["Decrypter"]:::crypto
        AESEngine["AESEngine"]:::crypto
        ZipCryptoEngine["ZipCryptoEngine"]:::crypto
        PBKDF2Engine["PBKDF2Engine"]:::crypto
    end

    %% Model Layer
    subgraph "Model Layer"
        ZipModel["ZipModel"]:::model
        ZipParameters["ZipParameters"]:::model
        FileHeaderModel["FileHeader"]:::model
        ExtraDataRecord["ExtraDataRecord"]:::model
        CentralDirectory["CentralDirectory"]:::model
    end

    %% Utilities & Support
    subgraph "Utilities & Support"
        ProgressMonitor["ProgressMonitor"]:::util
        FileUtils["FileUtils"]:::util
        RawIO["RawIO"]:::util
        BitUtils["BitUtils"]:::util
        CrcUtil["CrcUtil"]:::util
        ZipException["ZipException"]:::util
    end

    %% Relationships
    ZipFile --> AbstractAdd
    ZipFile --> AbstractExtract
    ZipFile --> AbstractModify
    ZipFile --> ZipInputStream
    ZipFile --> ZipOutputStream
    ZipFile --> ProgressMonitor
    AbstractAdd --> HeaderReader
    AbstractExtract --> HeaderReader
    AbstractModify --> HeaderWriter
    AbstractAdd --> SplitOutput
    SplitOutput --> AesCipherOutput
    AesCipherOutput --> CompressedOutput
    CompressedOutput --> ZipEntryOutput
    ZipInputStream --> AesCipherInput
    AesCipherInput --> DecompressedInput
    DecompressedInput --> ZipEntryInput
    AesCipherOutput --> AESEngine
    AesCipherInput --> AESEngine
    AESEngine --> PBKDF2Engine
    ZipCryptoEngine --> Decrypter
    AbstractAdd --> ProgressMonitor
    AbstractExtract --> ProgressMonitor
    AbstractModify --> ProgressMonitor
    HeaderReader --> ZipModel
    HeaderWriter --> CentralDirectory
    ZipEntryOutput --> FileUtils

    %% Click Events
    click ZipFile "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/ZipFile.java"
    click ZipInputStream "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/inputstream/ZipInputStream.java"
    click ZipOutputStream "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/outputstream/ZipOutputStream.java"
    click AbstractAdd "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/AbstractAddFileToZipTask.java"
    click AbstractExtract "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/AbstractExtractFileTask.java"
    click AbstractModify "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/AbstractModifyFileTask.java"
    click AddFilesTask "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/AddFilesToZipTask.java"
    click ExtractTask "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/ExtractFileTask.java"
    click RenameTask "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/RenameFilesTask.java"
    click RemoveTask "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/RemoveFilesFromZipTask.java"
    click AsyncTask "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/tasks/AsyncZipTask.java"
    click HeaderReader "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/headers/HeaderReader.java"
    click HeaderWriter "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/headers/HeaderWriter.java"
    click FileHeaderFactory "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/headers/FileHeaderFactory.java"
    click AesCipherInput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/inputstream/AesCipherInputStream.java"
    click DecompressedInput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/inputstream/DecompressedInputStream.java"
    click SplitFileInput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/inputstream/SplitFileInputStream.java"
    click ZipEntryInput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/inputstream/ZipEntryInputStream.java"
    click AesCipherOutput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/outputstream/AesCipherOutputStream.java"
    click CompressedOutput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/outputstream/CompressedOutputStream.java"
    click SplitOutput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/outputstream/SplitOutputStream.java"
    click ZipEntryOutput "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/io/outputstream/ZipEntryOutputStream.java"
    click Encrypter "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/crypto/Encrypter.java"
    click Decrypter "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/crypto/Decrypter.java"
    click AESEngine "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/crypto/engine/AESEngine.java"
    click ZipCryptoEngine "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/crypto/engine/ZipCryptoEngine.java"
    click PBKDF2Engine "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/crypto/PBKDF2/PBKDF2Engine.java"
    click ZipModel "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/model/ZipModel.java"
    click ZipParameters "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/model/ZipParameters.java"
    click FileHeaderModel "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/model/FileHeader.java"
    click ExtraDataRecord "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/model/ExtraDataRecord.java"
    click CentralDirectory "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/model/CentralDirectory.java"
    click ProgressMonitor "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/progress/ProgressMonitor.java"
    click FileUtils "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/util/FileUtils.java"
    click RawIO "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/util/RawIO.java"
    click BitUtils "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/util/BitUtils.java"
    click CrcUtil "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/util/CrcUtil.java"
    click ZipException "https://github.com/srikanth-lingala/zip4j/blob/master/src/main/java/net/lingala/zip4j/exception/ZipException.java"

    %% Styles
    classDef api fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef tasks fill:#90EE90,stroke:#000,stroke-width:1px
    classDef processing fill:#D0F0C0,stroke:#000,stroke-width:1px
    classDef streams fill:#FFD580,stroke:#000,stroke-width:1px
    classDef crypto fill:#FFB3B3,stroke:#000,stroke-width:1px
    classDef model fill:#D3D3D3,stroke:#000,stroke-width:1px
    classDef util fill:#E0E0E0,stroke:#000,stroke-width:1px
```
