Add header params to MultipartFormDataOutput and FileUpload

[comrt]

Description

Quarkus supports MultipartFormDataOutput in Resteasy and in REST-Reactive as well.
Both APIs are very similar, but lack the Option to add HTTP-Header params in the addFormData-Method.
Adding extra http-headers to an input-part is quite useful for adding metadata to binary data.

What you can do of course is the following:

formDataOutput.getAllFormData().get("documents").get(i).getHeaders().add("Content-ID", file.tagName());

But this is pretty unconvenient. Therefore it would be nicer to to add params directly.

The same goes with REST-Reactives FileUpload/FilePart interface as it has no method to get Headers for an input-part.

Implementation ideas

No response

[quarkus-bot]

/cc @FroMage (rest)

[geoand]

Thanks for reporting. I totally agree that the current API is not very nice. Do you have an API in mind for this?

[comrt]

For REST-Reactive it could look so

package org.jboss.resteasy.reactive.server.multipart;

import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;

import org.jboss.resteasy.reactive.common.util.QuarkusMultivaluedHashMap;

public final class PartItem {
    private final MultivaluedMap<String, Object> headers;
    private final Object entity;
    private final String genericType;
    private final MediaType mediaType;
    private final String filename;

    //...

    public PartItem(Object entity, String genericType, MediaType mediaType, String filename, QuarkusMultivaluedHashMap headers)       {
        this.headers = headers;
        this.entity = entity;
        this.genericType = genericType;
        this.mediaType = mediaType;
        this.filename = filename;
    }

package org.jboss.resteasy.reactive.server.multipart;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import jakarta.ws.rs.core.MediaType;


public final class MultipartFormDataOutput {
    private final Map<String, List<PartItem>> parts = new LinkedHashMap<>();

    //...

    public PartItem addFormData(String key, Object entity, String genericType, MediaType mediaType) {
        PartItem part = new PartItem(entity, genericType, mediaType);
        return addFormData(key, part);
    }

    public PartItem addFormData(String key, Object entity, MediaType mediaType, String filename, QuarkusMultivaluedHashMap headers) {
        PartItem part = new PartItem(entity, null, mediaType, filename, headers);
        return addFormData(key, part);
    }

For FileUpload Filepart.java interface could add the headers-method which gets delegated to org.jboss.resteasy.reactive.server.multipart.FormValue#getHeaders() in the implementation,

package org.jboss.resteasy.reactive.multipart;

import java.nio.file.Path;

public interface FilePart {

    String name();

    Path filePath();
  
    String fileName();

    long size();

    String contentType();
   
    String charSet();

    MultivaluedMap<String, String> getHeaders()
}

[geoand]

Right, that's the simplest thing to do for sure and I'm inclined to say go for it, but let's see if @FroMage has something else to propose.

[FroMage]

This looks like a good idea indeed. Just make sure we don't break users and add an overloaded method instead of changing the signature of addFormData. Also, not sure why we should take a QuarkusMultivaluedHashMap instead of a MultivaluedMap.

[geoand]

@comrt do you want to go ahead a propose Pull Request containing the necessary changes?

[comrt]

Yes, i can do that later.

[geoand]

🙏🏽