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 the application instance class name or null if not specified.
  47    */
  48   public abstract String getInstanceClass();
  49
  50   /**
  51    * Returns whether precompilation is enabled for this application
  52    * @return precompilation setting
  53    */
  54   public abstract boolean isPrecompilationEnabled();
  55
  56   /**
  57    * Returns the list of error handlers for this application
  58    * @return error handlers
  59    */
  60   public abstract List<ErrorHandler> getErrorHandlers();
  61
  62   /**
  63    * Returns the mime-type if path corresponds to static content, {@code null} otherwise.
  64    * @return mime-type, possibly {@code null}
  65    */
  66   public abstract String getMimeTypeIfStatic(String path);
  67
  68   /**
  69    * Returns the CronXml describing the applications' cron jobs.
  70    * @return a cron descriptor, possibly empty or {@code null}
  71    */
  72   public abstract CronXml getCronXml();
  73
  74   /**
  75    * Returns the QueueXml describing the applications' task queues.
  76    * @return a queue descriptor, possibly empty or {@code null}
  77    */
  78   public abstract QueueXml getQueueXml();
  79
  80   /**
  81    * Returns the DosXml describing the applications' DoS entries.
  82    * @return a dos descriptor, possibly empty or {@code null}
  83    */
  84   public abstract DosXml getDosXml();
  85
  86   /**
  87    * Returns a string containing the applications' pagespeed.yaml configuration.
  88    * @return a pagespeed.yaml config, possibly empty or {@code null}
  89    */
  90   public abstract String getPagespeedYaml();
  91
  92   /**
  93    * Returns the IndexesXml describing the applications' indexes.
  94    * @return an indexes descriptor, possibly empty or {@code null}
  95    */
  96   public abstract IndexesXml getIndexesXml();
  97
  98   /**
  99    * Returns the BackendsXml describing the applications' backends.
 100    * @return a backends descriptor, possibly empty or {@code null}
 101    */
 102   public abstract BackendsXml getBackendsXml();
 103
 104   /**
 105    * Returns the desired API version for the current application, or
 106    * {@code "none"} if no API version was used.
 107    *
 108    * @throws IllegalStateException if createStagingDirectory has not been called.
 109    */
 110   public abstract String getApiVersion();
 111
 112   /**
 113    * Returns a path to an exploded WAR directory for the application.
 114    * This may be a temporary directory.
 115    *
 116    * @return a not {@code null} path pointing to a directory
 117    */
 118   public abstract String getPath();
 119
 120   /**
 121    * Returns the staging directory, or {@code null} if none has been created.
 122    */
 123   public abstract File getStagingDir();
 124
 125   public abstract void resetProgress();
 126
 127   /**
 128    * Creates a new staging directory, if needed, or returns the existing one
 129    * if already created.
 130    *
 131    * @param opts User-specified options for processing the application.
 132    * @param resourceLimits Various resource limits provided by the cloud.
 133    * @return staging directory
 134    * @throws IOException
 135    */
 136   public abstract File createStagingDirectory(ApplicationProcessingOptions opts,
 137       ResourceLimits resourceLimits) throws IOException;
 138
 139   /** deletes the staging directory, if one was created. */
 140   public abstract void cleanStagingDirectory();
 141
 142   public abstract void setListener(UpdateListener l);
 143
 144   public abstract void setDetailsWriter(PrintWriter detailsWriter);
 145
 146   public abstract void statusUpdate(String message, int amount);
 147
 148   public abstract void statusUpdate(String message);
 149
 150   /**
 151    * Returns the yaml string describing this application's configuration.
 152    * @return application configuration yaml string
 153    */
 154   public abstract String getAppYaml();
 155
 156   /**
 157    * Interface describing the application's error handlers.
 158    */
 159   public interface ErrorHandler {
 160     /** Returns the not {@code null} error handler file name. */
 161     public abstract String getFile();
 162     /** Returns the error code, possibly {@code null}. */
 163     public abstract String getErrorCode();
 164     /** Returns the not {@code null} error handler mime-type. */
 165     public abstract String getMimeType();
 166   }
 167 }