org.springframework.mock.web

Class MockPart

  • java.lang.Object
    • org.springframework.mock.web.MockPart
    • Constructor Summary

      Constructors 
      Constructor and Description
      MockPart(java.lang.String name, byte[] content)
      Constructor for a part with byte[] content only.
      MockPart(java.lang.String name, java.lang.String filename, byte[] content)
      Constructor for a part with a filename and byte[] content.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void delete()
      Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
      java.lang.String getContentType()
      Gets the content type of this part.
      java.lang.String getHeader(java.lang.String name)
      Returns the value of the specified mime header as a String.
      java.util.Collection<java.lang.String> getHeaderNames()
      Gets the header names of this Part.
      HttpHeaders getHeaders()
      Return the HttpHeaders backing header related accessor methods, allowing for populating selected header entries.
      java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
      Gets the values of the Part header with the given name.
      java.io.InputStream getInputStream()
      Gets the content of this part as an InputStream
      java.lang.String getName()
      Gets the name of this part
      long getSize()
      Returns the size of this fille.
      java.lang.String getSubmittedFileName()
      Gets the file name specified by the client
      void write(java.lang.String fileName)
      A convenience method to write this uploaded item to disk.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MockPart

        public MockPart(java.lang.String name,
                        @Nullable
                        byte[] content)
        Constructor for a part with byte[] content only.
        See Also:
        getHeaders()
      • MockPart

        public MockPart(java.lang.String name,
                        @Nullable
                        java.lang.String filename,
                        @Nullable
                        byte[] content)
        Constructor for a part with a filename and byte[] content.
        See Also:
        getHeaders()
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: javax.servlet.http.Part
        Gets the name of this part
        Specified by:
        getName in interface Part
        Returns:
        The name of this part as a String
      • getContentType

        @Nullable
        public java.lang.String getContentType()
        Description copied from interface: javax.servlet.http.Part
        Gets the content type of this part.
        Specified by:
        getContentType in interface Part
        Returns:
        The content type of this part.
      • getSize

        public long getSize()
        Description copied from interface: javax.servlet.http.Part
        Returns the size of this fille.
        Specified by:
        getSize in interface Part
        Returns:
        a long specifying the size of this part, in bytes.
      • getInputStream

        public java.io.InputStream getInputStream()
                                           throws java.io.IOException
        Description copied from interface: javax.servlet.http.Part
        Gets the content of this part as an InputStream
        Specified by:
        getInputStream in interface Part
        Returns:
        The content of this part as an InputStream
        Throws:
        java.io.IOException - If an error occurs in retrieving the content as an InputStream
      • write

        public void write(java.lang.String fileName)
                   throws java.io.IOException
        Description copied from interface: javax.servlet.http.Part
        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.

        Specified by:
        write in interface Part
        Parameters:
        fileName - The location into which the uploaded part should be stored. The value may be a file name or a path. The actual location of the file in the filesystem is relative to MultipartConfigElement.getLocation(). Absolute paths are used as provided and are relative to getLocation(). Note: that this is a system dependent string and URI notation may not be acceptable on all systems. For portability, this string should be generated with the File or Path APIs.
        Throws:
        java.io.IOException - if an error occurs.
      • delete

        public void delete()
                    throws java.io.IOException
        Description copied from interface: javax.servlet.http.Part
        Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
        Specified by:
        delete in interface Part
        Throws:
        java.io.IOException - if an error occurs.
      • getHeader

        @Nullable
        public java.lang.String getHeader(java.lang.String name)
        Description copied from interface: javax.servlet.http.Part
        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.
        Specified by:
        getHeader in interface Part
        Parameters:
        name - a String specifying the header name
        Returns:
        a String containing the value of the requested header, or null if the part does not have a header of that name
      • getHeaders

        public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
        Description copied from interface: javax.servlet.http.Part
        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.

        Specified by:
        getHeaders in interface Part
        Parameters:
        name - the header name whose values to return
        Returns:
        a (possibly empty) Collection of the values of the header with the given name
      • getHeaderNames

        public java.util.Collection<java.lang.String> getHeaderNames()
        Description copied from interface: javax.servlet.http.Part
        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.

        Specified by:
        getHeaderNames in interface Part
        Returns:
        a (possibly empty) Collection of the header names of this Part
      • getHeaders

        public final HttpHeaders getHeaders()
        Return the HttpHeaders backing header related accessor methods, allowing for populating selected header entries.