Package org.apache.tomcat.util.http.fileupload

Interface FileItemStream

  • All Superinterfaces:
    FileItemHeadersSupport
    All Known Implementing Classes:
    FileItemStreamImpl
    public interface FileItemStream
extends FileItemHeadersSupport

    This interface provides access to a file or form item that was received within a multipart/form-data POST request. The items contents are retrieved by calling openStream().

    Instances of this class are created by accessing the iterator, returned by FileUploadBase.getItemIterator(RequestContext).

    Note: There is an interaction between the iterator and its associated instances of FileItemStream: By invoking Iterator.hasNext() on the iterator, you discard all data, which hasn't been read so far from the previous data.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  FileItemStream.ItemSkippedException
      This exception is thrown, if an attempt is made to read data from the InputStream, which has been returned by openStream(), after Iterator.hasNext() has been invoked on the iterator, which created the FileItemStream.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getContentType()
      Returns the content type passed by the browser or null if not defined.
      java.lang.String getFieldName()
      Returns the name of the field in the multipart form corresponding to this file item.
      java.lang.String getName()
      Returns the original file name in the client's file system, as provided by the browser (or other client software).
      boolean isFormField()
      Determines whether or not a FileItem instance represents a simple form field.
      java.io.InputStream openStream()
      Creates an InputStream, which allows to read the items contents.

    • Method Detail

      • openStream

        java.io.InputStream openStream()
                        throws java.io.IOException
        Creates an InputStream, which allows to read the items contents.
        Returns:
        The input stream, from which the items data may be read.
        Throws:
        java.lang.IllegalStateException - The method was already invoked on this item. It is not possible to recreate the data stream.
        java.io.IOException - An I/O error occurred.
        See Also:
        FileItemStream.ItemSkippedException

      • getContentType

        java.lang.String getContentType()
        Returns the content type passed by the browser or null if not defined.
        Returns:
        The content type passed by the browser or null if not defined.

      • getName

        java.lang.String getName()
        Returns the original file name in the client's file system, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.
        Returns:
        The original file name in the client's file system.

      • getFieldName

        java.lang.String getFieldName()
        Returns the name of the field in the multipart form corresponding to this file item.
        Returns:
        The name of the form field.

      • isFormField

        boolean isFormField()
        Determines whether or not a FileItem instance represents a simple form field.
        Returns:
        true if the instance represents a simple form field; false if it represents an uploaded file.