java/src/main/com/google/apphosting/utils/config/QueueYamlReader.java

   1 // Copyright 2010 Google Inc. All Rights Reserved.
   2
   3 package com.google.apphosting.utils.config;
   4
   5 import java.io.File;
   6 import java.io.FileReader;
   7 import java.io.FileNotFoundException;
   8 import java.io.Reader;
   9 import java.io.StringReader;
  10 import java.util.ArrayList;
  11 import java.util.List;
  12 import net.sourceforge.yamlbeans.YamlException;
  13 import net.sourceforge.yamlbeans.YamlReader;
  14
  15 /**
  16  * Class to parse queue.yaml into a QueueXml object.
  17  *
  18  */
  19 public class QueueYamlReader {
  20
  21   /**
  22    * Wrapper around QueueXml to match JavaBean properties to
  23    * the yaml file syntax.
  24    */
  25   public static class QueueYaml {
  26
  27     /**
  28      * Wrapper around QueueXml.RetryParameters to match the JavaBean
  29      * properties to the yaml file syntax.
  30      */
  31     public static class RetryParameters {
  32       private QueueXml.RetryParameters retryParameters = new QueueXml.RetryParameters();
  33
  34       public RetryParameters() {}
  35
  36       public void setTask_retry_limit(int limit) {
  37         retryParameters.setRetryLimit(limit);
  38       }
  39       public int getTask_retry_limit() {
  40         return retryParameters.getRetryLimit();
  41       }
  42       public void setTask_age_limit(String ageLimit) {
  43         retryParameters.setAgeLimitSec(ageLimit);
  44       }
  45       public String getTask_age_limit() {
  46         return retryParameters.getAgeLimitSec().toString() + "s";
  47       }
  48       public void setMin_backoff_seconds(double backoff) {
  49         retryParameters.setMinBackoffSec(backoff);
  50       }
  51       public double getMin_backoff_seconds() {
  52         return retryParameters.getMinBackoffSec();
  53       }
  54       public void setMax_backoff_seconds(double backoff) {
  55         retryParameters.setMaxBackoffSec(backoff);
  56       }
  57       public double getMax_backoff_seconds() {
  58         return retryParameters.getMaxBackoffSec();
  59       }
  60       public void setMax_doublings(int doublings) {
  61         retryParameters.setMaxDoublings(doublings);
  62       }
  63       public int getMax_doublings() {
  64         return retryParameters.getMaxDoublings();
  65       }
  66       public QueueXml.RetryParameters toXml() {
  67         return retryParameters;
  68       }
  69     }
  70
  71     public static class AclEntry {
  72       QueueXml.AclEntry acl = new QueueXml.AclEntry();
  73
  74       public void setUser_email(String userEmail) {
  75         acl.setUserEmail(userEmail);
  76       }
  77
  78       public String getUser_email() {
  79         return acl.getUserEmail();
  80       }
  81
  82       public void setWriter_email(String writerEmail) {
  83         acl.setWriterEmail(writerEmail);
  84       }
  85
  86       public String getWriter_email() {
  87         return acl.getWriterEmail();
  88       }
  89
  90       public QueueXml.AclEntry toXml() {
  91         return acl;
  92       }
  93     }
  94
  95     /**
  96      * Wrapper around QueueXml.Entry to match the JavaBean properties to
  97      * the yaml file syntax.
  98      */
  99     public static class Entry {
 100       private QueueXml.Entry entry = new QueueXml.Entry();
 101       private RetryParameters retryParameters;
 102       private List<AclEntry> acl;
 103       public void setName(String name) {
 104         entry.setName(name);
 105       }
 106       public String getName() {
 107         return entry.getName();
 108       }
 109       public void setRate(String rate) {
 110         entry.setRate(rate);
 111       }
 112       public String getRate() {
 113         return entry.getRate() + "/" + entry.getRateUnit().getIdent();
 114       }
 115       public void setBucket_size(int size) {
 116         entry.setBucketSize(size);
 117       }
 118       public int getBucket_size() {
 119         return entry.getBucketSize();
 120       }
 121       public void setMax_concurrent_requests(int size) {
 122         entry.setMaxConcurrentRequests(size);
 123       }
 124       public int getMax_concurrent_requests() {
 125         return entry.getMaxConcurrentRequests();
 126       }
 127       public void setRetry_parameters(RetryParameters retryParameters) {
 128         this.retryParameters = retryParameters;
 129         if (retryParameters != null) {
 130           entry.setRetryParameters(retryParameters.toXml());
 131         } else {
 132           entry.setRetryParameters(new QueueXml.RetryParameters());
 133         }
 134       }
 135       public RetryParameters getRetry_parameters() {
 136         return retryParameters;
 137       }
 138       public void setTarget(String target) {
 139         entry.setTarget(target);
 140       }
 141       public String getTarget() {
 142         return entry.getTarget();
 143       }
 144       public void setMode(String mode) {
 145         entry.setMode(mode);
 146       }
 147       public String getMode() {
 148         return entry.getMode();
 149       }
 150       public void setAcl(List<AclEntry> acl) {
 151         this.acl = acl;
 152         entry.setAcl(new ArrayList<QueueXml.AclEntry>());
 153         if (acl != null) {
 154           for (int i = 0; i < acl.size(); ++i) {
 155             AclEntry aclEntry = acl.get(i);
 156             entry.addAcl(aclEntry.toXml());
 157           }
 158         }
 159       }
 160       public List<AclEntry> getAcl() {
 161         return acl;
 162       }
 163       public QueueXml.Entry toXml() {
 164         return entry;
 165       }
 166     }
 167
 168     private List<Entry> entries;
 169     public String total_storage_limit;
 170
 171     public List<Entry> getQueue() {
 172       return entries;
 173     }
 174
 175     public void setQueue(List<Entry> entries) {
 176       this.entries = entries;
 177     }
 178
 179     public QueueXml toXml() {
 180       QueueXml xml = new QueueXml();
 181       if (total_storage_limit != null) {
 182         xml.setTotalStorageLimit(total_storage_limit);
 183       }
 184       if (entries != null) {
 185         for (Entry entry : entries) {
 186           xml.addEntry(entry.toXml());
 187         }
 188       }
 189       return xml;
 190     }
 191   }
 192
 193   private static final String FILENAME = "queue.yaml";
 194   private String appDir;
 195
 196   public QueueYamlReader(String appDir) {
 197     if (appDir.length() > 0 && appDir.charAt(appDir.length() - 1) != File.separatorChar) {
 198       appDir += File.separatorChar;
 199     }
 200     this.appDir = appDir;
 201   }
 202
 203   public String getFilename() {
 204     return appDir + QueueYamlReader.FILENAME;
 205   }
 206
 207   public QueueXml parse() {
 208     if (new File(getFilename()).exists()) {
 209       try {
 210         return parse(new FileReader(getFilename()));
 211       } catch (FileNotFoundException ex) {
 212         throw new AppEngineConfigException("Cannot find file " + getFilename(), ex);
 213       }
 214     }
 215     return null;
 216   }
 217
 218   public static QueueXml parse(Reader yaml) {
 219     YamlReader reader = new YamlReader(yaml);
 220     reader.getConfig().setPropertyElementType(QueueYaml.class,
 221                                               "queue",
 222                                               QueueYaml.Entry.class);
 223
 224     reader.getConfig().setPropertyElementType(QueueYaml.Entry.class,
 225                                               "acl",
 226                                               QueueYaml.AclEntry.class);
 227     try {
 228       QueueYaml queueYaml = reader.read(QueueYaml.class);
 229       if (queueYaml == null) {
 230         throw new AppEngineConfigException("Empty queue configuration.");
 231       }
 232       return queueYaml.toXml();
 233     } catch (YamlException ex) {
 234       throw new AppEngineConfigException(ex.getMessage(), ex);
 235     }
 236   }
 237
 238   public static QueueXml parse(String yaml) {
 239     return parse(new StringReader(yaml));
 240   }
 241 }