# gotev/android-upload-service architecture

> Architecture diagram of the GitHub repository gotev/android-upload-service, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gotev/android-upload-service
- Repository: https://github.com/gotev/android-upload-service

## Overview

##### File‐structure analysis
- Top‐level modules:
- uploadservice (core library)
- uploadservice-ftp (FTP plugin)
- uploadservice-okhttp (OkHttp HTTP stack plugin)
- examples (Android demo apps + simple Node.js/PHP servers)
- utils (scripts to test Doze mode)
- Service entrypoint (UploadService, UploadServiceConfig)
- UploadRequest/UploadTask abstractions
- Data objects (UploadInfo, UploadStatus, PersistableData)
- Network layer (HttpStack/HurlStack, OkHttpStack, FTPClientWrapper)
- Protocol handlers (binary, multipart)
- Observers (RequestObserver, TaskObserver, NotificationHandler)
- Persistence interfaces (Persistable)
- Extensions, logger, exceptions, placeholders, scheme handlers.

##### README insights
- The core is an Android Service that runs outside the UI thread, accepts Intent‐based UploadRequests, and broadcasts progress via Intents.
- UploadRequests can be serialized for later execution.
- Architecture is fully decoupled from UI; uses Notification Center for progress.
- Supports plugins (new protocols, HTTP stacks, custom notification handlers).

##### Details to capture
- Persistence layer branching off the UploadManager to indicate retry/resume storage.
- NotificationHandler/RequestObserver observers as separate nodes.
- Denote that the Service runs in its own process context attached to the app.
- Sample server endpoints (HTTP upload.php, Node.js index.js) to complete the flow in examples.

## Diagram (Mermaid)

```mermaid
flowchart TB
    classDef ui fill:#f9f,stroke:#333,stroke-width:1px
    classDef service fill:#bbf,stroke:#333,stroke-width:1px
    classDef manager fill:#ccf,stroke:#333,stroke-width:1px
    classDef protocol fill:#bfb,stroke:#333,stroke-width:1px
    classDef network fill:#fbf,stroke:#333,stroke-width:1px
    classDef persistence fill:#ffe,stroke:#333,stroke-width:1px
    classDef observer fill:#fdd,stroke:#333,stroke-width:1px
    classDef external fill:#ddd,stroke:#333,stroke-width:1px
    classDef plugin fill:#dfd,stroke:#333,stroke-width:1px

    subgraph "Client App UI" 
        UI["Activities/Fragments/ViewModels"]:::ui
    end

    subgraph "Service Layer"
        US["UploadService"]:::service
        USC["UploadServiceConfig"]:::service
        UM["UploadManager / Task Scheduler"]:::manager
    end

    subgraph "Protocol Handlers"
        BUR["BinaryUploadRequest"]:::protocol
        BUT["BinaryUploadTask"]:::protocol
        MUR["MultipartUploadRequest"]:::protocol
        MUT["MultipartUploadTask"]:::protocol
        FUR["FTPUploadRequest"]:::plugin
        FUT["FTPUploadTask"]:::plugin
    end

    subgraph "Network Layer"
        HSInt["HttpStack"]:::network
        HurlS["HurlStack"]:::network
        HurlReq["HurlStackRequest"]:::network
        BW["BodyWriter"]:::network
        HBW["HurlBodyWriter"]:::network
        OkS["OkHttpStack"]:::plugin
        OkReq["OkHttpStackRequest"]:::plugin
        OBW["OkHttpBodyWriter"]:::plugin
        FTPW["FTPClientWrapper"]:::plugin
    end

    subgraph "Persistence Layer"
        PD["PersistableData"]:::persistence
        PI["Persistable"]:::persistence
    end

    subgraph "Observer & Notification"
        BE["BroadcastEmitter"]:::observer
        NH["NotificationHandler"]:::observer
        TCN["TaskCompletionNotifier"]:::observer
        RO["RequestObserver"]:::observer
        GRO["GlobalRequestObserver"]:::observer
    end

    subgraph "External Servers"
        HTTP["HTTP Endpoint (upload.php/index.js)"]:::external
        FTP["FTP Server"]:::external
    end

    UI -->|"Intent with UploadRequest"| US
    US --> UM
    UM -->|selects| BUT
    UM -->|selects| MUT
    UM -->|selects| FUT
    BUT --> HSInt
    MUT --> HSInt
    FUT --> FTPW
    HSInt --> HurlS
    HurlS --> HurlReq
    HurlReq --> HTTP
    BW --> HBW
    HSInt --> BW
    HSInt --> HBW
    OkS --> OkReq
    OkReq --> HTTP
    FTPW --> FTP
    UM -->|update/store| PD
    PD --> PI
    US --> BE
    BE --> RO
    BE --> GRO
    RO --> UI
    US --> NH
    NH -->|"Notification Center"| UI

    click US "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/UploadService.kt"
    click USC "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/UploadServiceConfig.kt"
    click UR "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/UploadRequest.kt"
    click UT "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/UploadTask.kt"
    click PD "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/persistence/PersistableData.kt"
    click PI "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/persistence/Persistable.kt"
    click HSInt "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/network/HttpStack.kt"
    click HurlS "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/network/hurl/HurlStack.kt"
    click HurlReq "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/network/hurl/HurlStackRequest.kt"
    click BW "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/network/BodyWriter.kt"
    click HBW "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/network/hurl/HurlBodyWriter.kt"
    click OkS "https://github.com/gotev/android-upload-service/blob/master/uploadservice-okhttp/src/main/java/net/gotev/uploadservice/okhttp/OkHttpStack.kt"
    click OkReq "https://github.com/gotev/android-upload-service/blob/master/uploadservice-okhttp/src/main/java/net/gotev/uploadservice/okhttp/OkHttpStackRequest.kt"
    click OBW "https://github.com/gotev/android-upload-service/blob/master/uploadservice-okhttp/src/main/java/net/gotev/uploadservice/okhttp/OkHttpBodyWriter.kt"
    click FTPW "https://github.com/gotev/android-upload-service/blob/master/uploadservice-ftp/src/main/java/net/gotev/uploadservice/ftp/FTPClientWrapper.kt"
    click BUR "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/protocols/binary/BinaryUploadRequest.kt"
    click BUT "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/protocols/binary/BinaryUploadTask.kt"
    click MUR "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/protocols/multipart/MultipartUploadRequest.kt"
    click MUT "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/protocols/multipart/MultipartUploadTask.kt"
    click FUR "https://github.com/gotev/android-upload-service/blob/master/uploadservice-ftp/src/main/java/net/gotev/uploadservice/ftp/FTPUploadRequest.kt"
    click FUT "https://github.com/gotev/android-upload-service/blob/master/uploadservice-ftp/src/main/java/net/gotev/uploadservice/ftp/FTPUploadTask.kt"
    click BE "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/observer/task/BroadcastEmitter.kt"
    click NH "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/observer/task/NotificationHandler.kt"
    click TCN "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/observer/task/TaskCompletionNotifier.kt"
    click RO "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/observer/request/RequestObserver.kt"
    click GRO "https://github.com/gotev/android-upload-service/blob/master/uploadservice/src/main/java/net/gotev/uploadservice/observer/request/GlobalRequestObserver.kt"
```
