Package org.jboss.netty.handler.codec.http.multipart

Class MixedFileUpload

    • Constructor Summary

      Constructors 
      Constructor Description
      MixedFileUpload​(java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.Charset charset, long size, long limitSize)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addContent​(ChannelBuffer buffer, boolean last)
      Add the content from the ChannelBuffer
      void checkSize​(long newSize)
      Check if the new size is not reaching the max limit allowed.
      int compareTo​(InterfaceHttpData o)  
      void delete()
      Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
      byte[] get()
      Returns the contents of the file item as an array of bytes.
      ChannelBuffer getChannelBuffer()
      Returns the content of the file item as a ChannelBuffer
      java.nio.charset.Charset getCharset()
      Returns the Charset passed by the browser or null if not defined.
      ChannelBuffer getChunk​(int length)
      Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.
      java.lang.String getContentTransferEncoding()
      Returns the Content-Transfer-Encoding
      java.lang.String getContentType()
      Returns the content type passed by the browser or null if not defined.
      java.io.File getFile()  
      java.lang.String getFilename()
      Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
      InterfaceHttpData.HttpDataType getHttpDataType()  
      java.lang.String getName()
      Returns the name of this InterfaceHttpData.
      java.lang.String getString()
      Returns the contents of the file item as a String, using the default character encoding.
      java.lang.String getString​(java.nio.charset.Charset encoding)
      Returns the contents of the file item as a String, using the specified charset.
      boolean isCompleted()  
      boolean isInMemory()
      Provides a hint as to whether or not the file contents will be read from memory.
      long length()
      Returns the size in byte of the InterfaceHttpData
      boolean renameTo​(java.io.File dest)
      A convenience method to write an uploaded item to disk.
      void setCharset​(java.nio.charset.Charset charset)
      Set the Charset passed by the browser if defined
      void setContent​(java.io.File file)
      Set the content from the file (erase any previous data)
      void setContent​(java.io.InputStream inputStream)
      Set the content from the inputStream (erase any previous data)
      void setContent​(ChannelBuffer buffer)
      Set the content from the ChannelBuffer (erase any previous data)
      void setContentTransferEncoding​(java.lang.String contentTransferEncoding)
      Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
      void setContentType​(java.lang.String contentType)
      Set the Content Type passed by the browser if defined
      void setFilename​(java.lang.String filename)
      Set the original filename
      void setMaxSize​(long maxSize)
      Set the maxSize for this HttpData.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • limitSize

        private final long limitSize

      • definedSize

        private final long definedSize

      • maxSize

        protected long maxSize

    • Constructor Detail

      • MixedFileUpload

        public MixedFileUpload​(java.lang.String name,
                       java.lang.String filename,
                       java.lang.String contentType,
                       java.lang.String contentTransferEncoding,
                       java.nio.charset.Charset charset,
                       long size,
                       long limitSize)

    • Method Detail

      • setMaxSize

        public void setMaxSize​(long maxSize)
        Description copied from interface: HttpData
        Set the maxSize for this HttpData. When limit will be reached, an exception will be raised. Setting it to (-1) means no limitation. By default, to be set from the HttpDataFactory.
        Specified by:
        setMaxSize in interface HttpData

      • checkSize

        public void checkSize​(long newSize)
               throws java.io.IOException
        Description copied from interface: HttpData
        Check if the new size is not reaching the max limit allowed. The limit is always computed in term of bytes.
        Specified by:
        checkSize in interface HttpData
        Throws:
        java.io.IOException

      • addContent

        public void addContent​(ChannelBuffer buffer,
                       boolean last)
                throws java.io.IOException
        Description copied from interface: HttpData
        Add the content from the ChannelBuffer
        Specified by:
        addContent in interface HttpData
        Parameters:
        buffer - must be not null except if last is set to False
        last - True of the buffer is the last one
        Throws:
        java.io.IOException

      • delete

        public void delete()
        Description copied from interface: HttpData
        Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
        Specified by:
        delete in interface HttpData

      • get

        public byte[] get()
           throws java.io.IOException
        Description copied from interface: HttpData
        Returns the contents of the file item as an array of bytes.
        Specified by:
        get in interface HttpData
        Returns:
        the contents of the file item as an array of bytes.
        Throws:
        java.io.IOException

      • getChannelBuffer

        public ChannelBuffer getChannelBuffer()
                               throws java.io.IOException
        Description copied from interface: HttpData
        Returns the content of the file item as a ChannelBuffer
        Specified by:
        getChannelBuffer in interface HttpData
        Returns:
        the content of the file item as a ChannelBuffer
        Throws:
        java.io.IOException

      • getCharset

        public java.nio.charset.Charset getCharset()
        Description copied from interface: HttpData
        Returns the Charset passed by the browser or null if not defined.
        Specified by:
        getCharset in interface HttpData
        Returns:
        the Charset passed by the browser or null if not defined.

      • getContentType

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

      • getContentTransferEncoding

        public java.lang.String getContentTransferEncoding()
        Description copied from interface: FileUpload
        Returns the Content-Transfer-Encoding
        Specified by:
        getContentTransferEncoding in interface FileUpload
        Returns:
        the Content-Transfer-Encoding

      • getFilename

        public java.lang.String getFilename()
        Description copied from interface: FileUpload
        Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
        Specified by:
        getFilename in interface FileUpload
        Returns:
        the original filename

      • getString

        public java.lang.String getString()
                           throws java.io.IOException
        Description copied from interface: HttpData
        Returns the contents of the file item as a String, using the default character encoding.
        Specified by:
        getString in interface HttpData
        Returns:
        the contents of the file item as a String, using the default character encoding.
        Throws:
        java.io.IOException

      • getString

        public java.lang.String getString​(java.nio.charset.Charset encoding)
                           throws java.io.IOException
        Description copied from interface: HttpData
        Returns the contents of the file item as a String, using the specified charset.
        Specified by:
        getString in interface HttpData
        Parameters:
        encoding - the charset to use
        Returns:
        the contents of the file item as a String, using the specified charset.
        Throws:
        java.io.IOException

      • isCompleted

        public boolean isCompleted()
        Specified by:
        isCompleted in interface HttpData
        Returns:
        True if the InterfaceHttpData is completed (all data are stored)

      • isInMemory

        public boolean isInMemory()
        Description copied from interface: HttpData
        Provides a hint as to whether or not the file contents will be read from memory.
        Specified by:
        isInMemory in interface HttpData
        Returns:
        True if the file contents is in memory.

      • length

        public long length()
        Description copied from interface: HttpData
        Returns the size in byte of the InterfaceHttpData
        Specified by:
        length in interface HttpData
        Returns:
        the size of the InterfaceHttpData

      • renameTo

        public boolean renameTo​(java.io.File dest)
                 throws java.io.IOException
        Description copied from interface: HttpData
        A convenience method to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this method is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.
        Specified by:
        renameTo in interface HttpData
        Parameters:
        dest - destination file - must be not null
        Returns:
        True if the write is successful
        Throws:
        java.io.IOException

      • setCharset

        public void setCharset​(java.nio.charset.Charset charset)
        Description copied from interface: HttpData
        Set the Charset passed by the browser if defined
        Specified by:
        setCharset in interface HttpData
        Parameters:
        charset - Charset to set - must be not null

      • setContent

        public void setContent​(ChannelBuffer buffer)
                throws java.io.IOException
        Description copied from interface: HttpData
        Set the content from the ChannelBuffer (erase any previous data)
        Specified by:
        setContent in interface HttpData
        Parameters:
        buffer - must be not null
        Throws:
        java.io.IOException

      • setContent

        public void setContent​(java.io.File file)
                throws java.io.IOException
        Description copied from interface: HttpData
        Set the content from the file (erase any previous data)
        Specified by:
        setContent in interface HttpData
        Parameters:
        file - must be not null
        Throws:
        java.io.IOException

      • setContent

        public void setContent​(java.io.InputStream inputStream)
                throws java.io.IOException
        Description copied from interface: HttpData
        Set the content from the inputStream (erase any previous data)
        Specified by:
        setContent in interface HttpData
        Parameters:
        inputStream - must be not null
        Throws:
        java.io.IOException

      • setContentType

        public void setContentType​(java.lang.String contentType)
        Description copied from interface: FileUpload
        Set the Content Type passed by the browser if defined
        Specified by:
        setContentType in interface FileUpload
        Parameters:
        contentType - Content Type to set - must be not null

      • setContentTransferEncoding

        public void setContentTransferEncoding​(java.lang.String contentTransferEncoding)
        Description copied from interface: FileUpload
        Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
        Specified by:
        setContentTransferEncoding in interface FileUpload

      • setFilename

        public void setFilename​(java.lang.String filename)
        Description copied from interface: FileUpload
        Set the original filename
        Specified by:
        setFilename in interface FileUpload

      • toString

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

      • getChunk

        public ChannelBuffer getChunk​(int length)
                       throws java.io.IOException
        Description copied from interface: HttpData
        Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read. Once it arrives at the end, it returns an EMPTY_BUFFER and it resets the current position to 0.
        Specified by:
        getChunk in interface HttpData
        Returns:
        a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
        Throws:
        java.io.IOException

      • getFile

        public java.io.File getFile()
                     throws java.io.IOException
        Specified by:
        getFile in interface HttpData
        Returns:
        the associated File if this data is represented in a file
        Throws:
        java.io.IOException - if this data is not represented by a file