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

   1 // Copyright 2009 Google Inc. All Rights Reserved.
   2
   3 package com.google.apphosting.utils.config;
   4
   5 import java.util.ArrayList;
   6 import java.util.List;
   7 import java.util.Map;
   8 import java.util.HashMap;
   9
  10 /**
  11  *
  12  *
  13  */
  14 public class WebXml {
  15   private final List<String> servletPatterns;
  16   private final List<SecurityConstraint> securityConstraints;
  17   private final List<String> welcomeFiles;
  18   private final Map<String, String> mimeMappings;
  19   private final Map<String, String> patternToId;
  20   private boolean fallThroughToRuntime;
  21
  22   public WebXml() {
  23     servletPatterns = new ArrayList<String>();
  24     securityConstraints = new ArrayList<SecurityConstraint>();
  25     welcomeFiles = new ArrayList<String>();
  26     mimeMappings = new HashMap<String, String>();
  27     patternToId = new HashMap<String, String>();
  28   }
  29
  30   /**
  31    * Returns true if {@code url} matches one of the servlets or
  32    * servlet filters listed in this web.xml.
  33    */
  34   public boolean matches(String url) {
  35     for (String pattern : servletPatterns) {
  36       if (pattern.length() == 0) {
  37         continue;
  38       }
  39       if (pattern.startsWith("*") && url.endsWith(pattern.substring(1))) {
  40         return true;
  41       } else if (pattern.endsWith("*") &&
  42                  url.startsWith(pattern.substring(0, pattern.length() - 1))) {
  43         return true;
  44       } else if (url.equals(pattern)) {
  45         return true;
  46       }
  47     }
  48     return false;
  49   }
  50
  51   public String getHandlerIdForPattern(String pattern) {
  52     return patternToId.get(pattern);
  53   }
  54
  55   public void addServletPattern(String urlPattern, String id) {
  56     YamlUtils.validateUrl(urlPattern);
  57     servletPatterns.add(urlPattern);
  58     if (id != null) {
  59       patternToId.put(urlPattern, id);
  60     }
  61   }
  62
  63   public List<String> getServletPatterns() {
  64     return servletPatterns;
  65   }
  66
  67   public List<SecurityConstraint> getSecurityConstraints() {
  68     return securityConstraints;
  69   }
  70
  71   public SecurityConstraint addSecurityConstraint() {
  72     SecurityConstraint context = new SecurityConstraint();
  73     securityConstraints.add(context);
  74     return context;
  75   }
  76
  77   public void addWelcomeFile(String welcomeFile) {
  78     welcomeFiles.add(welcomeFile);
  79   }
  80
  81   public List<String> getWelcomeFiles() {
  82     return welcomeFiles;
  83   }
  84
  85   public void addMimeMapping(String extension, String mimeType) {
  86     mimeMappings.put(extension, mimeType);
  87   }
  88
  89   public Map<String, String> getMimeMappings() {
  90     return mimeMappings;
  91   }
  92
  93   public String getMimeTypeForPath(String path) {
  94     int dot = path.lastIndexOf(".");
  95     if (dot != -1) {
  96       return mimeMappings.get(path.substring(dot + 1));
  97     } else {
  98       return null;
  99     }
 100   }
 101
 102   public boolean getFallThroughToRuntime() {
 103     return fallThroughToRuntime;
 104   }
 105
 106   public void setFallThroughToRuntime(boolean fallThroughToRuntime) {
 107     this.fallThroughToRuntime = fallThroughToRuntime;
 108   }
 109
 110   /**
 111    * Performs some optional validation on this {@code WebXml}.
 112    *
 113    * @throws AppEngineConfigException If any errors are found.
 114    */
 115   public void validate() {
 116     for (String welcomeFile : welcomeFiles) {
 117       if (welcomeFile.startsWith("/")) {
 118         throw new AppEngineConfigException("Welcome files must be relative paths: " + welcomeFile);
 119       }
 120     }
 121   }
 122
 123   /**
 124    * Information about a security context, requiring SSL and/or authentication.
 125    * Effectively, this is a tuple of { urlpatterns..., ssl-guarantee, auth-role }.
 126    */
 127   public static class SecurityConstraint {
 128     public enum RequiredRole { NONE, ANY_USER, ADMIN }
 129     public enum TransportGuarantee { NONE, INTEGRAL, CONFIDENTIAL }
 130
 131     private final List<String> patterns;
 132     private TransportGuarantee transportGuarantee = TransportGuarantee.NONE;
 133     private RequiredRole requiredRole = RequiredRole.NONE;
 134
 135     private SecurityConstraint() {
 136       patterns = new ArrayList<String>();
 137     }
 138
 139     public List<String> getUrlPatterns() {
 140       return patterns;
 141     }
 142
 143     public void addUrlPattern(String pattern) {
 144       patterns.add(pattern);
 145     }
 146
 147     public TransportGuarantee getTransportGuarantee() {
 148       return transportGuarantee;
 149     }
 150
 151     public void setTransportGuarantee(TransportGuarantee transportGuarantee) {
 152       this.transportGuarantee = transportGuarantee;
 153     }
 154
 155     public RequiredRole getRequiredRole() {
 156       return requiredRole;
 157     }
 158
 159     public void setRequiredRole(RequiredRole requiredRole) {
 160       this.requiredRole = requiredRole;
 161     }
 162   }
 163 }