Package com.aspectran.web.support.multipart.inmemory

Class InMemoryFileItem

  • All Implemented Interfaces:
    org.apache.commons.fileupload.FileItem, org.apache.commons.fileupload.FileItemHeadersSupport
    public class InMemoryFileItem
extends java.lang.Object
implements org.apache.commons.fileupload.FileItem, org.apache.commons.fileupload.FileItemHeadersSupport
    The class is an implementation of the FileItem that removed file-related codes to support environments such as GAE where the file system is not available.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_CHARSET
      Default content charset to be used when no explicit charset parameter is provided by the sender.

    • Constructor Summary

      Constructors 
      Constructor Description
      InMemoryFileItem​(java.lang.String fieldName, java.lang.String contentType, boolean isFormField, java.lang.String fileName, int sizeThreshold)
      Constructs a new MemoryFileItem instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()
      Does nothing.
      byte[] get()
      Returns the contents of the file as an array of bytes.
      java.lang.String getCharSet()
      Returns the content charset passed by the agent or null if not defined.
      java.lang.String getContentType()
      Returns the content type passed by the agent or null if not defined.
      java.lang.String getFieldName()
      Returns the name of the field in the multipart form corresponding to this file item.
      org.apache.commons.fileupload.FileItemHeaders getHeaders()
      Returns the file item headers.
      java.io.InputStream getInputStream()
      Returns an InputStream that can be used to retrieve the contents of the file.
      java.lang.String getName()
      Returns the original filename in the client's filesystem.
      java.io.OutputStream getOutputStream()
      Returns an OutputStream of the file.
      long getSize()
      Returns the size of the file.
      java.lang.String getString()
      Returns the contents of the file as a String, using the default character encoding.
      java.lang.String getString​(java.lang.String charset)
      Returns the contents of the file as a String, using the specified encoding.
      boolean isFormField()
      Determines whether or not a FileItem instance represents a simple form field.
      boolean isInMemory()
      Provides a hint as to whether or not the file contents will be read from memory.
      void setFieldName​(java.lang.String fieldName)
      Sets the field name used to reference this file item.
      void setFormField​(boolean state)
      Specifies whether or not a FileItem instance represents a simple form field.
      void setHeaders​(org.apache.commons.fileupload.FileItemHeaders pHeaders)
      Sets the file item headers.
      java.lang.String toString()
      Returns a string representation of this object.
      void write​(java.io.File file)
      A convenience method to write an uploaded item to disk.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_CHARSET

        public static final java.lang.String DEFAULT_CHARSET
        Default content charset to be used when no explicit charset parameter is provided by the sender. Media subtypes of the "text" type are defined to have a default charset value of "ISO-8859-1" when received via HTTP.
        See Also:
        Constant Field Values

    • Constructor Detail

      • InMemoryFileItem

        public InMemoryFileItem​(java.lang.String fieldName,
                        java.lang.String contentType,
                        boolean isFormField,
                        java.lang.String fileName,
                        int sizeThreshold)
        Constructs a new MemoryFileItem instance.
        Parameters:
        fieldName - the name of the form field
        contentType - the content type passed by the browser or null if not specified
        isFormField - whether or not this item is a plain form field, as opposed to a file upload
        fileName - the original filename in the user's filesystem, or null if not specified
        sizeThreshold - the threshold, in bytes, below which items will be retained in memory. (sizeThreshold will always be equal to file upload limit)

    • Method Detail

      • getInputStream

        public java.io.InputStream getInputStream()
                                   throws java.io.IOException
        Returns an InputStream that can be used to retrieve the contents of the file.
        Specified by:
        getInputStream in interface org.apache.commons.fileupload.FileItem
        Returns:
        an InputStream that can be used to retrieve the contents of the file
        Throws:
        java.io.IOException - if an error occurs

      • getContentType

        public java.lang.String getContentType()
        Returns the content type passed by the agent or null if not defined.
        Specified by:
        getContentType in interface org.apache.commons.fileupload.FileItem
        Returns:
        the content type passed by the agent or null if not defined

      • getCharSet

        public java.lang.String getCharSet()
        Returns the content charset passed by the agent or null if not defined.
        Returns:
        the content charset passed by the agent or null if not defined

      • getName

        public java.lang.String getName()
        Returns the original filename in the client's filesystem.
        Specified by:
        getName in interface org.apache.commons.fileupload.FileItem
        Returns:
        the original filename in the client's filesystem

      • isInMemory

        public boolean isInMemory()
        Provides a hint as to whether or not the file contents will be read from memory.
        Specified by:
        isInMemory in interface org.apache.commons.fileupload.FileItem
        Returns:
        true if the file contents will be read from memory; false otherwise

      • getSize

        public long getSize()
        Returns the size of the file.
        Specified by:
        getSize in interface org.apache.commons.fileupload.FileItem
        Returns:
        the size of the file, in bytes

      • get

        public byte[] get()
        Returns the contents of the file as an array of bytes.
        Specified by:
        get in interface org.apache.commons.fileupload.FileItem
        Returns:
        the contents of the file as an array of bytes

      • getString

        public java.lang.String getString​(java.lang.String charset)
                           throws java.io.UnsupportedEncodingException
        Returns the contents of the file as a String, using the specified encoding. This method uses get() to retrieve the contents of the file.
        Specified by:
        getString in interface org.apache.commons.fileupload.FileItem
        Parameters:
        charset - the charset to use
        Returns:
        the contents of the file, as a string
        Throws:
        java.io.UnsupportedEncodingException - if the requested character encoding is not available

      • getString

        public java.lang.String getString()
        Returns the contents of the file as a String, using the default character encoding. This method uses get() to retrieve the contents of the file.
        Specified by:
        getString in interface org.apache.commons.fileupload.FileItem
        Returns:
        the contents of the file, as a string

      • write

        public void write​(java.io.File file)
           throws java.lang.Exception
        A convenience method to write an uploaded item to disk. The client code is not concerned with whether or not the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item to a file.

        This implementation first attempts to rename the uploaded item to the specified destination file, if the item was originally written to disk. Otherwise, the data will be copied to the specified file.

        This method is only guaranteed to work once, the first time it is invoked for a particular item. This is because, in the event that the method renames a temporary file, that file will no longer be available to copy or rename again at a later time.

        Specified by:
        write in interface org.apache.commons.fileupload.FileItem
        Parameters:
        file - the File into which the uploaded item should be stored
        Throws:
        java.lang.Exception - if an error occurs

      • delete

        public void delete()
        Does nothing.
        Specified by:
        delete in interface org.apache.commons.fileupload.FileItem

      • getFieldName

        public java.lang.String getFieldName()
        Returns the name of the field in the multipart form corresponding to this file item.
        Specified by:
        getFieldName in interface org.apache.commons.fileupload.FileItem
        Returns:
        the name of the form field
        See Also:
        setFieldName(java.lang.String)

      • setFieldName

        public void setFieldName​(java.lang.String fieldName)
        Sets the field name used to reference this file item.
        Specified by:
        setFieldName in interface org.apache.commons.fileupload.FileItem
        Parameters:
        fieldName - the name of the form field
        See Also:
        getFieldName()

      • isFormField

        public boolean isFormField()
        Determines whether or not a FileItem instance represents a simple form field.
        Specified by:
        isFormField in interface org.apache.commons.fileupload.FileItem
        Returns:
        true if the instance represents a simple form field; false if it represents an uploaded file.
        See Also:
        setFormField(boolean)

      • setFormField

        public void setFormField​(boolean state)
        Specifies whether or not a FileItem instance represents a simple form field.
        Specified by:
        setFormField in interface org.apache.commons.fileupload.FileItem
        Parameters:
        state - true if the instance represents a simple form field; false if it represents an uploaded file
        See Also:
        isFormField()

      • getOutputStream

        public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
        Returns an OutputStream of the file.
        Specified by:
        getOutputStream in interface org.apache.commons.fileupload.FileItem
        Returns:
        an OutputStream of the file
        Throws:
        java.io.IOException - if an error occurs

      • toString

        public java.lang.String toString()
        Returns a string representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this object

      • getHeaders

        public org.apache.commons.fileupload.FileItemHeaders getHeaders()
        Returns the file item headers.
        Specified by:
        getHeaders in interface org.apache.commons.fileupload.FileItemHeadersSupport
        Returns:
        the file items headers

      • setHeaders

        public void setHeaders​(org.apache.commons.fileupload.FileItemHeaders pHeaders)
        Sets the file item headers.
        Specified by:
        setHeaders in interface org.apache.commons.fileupload.FileItemHeadersSupport
        Parameters:
        pHeaders - the file items headers