com.fujieid.jap.http.JapPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jap-http Show documentation
jap-http servlet interface
There is a newer version: 2.0.5
package com.fujieid.jap.http;

import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;

/**
 *  This class represents a part or form item that was received within a
 * multipart/form-data POST request.
 * 
 * @since Servlet 3.0
 */
public interface JapPart {

    /**
     * Gets the content of this part as an InputStream
     * 
     * @return The content of this part as an InputStream
     * @throws IOException If an error occurs in retrieving the contet
     * as an InputStream
     */
    public InputStream getInputStream() throws IOException;

    /**
     * Gets the content type of this part.
     *
     * @return The content type of this part.
     */
    public String getContentType();

    /**
     * Gets the name of this part
     *
     * @return The name of this part as a String
     */
    public String getName();

    /**
     * Returns the size of this fille.
     *
     * @return a long specifying the size of this part, in bytes.
     */
    public long getSize();

    /**
     * A convenience method to write this uploaded item to disk.
     * 
     * 
This method is not guaranteed to succeed if called more than once for
     * the same part. This allows a particular implementation to use, for
     * example, file renaming, where possible, rather than copying all of the
     * underlying data, thus gaining a significant performance benefit.
     *
     * @param fileName the name of the file to which the stream will be
     * written. The file is created relative to the location as
     * specified in the MultipartConfig
     *
     * @throws IOException if an error occurs.
     */
    public void write(String fileName) throws IOException;

    /**
     * Deletes the underlying storage for a file item, including deleting any
     * associated temporary disk file.
     *
     * @throws IOException if an error occurs.
     */
    public void delete() throws IOException;

    /**
     *
     * Returns the value of the specified mime header
     * as a String. If the Part did not include a header
     * of the specified name, this method returns null.
     * If there are multiple headers with the same name, this method
     * returns the first header in the part.
     * The header name is case insensitive. You can use
     * this method with any request header.
     *
     * @param name		a String specifying the
     *				header name
     *
     * @return			a String containing the
     *				value of the requested
     *				header, or null
     *				if the part does not
     *				have a header of that name
     */
    public String getHeader(String name);

    /**
     * Gets the values of the Part header with the given name.
     *
     * 
Any changes to the returned Collection must not 
     * affect this Part.
     *
     * 
Part header names are case insensitive.
     *
     * @param name the header name whose values to return
     *
     * @return a (possibly empty) Collection of the values of
     * the header with the given name
     */
    public Collection getHeaders(String name);

    /**
     * Gets the header names of this Part.
     *
     * 
Some servlet containers do not allow
     * servlets to access headers using this method, in
     * which case this method returns null
     *
     * Any changes to the returned Collection must not 
     * affect this Part.
     *
     * @return a (possibly empty) Collection of the header
     * names of this Part
     */
    public Collection getHeaderNames();

}