Brotli4j

When using the shadow plugin, you can configure a custom configuration (e.g., shaded) to include natives for all architectures in the resulting shaded JAR. This prevents the distribution from only containing the natives for the architecture it was compiled on.

// Example for Gradle Kotlin DSL (Subproject-specific)
val shaded by configurations.registering {
    extendsFrom(configurations.runtimeClasspath)

    isCanBeConsumed = false
    isCanBeResolved = true
    isCanBeDeclared = true

    attributes {
        attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.LIBRARY))
        attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named(LibraryElements.JAR))

        attribute(OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, objects.named("all"))
        attribute(MachineArchitecture.ARCHITECTURE_ATTRIBUTE, objects.named("all"))
    }
}

dependencies {
    shaded("com.aayushatharva.brotli4j:natives:1.23.0")
}

tasks {
    shadowJar.configure {
        // shadow 8.x
        configurations = listOf(project.configurations.shaded).map { it.get() }
        // shadow 9.x
        configurations.add(project.configurations.shaded)
    }
}

The brotli command-line tool provides three operation modes: compression (default), decompression (--decompress), and integrity testing (--test).

Operation Modes

• Compression: The default mode. It appends a suffix (default .br) to the source filename.
• Decompression: Activated with --decompress or -d. It removes the suffix from the source filename.
• Integrity Test: Activated with --test or -t. This is equivalent to --decompress --stdout, but the decompressed data is discarded instead of being written to standard output.

Shortcuts

• unbrotli is a shortcut for brotli --decompress.
• brcat is a shortcut for brotli --decompress --concatenated --stdout.

Input and Output

• If no files are provided, or if the file argument is -, brotli reads from standard input.
• To write to standard output, use the --stdout or -c option.
• To specify a specific output filename, use --output=FILE or -o FILE (only valid if there is a single input entry).
• By default, source files are preserved. Use --rm or -j to remove source files after processing.

# Compress a file
brotli input.txt

# Decompress a file
brotli --decompress input.txt.br

# Decompress and write to stdout
brotli -d -c input.txt.br > output.txt

# Compress with a specific quality level (0-11)
brotli -q 9 input.txt

# Test file integrity
brotli --test input.txt.br

If you are using multiple Brotli4j artifacts (e.g., pinning a specific native runtime), use the Brotli4j Bill of Materials (BOM) to ensure all dependencies use a consistent version. When using the BOM, declare Brotli4j artifacts without an explicit <version> tag.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.aayushatharva.brotli4j</groupId>
            <artifactId>brotli4j-bom</artifactId>
            <version>1.23.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.aayushatharva.brotli4j</groupId>
        <artifactId>brotli4j</artifactId>
    </dependency>
    <!-- Optional: pin a specific runtime native (version managed by the BOM) -->
    <dependency>
        <groupId>com.aayushatharva.brotli4j</groupId>
        <artifactId>native-linux-x86_64</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

You can use the provided docker-compose.yml to set up a consistent development and build environment. The configuration defines several services that share a common base configuration.

Services

• runtime-setup: An initialization service used to prepare the environment. It builds from Dockerfile.centos6.
• build: A service designed to run the Maven build process. It executes mvn -B -ntp clean package --file pom.xml inside the container.
• shell: An interactive service that provides a /bin/bash entrypoint, allowing you to run commands manually within the environment.

Common Configuration

All functional services (build and shell) use a common configuration template that includes:

• Dependencies: They depend on the runtime-setup service being ready.
• Volume Mounts:
  • ~/.m2:/root/.m2: Mounts your local Maven repository to the container to persist dependencies and speed up builds.
  • ..:/code: Mounts the project root into the /code working directory.
• Working Directory: Set to /code.

version: "3"

services:
runtime-setup:
    image: brotli4j:default
    build:
      context: .
      dockerfile: Dockerfile.centos6

common: &common
    image: brotli4j:default
    depends_on: [ runtime-setup ]
    volumes:
      - ~/.m2:/root/.m2
      - ..:/code
    working_dir: /code

build:
    <<: *common
    command: /bin/bash -cl "mvn -B -ntp clean package --file pom.xml"

shell:
    <<: *common
    entrypoint: /bin/bash