Class MultipartUtility

java.lang.Object
com.cloudinary.android.MultipartUtility

public class MultipartUtility
extends java.lang.Object
This utility class provides an abstraction layer for sending multipart HTTP POST requests to a web server.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String USER_AGENT  
  • Constructor Summary

    Constructors 
    Constructor Description
    MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary)  
    MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers)
    This constructor initializes a new HTTP POST request with content type is set to multipart/form-data
    MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers, com.cloudinary.android.MultipartUtility.MultipartCallback multipartCallback)  
    MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers, com.cloudinary.android.MultipartUtility.MultipartCallback multipartCallback, int connectTimeout, int readTimeout)  
  • Method Summary

    Modifier and Type Method Description
    void addFilePart​(java.lang.String fieldName, java.io.File uploadFile)  
    void addFilePart​(java.lang.String fieldName, java.io.File uploadFile, java.lang.String fileName)
    Adds a upload file section to the request
    void addFilePart​(java.lang.String fieldName, java.io.InputStream inputStream)  
    void addFilePart​(java.lang.String fieldName, java.io.InputStream inputStream, java.lang.String fileName)  
    void addFormField​(java.lang.String name, java.lang.String value)
    Adds a form field to the request
    void close()
    Closes the internal connection's output stream.
    java.net.HttpURLConnection execute()
    Completes the request and receives response from the server.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • USER_AGENT

      public static final java.lang.String USER_AGENT
  • Constructor Details

    • MultipartUtility

      public MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers) throws java.io.IOException
      This constructor initializes a new HTTP POST request with content type is set to multipart/form-data
      Parameters:
      requestURL -
      charset -
      Throws:
      java.io.IOException
    • MultipartUtility

      public MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers, com.cloudinary.android.MultipartUtility.MultipartCallback multipartCallback) throws java.io.IOException
      Throws:
      java.io.IOException
    • MultipartUtility

      public MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary, java.util.Map<java.lang.String,​java.lang.String> headers, com.cloudinary.android.MultipartUtility.MultipartCallback multipartCallback, int connectTimeout, int readTimeout) throws java.io.IOException
      Throws:
      java.io.IOException
    • MultipartUtility

      public MultipartUtility​(java.lang.String requestURL, java.lang.String charset, java.lang.String boundary) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • addFormField

      public void addFormField​(java.lang.String name, java.lang.String value)
      Adds a form field to the request
      Parameters:
      name - field name
      value - field value
    • addFilePart

      public void addFilePart​(java.lang.String fieldName, java.io.File uploadFile, java.lang.String fileName) throws java.io.IOException
      Adds a upload file section to the request
      Parameters:
      fieldName - name attribute in <input type="file" name="..." />
      uploadFile - a File to be uploaded
      Throws:
      java.io.IOException
    • addFilePart

      public void addFilePart​(java.lang.String fieldName, java.io.File uploadFile) throws java.io.IOException
      Throws:
      java.io.IOException
    • addFilePart

      public void addFilePart​(java.lang.String fieldName, java.io.InputStream inputStream, java.lang.String fileName) throws java.io.IOException
      Throws:
      java.io.IOException
    • addFilePart

      public void addFilePart​(java.lang.String fieldName, java.io.InputStream inputStream) throws java.io.IOException
      Throws:
      java.io.IOException
    • execute

      public java.net.HttpURLConnection execute() throws java.io.IOException
      Completes the request and receives response from the server.
      Returns:
      a list of Strings as response in case the server returned status OK, otherwise an exception is thrown.
      Throws:
      java.io.IOException
    • close

      public void close()
      Closes the internal connection's output stream. Closing a previously closed stream has no effect.