com.vtence.molecule.BodyPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molecule Show documentation
A web micro-framework for Java
There is a newer version: 0.15.0
package com.vtence.molecule;

import com.vtence.molecule.helpers.Streams;
import com.vtence.molecule.http.ContentType;
import com.vtence.molecule.lib.EmptyInputStream;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

/**
 * Represents a body part or form item that was received within a multipart/form-data POST request.
 * 

 * Typically a part represents either a text parameter or a file.
 * The contents of the part can be acquired either as an InputStream, a byte array or as a
 * string encoded in the encoding specified with the Content-Type header or in UTF-8.
 */
public class BodyPart {
    private String name;
    private String filename;
    private String contentType;
    private InputStream input = new EmptyInputStream();

    /**
     * Sets the name of this part.
     *
     * @param name the new part name
     */
    public BodyPart name(String name) {
        this.name = name;
        return this;
    }

    /**
     * Gets the name of this part. Typically this is used when the part represents a text parameter rather
     * than a file. However, file parts can also have a name.
     *
     * @return the part name or null if this part has no associated name
     */
    public String name() {
        return name;
    }

    /**
     * Sets the file name of this part.
     *
     * @param filename the new file name
     */
    public BodyPart filename(String filename) {
        this.filename = filename;
        return this;
    }

    /**
     * Gets the file name of this part. Typically this is used when the part represents a file.
     *
     * @return the file name of the part or null if this part has no associated file name
     */
    public String filename() {
        return filename;
    }

    /**
     * Sets the content type of this part.
     *
     * @param contentType the new content type
     */
    public BodyPart contentType(String contentType) {
        this.contentType = contentType;
        return this;
    }

    /**
     * Gets the content type of this part.
     *
     * @return the part content type or null if the part has no associated content type
     */
    public String contentType() {
        return contentType;
    }

    /**
     * Consumes the content of this part and returns it as a string.

     * The encoding of the string is taken from the content type.
     * If no content type is sent the content is decoded in UTF-8.
     *
     * @return the text representation of the content
     * @throws IOException thrown if the content cannot be accessed
     */
    public String value() throws IOException {
        return new String(content(), charset());
    }

    /**
     * Consumes the content of this part and returns it as a byte array. 

     *
     * @return the binary representation of the part
     * @throws IOException thrown if the content can not be accessed
     */
    public byte[] content() throws IOException {
        return Streams.consume(stream());
    }

    /**
     * Accesses the content of the part as an input stream.
     *
     * @return an input stream giving access to the part content
     * @throws IOException thrown if the content cannot be accessed
     */
    public InputStream stream() throws IOException {
        return input;
    }

    /**
     * Changes the content of this body part. The body is encoded using the charset of the part, or UTF-8 by default.
     *
     * @param content the new content as a string
     */
    public BodyPart content(String content) {
        return content(content.getBytes(charset()));
    }

    /**
     * Changes the content of this body part.
     *
     * @param content the new content as an array of bytes
     */
    public BodyPart content(byte[] content) {
        this.input = new ByteArrayInputStream(content);
        return this;
    }

    /**
     * Changes the content of this body part.
     *
     * @param content the new content as a stream of bytes
     */
    public BodyPart content(InputStream content) {
        this.input = content;
        return this;
    }

    private Charset charset() {
        if (contentType == null) return StandardCharsets.UTF_8;
        return ContentType.parse(contentType).charset(StandardCharsets.UTF_8);
    }
}