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

   1 package com.google.appengine.tools.remoteapi;
   2
   3 import java.io.IOException;
   4
   5 /**
   6  * An interface describing a Remote API client. Implementations of this
   7  * interface must be thread-safe.
   8  */
   9 interface RemoteApiClient {
  10
  11   /**
  12    * @return The path to the Remote API handler.
  13    */
  14   String getRemoteApiPath();
  15
  16   /**
  17    * @return The app id associated with this client, possibly null.
  18    */
  19   String getAppId();
  20
  21   /**
  22    * @return The credentials assocated with this client as a String.
  23    * Non-cookie based implementations may not support this method.
  24    */
  25   String serializeCredentials();
  26
  27   /**
  28    * Executes an HTTP POST request against {@code path}.
  29    */
  30   AppEngineClient.Response post(String path, String mimeType, byte[] body) throws IOException;
  31
  32   /**
  33    * Executes an HTTP GET request against {@code path}.
  34    */
  35   AppEngineClient.Response get(String path) throws IOException;
  36 }