java/src/main/com/google/appengine/tools/remoteapi/AppEngineClient.java

   1 // Copyright 2010 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.tools.remoteapi;
   4
   5 import org.apache.commons.httpclient.Cookie;
   6 import org.apache.commons.httpclient.util.EncodingUtil;
   7
   8 import java.io.IOException;
   9 import java.util.ArrayList;
  10 import java.util.List;
  11
  12 /**
  13  * Abstract class that handles making HTTP requests to App Engine.  The actual
  14  * mechanism by which the HTTP requests are made is left to subclasses to
  15  * implement.
  16  * <p> This class is thread-safe. </p>
  17  *
  18  */
  19 abstract class AppEngineClient {
  20   private final String hostname;
  21   private final int port;
  22   private final String userEmail;
  23   private final Cookie[] authCookies;
  24   private final String remoteApiPath;
  25   private final int maxResponseSize;
  26
  27   private final String appId;
  28
  29   AppEngineClient(RemoteApiOptions options,
  30       List<Cookie> authCookies, String appId) {
  31     if (options == null) {
  32       throw new IllegalArgumentException("options not set");
  33     }
  34     if (authCookies == null) {
  35       throw new IllegalArgumentException("authCookies not set");
  36     }
  37     this.hostname = options.getHostname();
  38     this.port = options.getPort();
  39     this.userEmail = options.getUserEmail();
  40     this.authCookies = authCookies.toArray(new Cookie[0]);
  41     this.remoteApiPath = options.getRemoteApiPath();
  42     this.maxResponseSize = options.getMaxHttpResponseSize();
  43
  44     this.appId = appId;
  45   }
  46
  47   /**
  48    * @return the {@link Cookie} objects that should be used for authentication
  49    */
  50   Cookie[] getAuthCookies() {
  51     return authCookies;
  52   }
  53
  54   int getMaxResponseSize() {
  55     return maxResponseSize;
  56   }
  57
  58   /**
  59    * @return the path to the remote api for this app (if logged in), {@code null} otherwise
  60    */
  61   String getRemoteApiPath() {
  62     return remoteApiPath;
  63   }
  64
  65   /**
  66    * @return the app id for this app (if logged in), {@code null} otherwise
  67    */
  68   String getAppId() {
  69     return appId;
  70   }
  71
  72   int getPort() {
  73     return port;
  74   }
  75
  76   String serializeCredentials() {
  77     StringBuilder out = new StringBuilder();
  78     out.append("host=" + hostname + "\n");
  79     out.append("email=" + userEmail + "\n");
  80     for (Cookie cookie : authCookies) {
  81       out.append("cookie=" + cookie.getName() + "=" + cookie.getValue() + "\n");
  82     }
  83     return out.toString();
  84   }
  85
  86   String makeUrl(String path) {
  87     if (!path.startsWith("/")) {
  88       throw new IllegalArgumentException("path doesn't start with a slash: " + path);
  89     }
  90     String protocol = port == 443 ? "https" : "http";
  91     return protocol + "://" + hostname + ":" + port + path;
  92   }
  93
  94   List<String[]> getHeadersForPost(String mimeType) {
  95     List<String[]> headers = getHeadersBase();
  96     headers.add(new String[]{"Content-type", mimeType});
  97     return headers;
  98   }
  99
 100   List<String[]> getHeadersForGet() {
 101     return getHeadersBase();
 102   }
 103
 104   List<String[]> getHeadersBase() {
 105     List<String[]> headers = new ArrayList<String[]>();
 106     headers.add(new String[]{"Host", hostname});
 107     headers.add(new String[]{"X-appcfg-api-version", "1"});
 108     return headers;
 109   }
 110
 111   abstract Response get(String path) throws IOException;
 112
 113   abstract Response post(String path, String mimeType, byte[] body) throws IOException;
 114
 115   static class Response {
 116     private final int statusCode;
 117     private final byte[] responseBody;
 118     private final String responseCharSet;
 119
 120     Response(int statusCode, byte[] responseBody, String responseCharSet) {
 121       this.statusCode = statusCode;
 122       this.responseBody = responseBody;
 123       this.responseCharSet = responseCharSet;
 124     }
 125
 126     int getStatusCode() {
 127       return statusCode;
 128     }
 129
 130     byte[] getBodyAsBytes() {
 131       return responseBody;
 132     }
 133
 134     String getBodyAsString() {
 135       return EncodingUtil.getString(responseBody, responseCharSet);
 136     }
 137   }
 138 }