REST API:StaticResourceUploadClient

From AgileApps Support Wiki

The StaticResourceUploadClient demo program extends the REST API:BaseClient class to upload a static resource. With a couple of modifications, it can be used to do updates or load arbitrary file types.


Tip: The file contains BaseClient, the utility class it uses, and extensions like this one that demonstrate REST operations.



import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.PutMethod;
import org.apache.commons.httpclient.methods.multipart.FilePart;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.StringPart;

 * Load a static resource file.
 * Load a static resource file. This program extends
 * which in turn makes use of
 * <p>
 * Note:<br/>
 * This class uses the Apache commons HttpClient.
 * The Apache wink RestClient is generally more straightforward,
 * but multipart requests currently do not work when made using that client.
public class StaticResourceUploadClient extends BaseClient
  public void execute(String cookieString) 
    String url = baseUrl + "/staticResource";
    //Use this for an update:
    // String url = baseUrl + "/staticResource/{id}";     // <--[1]
    String xml = "<platform>"
               + "<staticResource>"
                  + "<name>upload_test</name>"
                  + "<description>Test an API-driven upload</description>"
               + "</staticResource>"
               + "</platform>";
      // File part
      File file = new File("C:/testfiles/test.txt"); 
      FilePart fp = new FilePart("file_part", file);
      fp.setContentType(MediaType.TEXT_PLAIN);            // <--[3]
         //Use BaseUtil.mediaType() to set type based on file extension    
      // XML part
      // For JSON, use __json_data__ and APPLICATION_JSON
      StringPart sp = new StringPart("__xml_data__", xml);

      // Multipart wrapper
      final Part[] part = {fp, sp};        

      // Create the request
      HttpClient httpClient = new HttpClient();
      PostMethod httpMethod = new PostMethod(url);        // <--[2]
        // Use PutMethod for an update      

      // Set the response type (xml) and the session cookie. 
      //(Had we logged in with HttpClient, the cookie would be handled
      // automatically. But since we let BaseClient do the log in and log out,
      // we need to tack on the cookie string here.) 
      httpMethod.addRequestHeader("Cookie", cookieString);
      httpMethod.addRequestHeader("Accept", MediaType.APPLICATION_XML);
        new MultipartRequestEntity(part, httpMethod.getParams())
      // Check status & echo response
      int status  = httpClient.executeMethod(httpMethod); 
      String responseXml = httpMethod.getResponseBodyAsString();
      if ((status == 200) || (status == 201))
        // 200=Successful GET, PUT, or DELETE. 201=Successful POST.       
        echoStatus(status, responseXml);
    catch (ClientWebException webException)
    catch (Exception e)
  public static void main(String[] args) 
    StaticResourceUploadClient client = new StaticResourceUploadClient();
    String cookieString = client.login();
  • [1,2] - Change these lines to update an existing resource
  • [3] - Use the BaseUtil mediaType() method to automatically set the content type appropriate for the file.