java/src/main/com/google/appengine/tools/development/Server.java

   1 package com.google.appengine.tools.development;
   2
   3 import com.google.appengine.tools.development.AbstractServer.InstanceHolder;
   4
   5 import java.util.Map;
   6
   7 /**
   8  * Holder for both configuration and runtime information for a single
   9  * {@link DevAppServer} server and all its instances.
  10  *
  11  */
  12 interface Server {
  13   /**
  14    * Configure this {@link Server}.
  15    * <p>
  16    * Note {@link #configure} fits into the {@link DevAppServer} startup
  17    * sequence. The user may adjust {@link DevAppServer#setServiceProperties}
  18    * values after construction and before calling {@link DevAppServer#start()}
  19    * which calls {@link #configure}. To retain compatibility operations that
  20    * make use of these user specified settings such as port selection must not
  21    * not be performed during construction.
  22    * @param containerConfigProperties container configuration properties.
  23    * @throws Exception
  24    */
  25   void configure(Map<String, Object>containerConfigProperties) throws Exception;
  26
  27   /**
  28    * Creates the network connections for this {@link Server}.
  29    * @throws Exception
  30    */
  31   void createConnection() throws Exception;
  32
  33   /**
  34    * Starts all the instances for this {@link Server}. Once this returns the
  35    * {@link Server} can handle HTTP requests.
  36    * @throws Exception
  37    */
  38   void startup() throws Exception;
  39
  40   /**
  41    * Stops all the instances for this {@link Server}. Once this returns the
  42    * {@link Server} cannot handle HTTP requests.
  43    * @throws Exception
  44    */
  45   void shutdown() throws Exception;
  46
  47   /**
  48    * Returns the name for this {@link Server}.
  49    */
  50   String getServerName();
  51
  52   /**
  53    * Returns the {@link ContainerService} for the primary instance for this
  54    * {@link Server}.
  55    */
  56   ContainerService getMainContainer();
  57
  58   /**
  59    * Returns the {@link LocalServerEnvironment} for the primary instance for
  60    * this {@link Server}.
  61    */
  62   LocalServerEnvironment getLocalServerEnvironment();
  63
  64   /**
  65    * Returns the host and port for the requested instance or null if the
  66    * instance does not exist.
  67    * @param instance The instance number or {@link LocalEnvironment#MAIN_INSTANCE}.
  68    */
  69   String getHostAndPort(int instance);
  70
  71   /**
  72    * Returns the requested {@link InstanceHolder} or null if the instance does
  73    * not exist.
  74    * @param instance the instance number or {@link LocalEnvironment#MAIN_INSTANCE}.
  75    */
  76   InstanceHolder getInstanceHolder(int instance);
  77
  78   /**
  79    * Returns true if the supplied instance is a load balancing server.
  80    * @param instance the instance number or {@link LocalEnvironment#MAIN_INSTANCE}.
  81    */
  82   boolean isServerLoadBalancingServer(int instance);
  83
  84   /**
  85    * Returns the number of instances for this server. This will return 0 for
  86    * an {@link AutomaticServer}.
  87    */
  88   int getInstanceCount();
  89
  90   /**
  91    * Returns the id of an instance for the next request or -1 if there are no
  92    * free instances.
  93    */
  94   int getFreeInstance();
  95 }