net.dongliu.cute.http.body.Parts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xhttp Show documentation
The newest version!
package net.dongliu.cute.http.body;

import net.dongliu.cute.http.ContentType;
import net.dongliu.cute.http.MimeType;

import java.nio.file.Path;

/**
 * Utils for create {@link Part}
 */
public class Parts {
    /**
     * Create a file multi-part form field. The Text Part just as html input field:
     *      *   <input type="file" name="the_name">
     * 
     *
     * @param name     the part name
     * @param path     the file path
     * @param mimeType the mimeType
     */
    public static Part file(String name, Path path, MimeType mimeType) {
        return new Part.FilePart(name, path.toString(), InputSuppliers.of(path), ContentType.of(mimeType));
    }

    /**
     * Create a file multi-part form field. The Text Part just as html input field:
     *      *   <input type="file" name="the_name">
     * 
     * The mime-type will be detected from file name extension. If detect failed, use {@link MimeType#OCTET_STREAM}
     *
     * @param name the part name
     * @param path the file path
     */
    public static Part file(String name, Path path) {
        var mimeType = FileTypes.detectFileType(path).orElse(MimeType.OCTET_STREAM);
        return file(name, path, mimeType);
    }

    /**
     * Create a file multi-part form field. The Text Part just as html
     *      *   <input type="file" name="the_name">
     * 
     * do.
     *
     * @param name     the part name
     * @param filename the filename, can be empty
     * @param supplier the file content provider
     * @param mimeType the mimeType
     */
    public static Part file(String name, String filename, InputSupplier supplier, MimeType mimeType) {
        return new Part.FilePart(name, filename, supplier, ContentType.of(mimeType));
    }

    /**
     * Create a file multi-part form field. The Text Part just as html
     *      *   <input type="file" name="the_name">
     * 
     * do.
     *
     * @param name     the part name
     * @param filename the filename, can be empty
     * @param bytes    the file content
     * @param mimeType the mimeType
     */
    public static Part file(String name, String filename, byte[] bytes, MimeType mimeType) {
        return new Part.FilePart(name, filename, InputSuppliers.of(bytes), ContentType.of(mimeType));
    }

    /**
     * Create a text multi-part form field. The Text Part just as html
     *      *       <input type="text" name="the_name" value="the_value">
     * 
     * do.
     */
    public static Part text(String name, String value) {
        return new Part.TextPart(name, value);
    }
}