Package org.eclipse.jetty.http

Class MultiPartFormInputStream.MultiPart

  • All Implemented Interfaces:
    Part
    Enclosing class:
    MultiPartFormInputStream
    public class MultiPartFormInputStream.MultiPart
extends java.lang.Object
implements Part

    • Constructor Summary

      Constructors 
      Constructor Description
      MultiPart​(java.lang.String name, java.lang.String filename)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanUp()
      Only remove tmp files.
      void delete()
      Remove the file, whether or not Part.write() was called on it (ie no longer temporary)
      byte[] getBytes()  
      java.lang.String getContentDispositionFilename()
      Get the filename from the content-disposition.
      java.lang.String getContentType()
      Obtain the content type passed by the browser or null if not defined.
      java.io.File getFile()
      Get the file
      java.lang.String getHeader​(java.lang.String name)
      Obtains the value of the specified part header as a String.
      java.util.Collection<java.lang.String> getHeaderNames()
      Returns a Collection of all the header names provided for this part.
      java.util.Collection<java.lang.String> getHeaders​(java.lang.String name)
      Obtain all the values of the specified part header.
      java.io.InputStream getInputStream()
      Obtain an InputStream that can be used to retrieve the contents of the file.
      java.lang.String getName()
      Obtain the name of the field in the multipart form corresponding to this part.
      long getSize()
      Obtain the size of this part.
      java.lang.String getSubmittedFileName()
      If this part represents an uploaded file, gets the file name submitted in the upload.
      java.lang.String toString()  
      void write​(java.lang.String fileName)
      A convenience method to write an uploaded part to disk.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • MultiPart

        public MultiPart​(java.lang.String name,
                 java.lang.String filename)

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: Part
        Obtain the content type passed by the browser or null if not defined.
        Specified by:
        getContentType in interface Part

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Description copied from interface: Part
        Obtains the value of the specified part header as a String. If there are multiple headers with the same name, this method returns the first header in the part. The header name is case insensitive.
        Specified by:
        getHeader in interface Part
        Parameters:
        name - Header name
        Returns:
        The header value or null if the header is not present

      • getHeaderNames

        public java.util.Collection<java.lang.String> getHeaderNames()
        Description copied from interface: Part
        Returns a Collection of all the header names provided for this part.
        Specified by:
        getHeaderNames in interface Part

      • getHeaders

        public java.util.Collection<java.lang.String> getHeaders​(java.lang.String name)
        Description copied from interface: Part
        Obtain all the values of the specified part header. If the part did not include any headers of the specified name, this method returns an empty Collection. The header name is case insensitive.
        Specified by:
        getHeaders in interface Part

      • getInputStream

        public java.io.InputStream getInputStream()
                                   throws java.io.IOException
        Description copied from interface: Part
        Obtain an InputStream that can be used to retrieve the contents of the file.
        Specified by:
        getInputStream in interface Part
        Throws:
        java.io.IOException

      • getSubmittedFileName

        public java.lang.String getSubmittedFileName()
        Description copied from interface: Part
        If this part represents an uploaded file, gets the file name submitted in the upload. Returns null if no file name is available or if this part is not a file upload.
        Specified by:
        getSubmittedFileName in interface Part
        Returns:
        the submitted file name or null.

      • getBytes

        public byte[] getBytes()

      • getName

        public java.lang.String getName()
        Description copied from interface: Part
        Obtain the name of the field in the multipart form corresponding to this part.
        Specified by:
        getName in interface Part

      • getSize

        public long getSize()
        Description copied from interface: Part
        Obtain the size of this part.
        Specified by:
        getSize in interface Part

      • write

        public void write​(java.lang.String fileName)
           throws java.io.IOException
        Description copied from interface: Part
        A convenience method to write an uploaded part to disk. The client code is not concerned with whether or not the part is stored in memory, or on disk in a temporary location. They just want to write the uploaded part to a file. 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.
        Specified by:
        write in interface Part
        Parameters:
        fileName - The location into which the uploaded part should be stored. Relative locations are relative to MultipartConfigElement.getLocation()
        Throws:
        java.io.IOException

      • delete

        public void delete()
            throws java.io.IOException
        Remove the file, whether or not Part.write() was called on it (ie no longer temporary)
        Specified by:
        delete in interface Part
        Throws:
        java.io.IOException

      • cleanUp

        public void cleanUp()
             throws java.io.IOException
        Only remove tmp files.
        Throws:
        java.io.IOException - if unable to delete the file

      • getFile

        public java.io.File getFile()
        Get the file
        Returns:
        the file, if any, the data has been written to.

      • getContentDispositionFilename

        public java.lang.String getContentDispositionFilename()
        Get the filename from the content-disposition.
        Returns:
        null or the filename