How can I make a multipart form-data POST request using Java

Question

In the days of version 3 x of Apache Commons HttpClient  making a multipart form-data POST request was possible  an example from 2004   Unfortunately this is no longer possible in version 4 0 of HttpClient      For our core activity  HTTP   multipart is somewhat    out of scope  We d love to use multipart code maintained by some    other project for which it is in scope  but I m not aware of any     We tried to move the multipart code to commons-codec a few years    ago  but I didn t take off there  Oleg recently mentioned another    project that has multipart parsing code and might be interested    in our multipart formatting code  I don t know the current status    on that   http   www nabble com multipart-form-data-in-4 0-td14224819 html    Is anybody aware of any Java library that allows me to write an HTTP client that can make a multipart form-data POST request   Background  I want to use the Remote API of Zoho Writer

User · Answer

Here s a solution that does not require any libraries     This routine transmits every file in the directory d  data mpf10 to urlToConnect   String boundary   Long toHexString System currentTimeMillis     URLConnection connection   new URL urlToConnect  openConnection    connection setDoOutput true   connection setRequestProperty  Content-Type    multipart form-data  boundary     boundary   PrintWriter writer   null  try       writer   new PrintWriter new OutputStreamWriter connection getOutputStream     UTF-8         File dir   new File  d  data mpf10        for  File file   dir listFiles              if  file isDirectory                  continue                    writer println  --    boundary           writer println  Content-Disposition  form-data  name       file getName          filename       file getName                    writer println  Content-Type  text plain  charset UTF-8            writer println            BufferedReader reader   null          try               reader   new BufferedReader new InputStreamReader new FileInputStream file    UTF-8                 for  String line   line   reader readLine       null                     writer println line                           finally               if  reader    null                    reader close                                      writer println  --    boundary    --      finally       if  writer    null  writer close         Connection is lazily executed whenever you request any status  int responseCode     HttpURLConnection  connection  getResponseCode       Handle response

User · Answer

These are the Maven dependencies I have   Java Code   HttpClient httpclient   new DefaultHttpClient    HttpPost httpPost   new HttpPost url    FileBody uploadFilePart   new FileBody uploadFile   MultipartEntity reqEntity   new MultipartEntity    reqEntity addPart  upload-file   uploadFilePart   httpPost setEntity reqEntity    HttpResponse response   httpclient execute httpPost     Maven Dependencies in pom xml    lt dependency gt     lt groupId gt org apache httpcomponents lt  groupId gt     lt artifactId gt httpclient lt  artifactId gt     lt version gt 4 0 1 lt  version gt     lt scope gt compile lt  scope gt   lt  dependency gt   lt dependency gt     lt groupId gt org apache httpcomponents lt  groupId gt     lt artifactId gt httpmime lt  artifactId gt     lt version gt 4 0 1 lt  version gt     lt scope gt compile lt  scope gt   lt  dependency gt

User · Answer

My code post multipartFile to server     public static HttpResponse doPost      String host      String path      String method      MultipartFile multipartFile     throws IOException          HttpClient httpClient   wrapClient host       HttpPost httpPost   new HttpPost buildUrl host  path         if  multipartFile    null           HttpEntity httpEntity         ContentBody contentBody        contentBody   new ByteArrayBody multipartFile getBytes    multipartFile getOriginalFilename           httpEntity   MultipartEntityBuilder create                                             addPart  nameOfMultipartFile   contentBody                                            build           httpPost setEntity httpEntity              return httpClient execute httpPost

User · Answer

Using HttpRequestFactory to jira xray s   rest raven 1 0 import execution cucumber multipart   Map lt String  Object gt  params   new HashMap lt  gt                 params put   quot info quot    quot zigouzi quot                 params put    quot result quot    quot baalo quot                  HttpContent content   new UrlEncodedContent params                OAuthParameters oAuthParameters   jiraOAuthFactory getParametersForRequest ACCESS TOKEN  CONSUMER KEY  PRIVATE KEY               HttpRequestFactory requestFactory   new NetHttpTransport   createRequestFactory oAuthParameters               HttpRequest request   requestFactory buildPostRequest new GenericUrl url     content               request getHeaders   setAccept  quot application json quot                String boundary   Long toHexString System currentTimeMillis                 request getHeaders   setContentType  quot multipart form-data  boundary  quot  boundary               request getHeaders   setContentEncoding  quot application json quot                HttpResponse response   null               try                               response   request execute                    Scanner s   new Scanner response getContent    useDelimiter  quot   A quot                    result   s hasNext     s next      quot  quot                             catch  Exception e                                                 did the trick

User · Answer

httpcomponents-client-4 0 1 worked for me  However  I had to add the external jar apache-mime4j-0 6 jar   org apache james mime4j  otherwise reqEntity addPart  bin   bin   would not compile  Now it s working like charm

User · Answer

We use HttpClient 4 x to make multipart file post    UPDATE  As of HttpClient 4 3  some classes have been deprecated  Here is the code with new API   CloseableHttpClient httpClient   HttpClients createDefault    HttpPost uploadFile   new HttpPost         MultipartEntityBuilder builder   MultipartEntityBuilder create    builder addTextBody  field1    yes   ContentType TEXT PLAIN       This attaches the file to the POST  File f   new File    path to upload     builder addBinaryBody       file       new FileInputStream f       ContentType APPLICATION OCTET STREAM      f getName       HttpEntity multipart   builder build    uploadFile setEntity multipart   CloseableHttpResponse response   httpClient execute uploadFile   HttpEntity responseEntity   response getEntity      Below is the original snippet of code with deprecated HttpClient 4 0 API   HttpClient httpclient   new DefaultHttpClient    HttpPost httppost   new HttpPost url    FileBody bin   new FileBody new File fileName    StringBody comment   new StringBody  Filename      fileName    MultipartEntity reqEntity   new MultipartEntity    reqEntity addPart  bin   bin   reqEntity addPart  comment   comment   httppost setEntity reqEntity    HttpResponse response   httpclient execute httppost   HttpEntity resEntity   response getEntity

User · Answer

I found this sample in Apache s Quickstart Guide  It s for version 4 5          Example how to use multipart form encoded POST request      public class ClientMultipartFormPost        public static void main String   args  throws Exception           if  args length    1                 System out println  File path not given                System exit 1                     CloseableHttpClient httpclient   HttpClients createDefault            try               HttpPost httppost   new HttpPost  http   localhost 8080                          servlets-examples servlet RequestInfoExample                 FileBody bin   new FileBody new File args 0                 StringBody comment   new StringBody  A binary file of some kind   ContentType TEXT PLAIN                HttpEntity reqEntity   MultipartEntityBuilder create                        addPart  bin   bin                       addPart  comment   comment                       build                  httppost setEntity reqEntity                System out println  executing request     httppost getRequestLine                 CloseableHttpResponse response   httpclient execute httppost               try                   System out println  ----------------------------------------                    System out println response getStatusLine                     HttpEntity resEntity   response getEntity                    if  resEntity    null                        System out println  Response content length      resEntity getContentLength                                       EntityUtils consume resEntity                 finally                   response close                            finally               httpclient close

User · Answer

Use this code to upload images or any other files to the server using post in multipart   import java io File  import java io IOException  import java io UnsupportedEncodingException   import org apache http client ClientProtocolException  import org apache http client HttpClient  import org apache http client ResponseHandler  import org apache http client methods HttpPost  import org apache http entity mime MultipartEntity  import org apache http entity mime content FileBody  import org apache http entity mime content StringBody  import org apache http impl client BasicResponseHandler  import org apache http impl client DefaultHttpClient   public class SimplePostRequestTest        public static void main String   args  throws UnsupportedEncodingException  IOException           HttpClient httpclient   new DefaultHttpClient            HttpPost httppost   new HttpPost  http   192 168 0 102 uploadtest upload photo             try               FileBody bin   new FileBody new File   home ubuntu cd png                 StringBody id   new StringBody  3                MultipartEntity reqEntity   new MultipartEntity                reqEntity addPart  upload image   bin               reqEntity addPart  id   id               reqEntity addPart  image title   new StringBody  CoolPic                  httppost setEntity reqEntity               System out println  Requesting       httppost getRequestLine                 ResponseHandler lt String gt  responseHandler   new BasicResponseHandler                String responseBody   httpclient execute httppost  responseHandler               System out println  responseBody       responseBody              catch  ClientProtocolException e               finally               httpclient getConnectionManager   shutdown                         it requires below files to upload    libraries are  httpclient-4 1 2 jar  httpcore-4 1 2 jar  httpmime-4 1 2 jar  httpclient-cache-4 1 2 jar  commons-codec jar and  commons-logging-1 1 1 jar to be in classpath

User · Answer

If size of the JARs matters  e g  in case of applet   one can also directly use httpmime with java net HttpURLConnection instead of HttpClient   httpclient-4 2 4       423KB httpmime-4 2 4          26KB httpcore-4 2 4         222KB commons-codec-1 6      228KB commons-logging-1 1 1   60KB Sum                    959KB  httpmime-4 2 4          26KB httpcore-4 2 4         222KB Sum                    248KB   Code   HttpURLConnection connection    HttpURLConnection  url openConnection    connection setDoOutput true   connection setRequestMethod  POST     FileBody fileBody   new FileBody new File fileName    MultipartEntity multipartEntity   new MultipartEntity HttpMultipartMode STRICT   multipartEntity addPart  file   fileBody    connection setRequestProperty  Content-Type   multipartEntity getContentType   getValue     OutputStream out   connection getOutputStream    try       multipartEntity writeTo out     finally       out close      int status   connection getResponseCode          Dependency in pom xml    lt dependency gt       lt groupId gt org apache httpcomponents lt  groupId gt       lt artifactId gt httpmime lt  artifactId gt       lt version gt 4 2 4 lt  version gt   lt  dependency gt

User · Answer

We have a pure java implementation of multipart-form submit without using any external dependencies or libraries outside jdk  Refer https   github com atulsm https-multipart-purejava blob master src main java com atul MultipartPure java  private static String body       key1     val1      key2     val2      private static String subdata1       -2 3  2 4    r n   private static String subdata2     lt data gt subdata2 lt  data gt     public static void main String   args  throws Exception              String url    https       ip         port     dataupload       String token    Basic    Base64 getEncoder   encodeToString  userName     password  getBytes          MultipartBuilder multipart   new MultipartBuilder url token              multipart addFormField  entity    main    application json  body       multipart addFormField  attachment    subdata1    application octet-stream  subdata1       multipart addFormField  attachment    subdata2    application octet-stream  subdata2               List lt String gt  response   multipart finish                 for  String line   response            System out println line

User · Answer

You can also use REST Assured which builds on HTTP Client  It s very simple   given   multiPart new File   somedir file bin    when   post   fileUpload

User · Answer

My code for sending files to server using post in multipart  Make use of multivalue map while making request for sending form data   LinkedMultiValueMap lt String  Object gt  map   new LinkedMultiValueMap lt  gt             map add  quot FILE quot   new FileSystemResource file            map add  quot APPLICATION ID quot   Number       httpService post  map headers     At receiver end use  RequestMapping value    quot fileUpload quot   method   RequestMethod POST      public ApiResponse AreaCsv  RequestParam  quot FILE quot   MultipartFile file  RequestHeader  quot clientId quot        code

[java] How can I make a multipart/form-data POST request using Java?

Examples related to java

Examples related to http

Examples related to multipart