Package org.apache.sling.engine.impl.parameters

Class MultipartRequestParameter

java.lang.Object
org.apache.sling.engine.impl.parameters.MultipartRequestParameter
All Implemented Interfaces:
RequestParameter
public class MultipartRequestParameter extends Object
The MultipartRequestParameter represents a request parameter from a multipart/form-data POST request.

To not add a dependency to Servlet API 3 this class does not implement the Servlet API 3 Part interface. To support Servlet API 3 Parts the SlingPart class wraps instances of this class.

  • Constructor Details

    • MultipartRequestParameter

      public MultipartRequestParameter(org.apache.commons.fileupload.FileItem delegatee)

  • Method Details

    • get

      public byte[] get()
      Description copied from interface: RequestParameter
      Returns the contents of the parameter as an array of bytes.
      Returns:
      The contents of the parameter as an array of bytes.

    • getContentType

      public String getContentType()
      Description copied from interface: RequestParameter
      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.

    • getInputStream

      public InputStream getInputStream() throws IOException
      Description copied from interface: RequestParameter
      Returns an InputStream that can be used to retrieve the contents of the file.

      Each call to this method returns a new InputStream to the request parameter data. Make sure to close the stream to prevent leaking resources.

      Returns:
      An InputStream that can be used to retrieve the contents of the file.
      Throws:
      IOException - if an error occurs.

    • getFileName

      public String getFileName()
      Description copied from interface: RequestParameter
      Returns the original filename in the client's filesystem, 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 filename in the client's filesystem.

    • getSize

      public long getSize()
      Description copied from interface: RequestParameter
      Returns the size in bytes of the parameter.
      Returns:
      The size in bytes of the parameter.

    • getString

      public String getString()
      Description copied from interface: RequestParameter
      Returns the contents of the parameter as a String, using the default character encoding. This method uses RequestParameter.get() to retrieve the contents of the item.
      Returns:
      The contents of the parameter, as a string.

    • getString

      public String getString(String enc) throws UnsupportedEncodingException
      Description copied from interface: RequestParameter
      Returns the contents of the parameter as a String, using the specified encoding. This method uses link RequestParameter.get() to retrieve the contents of the item.
      Parameters:
      enc - The character encoding to use.
      Returns:
      The contents of the parameter, as a string.
      Throws:
      UnsupportedEncodingException - if the requested character encoding is not available.

    • isFormField

      public boolean isFormField()
      Description copied from interface: RequestParameter
      Determines whether or not this instance represents a simple form field or an uploaded file.
      Returns:
      true if the instance represents a simple form field; false if it represents an uploaded file.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getName

      public String getName()
      Specified by:
      getName in interface RequestParameter
      Returns:
      the name of this RequestParameter

    • getEncoding

      public String getEncoding()