java/src/main/com/google/appengine/tools/admin/GenericApplication.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.tools.admin;
   4
   5 import com.google.appengine.tools.admin.AppAdminFactory.ApplicationProcessingOptions;
   6 import com.google.apphosting.utils.config.BackendsXml;
   7 import com.google.apphosting.utils.config.CronXml;
   8 import com.google.apphosting.utils.config.DosXml;
   9 import com.google.apphosting.utils.config.IndexesXml;
  10 import com.google.apphosting.utils.config.QueueXml;
  11
  12 import java.io.File;
  13 import java.io.IOException;
  14 import java.io.PrintWriter;
  15 import java.util.List;
  16
  17 /**
  18  * An App Engine application (may be Java/Python).
  19  *
  20  */
  21 public interface GenericApplication {
  22
  23   /**
  24    * Returns the application identifier
  25    * @return application identifier
  26    */
  27   public abstract String getAppId();
  28
  29   /**
  30    * Returns the application version
  31    * @return application version
  32    */
  33   public abstract String getVersion();
  34
  35   /**
  36    * Returns the application source-language or null if not specified.
  37    */
  38   public abstract String getSourceLanguage();
  39
  40   /**
  41    * Returns the application server name or null if not specified.
  42    */
  43   public abstract String getServer();
  44
  45   /**
  46    * Returns whether precompilation is enabled for this application
  47    * @return precompilation setting
  48    */
  49   public abstract boolean isPrecompilationEnabled();
  50
  51   /**
  52    * Returns the list of error handlers for this application
  53    * @return error handlers
  54    */
  55   public abstract List<ErrorHandler> getErrorHandlers();
  56
  57   /**
  58    * Returns the mime-type if path corresponds to static content, {@code null} otherwise.
  59    * @return mime-type, possibly {@code null}
  60    */
  61   public abstract String getMimeTypeIfStatic(String path);
  62
  63   /**
  64    * Returns the CronXml describing the applications' cron jobs.
  65    * @return a cron descriptor, possibly empty or {@code null}
  66    */
  67   public abstract CronXml getCronXml();
  68
  69   /**
  70    * Returns the QueueXml describing the applications' task queues.
  71    * @return a queue descriptor, possibly empty or {@code null}
  72    */
  73   public abstract QueueXml getQueueXml();
  74
  75   /**
  76    * Returns the DosXml describing the applications' DoS entries.
  77    * @return a dos descriptor, possibly empty or {@code null}
  78    */
  79   public abstract DosXml getDosXml();
  80
  81   /**
  82    * Returns a string containing the applications' pagespeed.yaml configuration.
  83    * @return a pagespeed.yaml config, possibly empty or {@code null}
  84    */
  85   public abstract String getPagespeedYaml();
  86
  87   /**
  88    * Returns the IndexesXml describing the applications' indexes.
  89    * @return an indexes descriptor, possibly empty or {@code null}
  90    */
  91   public abstract IndexesXml getIndexesXml();
  92
  93   /**
  94    * Returns the BackendsXml describing the applications' backends.
  95    * @return a backends descriptor, possibly empty or {@code null}
  96    */
  97   public abstract BackendsXml getBackendsXml();
  98
  99   /**
 100    * Returns the desired API version for the current application, or
 101    * {@code "none"} if no API version was used.
 102    *
 103    * @throws IllegalStateException if createStagingDirectory has not been called.
 104    */
 105   public abstract String getApiVersion();
 106
 107   /**
 108    * Returns a path to an exploded WAR directory for the application.
 109    * This may be a temporary directory.
 110    *
 111    * @return a not {@code null} path pointing to a directory
 112    */
 113   public abstract String getPath();
 114
 115   /**
 116    * Returns the staging directory, or {@code null} if none has been created.
 117    */
 118   public abstract File getStagingDir();
 119
 120   public abstract void resetProgress();
 121
 122   /**
 123    * Creates a new staging directory, if needed, or returns the existing one
 124    * if already created.
 125    *
 126    * @param opts User-specified options for processing the application.
 127    * @param resourceLimits Various resource limits provided by the cloud.
 128    * @return staging directory
 129    * @throws IOException
 130    */
 131   public abstract File createStagingDirectory(ApplicationProcessingOptions opts,
 132       ResourceLimits resourceLimits) throws IOException;
 133
 134   /** deletes the staging directory, if one was created. */
 135   public abstract void cleanStagingDirectory();
 136
 137   public abstract void setListener(UpdateListener l);
 138
 139   public abstract void setDetailsWriter(PrintWriter detailsWriter);
 140
 141   public abstract void statusUpdate(String message, int amount);
 142
 143   public abstract void statusUpdate(String message);
 144
 145   /**
 146    * Returns the yaml string describing this application's configuration.
 147    * @return application configuration yaml string
 148    */
 149   public abstract String getAppYaml();
 150
 151   /**
 152    * Interface describing the application's error handlers.
 153    */
 154   public interface ErrorHandler {
 155     /** Returns the not {@code null} error handler file name. */
 156     public abstract String getFile();
 157     /** Returns the error code, possibly {@code null}. */
 158     public abstract String getErrorCode();
 159     /** Returns the not {@code null} error handler mime-type. */
 160     public abstract String getMimeType();
 161   }
 162 }