botlist_testserver/jetty/contrib/jetty-ant/src/main/java/org/mortbay/jetty/ant/WebApplicationProxyImpl.java

   1 // ========================================================================
   2 // Copyright 2006-2007 Sabre Holdings.
   3 // ------------------------------------------------------------------------
   4 // Licensed under the Apache License, Version 2.0 (the "License");
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 // http://www.apache.org/licenses/LICENSE-2.0
   8 // Unless required by applicable law or agreed to in writing, software
   9 // distributed under the License is distributed on an "AS IS" BASIS,
  10 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 // See the License for the specific language governing permissions and
  12 // limitations under the License.
  13 // ========================================================================
  14
  15 package org.mortbay.jetty.ant;
  16
  17 import java.io.File;
  18 import java.io.IOException;
  19 import java.net.MalformedURLException;
  20 import java.util.Iterator;
  21 import java.util.List;
  22
  23 import org.mortbay.jetty.ant.types.FileMatchingConfiguration;
  24 import org.mortbay.jetty.ant.utils.TaskLog;
  25 import org.mortbay.jetty.ant.utils.WebApplicationProxy;
  26 import org.mortbay.jetty.handler.ContextHandler;
  27 import org.mortbay.jetty.handler.ContextHandlerCollection;
  28 import org.mortbay.jetty.plus.webapp.EnvConfiguration;
  29 import org.mortbay.jetty.webapp.Configuration;
  30 import org.mortbay.jetty.webapp.JettyWebXmlConfiguration;
  31 import org.mortbay.jetty.webapp.TagLibConfiguration;
  32 import org.mortbay.jetty.webapp.WebAppClassLoader;
  33 import org.mortbay.jetty.webapp.WebAppContext;
  34 import org.mortbay.jetty.webapp.WebInfConfiguration;
  35
  36 /**
  37  * An abstraction layer over Jetty WebAppContext.
  38  *
  39  * @author Jakub Pawlowicz
  40  */
  41 public class WebApplicationProxyImpl implements WebApplicationProxy
  42 {
  43
  44     /** Common root temp directory for all web applications. */
  45     static File baseTempDirectory = new File(".");
  46
  47     /** Name of this web application. */
  48     private String name;
  49
  50     /** Location of WAR file (either expanded or not). */
  51     private File warFile;
  52
  53     /** Application context path. */
  54     private String contextPath;
  55
  56     /** Location of web.xml file. */
  57     private File webXmlFile;
  58
  59     /** Location of jetty-env.xml file. */
  60     private File jettyEnvXml;
  61
  62     /** List of classpath files. */
  63     private List classPathFiles;
  64
  65     /** Jetty6 Web Application Context. */
  66     private WebAppContext webAppContext;
  67
  68     /** Extra scan targets. */
  69     private FileMatchingConfiguration extraScanTargetsConfiguration;
  70
  71     /** Extra context handlers. */
  72     private List contextHandlers;
  73
  74     Configuration[] configurations = new Configuration[] { new WebInfConfiguration(),
  75             new EnvConfiguration(), new JettyWebAppConfiguration(), new JettyWebXmlConfiguration(),
  76             new TagLibConfiguration() };
  77
  78     private FileMatchingConfiguration librariesConfiguration;
  79
  80     public static void setBaseTempDirectory(File tempDirectory)
  81     {
  82         baseTempDirectory = tempDirectory;
  83     }
  84
  85     /**
  86      * Default constructor. Takes application name as an argument.
  87      *
  88      * @param name web application name.
  89      */
  90     public WebApplicationProxyImpl(String name)
  91     {
  92         this.name = name;
  93         TaskLog.log("\nConfiguring Jetty for web application: " + name);
  94     }
  95
  96     public List getClassPathFiles()
  97     {
  98         return classPathFiles;
  99     }
 100
 101     public String getContextPath()
 102     {
 103         return contextPath;
 104     }
 105
 106     public String getName()
 107     {
 108         return name;
 109     }
 110
 111     public File getSourceDirectory()
 112     {
 113         return warFile;
 114     }
 115
 116     public File getWebXmlFile()
 117     {
 118         return webXmlFile;
 119     }
 120
 121     public void setSourceDirectory(File warFile)
 122     {
 123         this.warFile = warFile;
 124         TaskLog.log("Webapp source directory = " + warFile);
 125     }
 126
 127     public void setContextPath(String contextPath)
 128     {
 129         if (!contextPath.startsWith("/"))
 130         {
 131             contextPath = "/" + contextPath;
 132         }
 133         this.contextPath = contextPath;
 134         TaskLog.log("Context path = " + contextPath);
 135
 136     }
 137
 138     public void setWebXml(File webXmlFile)
 139     {
 140         this.webXmlFile = webXmlFile;
 141     }
 142
 143     public void setJettyEnvXml(File jettyEnvXml)
 144     {
 145         this.jettyEnvXml = jettyEnvXml;
 146         if (this.jettyEnvXml != null)
 147         {
 148             TaskLog.log("jetty-env.xml file: = " + jettyEnvXml.getAbsolutePath());
 149         }
 150     }
 151
 152     public void setClassPathFiles(List classPathFiles)
 153     {
 154         this.classPathFiles = classPathFiles;
 155         TaskLog.log("Classpath = " + classPathFiles);
 156     }
 157
 158     /**
 159      * Checks if a given file is scanned according to the internal
 160      * configuration. This may be difficult due to use of 'includes' and
 161      * 'excludes' statements.
 162      *
 163      * @param pathToFile a fully qualified path to file.
 164      * @return true if file is being scanned, false otherwise.
 165      */
 166     public boolean isFileScanned(String pathToFile)
 167     {
 168         return librariesConfiguration.isIncluded(pathToFile)
 169                 || extraScanTargetsConfiguration.isIncluded(pathToFile);
 170     }
 171
 172     public void setLibrariesConfiguration(FileMatchingConfiguration classesConfiguration)
 173     {
 174         TaskLog.log("Default scanned paths = " + classesConfiguration.getBaseDirectories());
 175         this.librariesConfiguration = classesConfiguration;
 176     }
 177
 178     public List getLibraries()
 179     {
 180         return librariesConfiguration.getBaseDirectories();
 181     }
 182
 183     public void setExtraScanTargetsConfiguration(
 184             FileMatchingConfiguration extraScanTargetsConfiguration)
 185     {
 186         this.extraScanTargetsConfiguration = extraScanTargetsConfiguration;
 187         TaskLog.log("Extra scan targets = " + extraScanTargetsConfiguration.getBaseDirectories());
 188     }
 189
 190     public List getExtraScanTargets()
 191     {
 192         return extraScanTargetsConfiguration.getBaseDirectories();
 193     }
 194
 195     public List getContextHandlers()
 196     {
 197         return contextHandlers;
 198     }
 199
 200     public void setContextHandlers(List contextHandlers)
 201     {
 202         this.contextHandlers = contextHandlers;
 203     }
 204
 205     /**
 206      * @see com.sabre.ant.jetty.WebApplicationProxy#getProxiedObject()
 207      */
 208     public Object getProxiedObject()
 209     {
 210         return webAppContext;
 211     }
 212
 213     /**
 214      * @see com.sabre.ant.jetty.WebApplicationProxy#start()
 215      */
 216     public void start()
 217     {
 218         try
 219         {
 220             TaskLog.logWithTimestamp("Starting web application " + name + " ...\n");
 221             webAppContext.setShutdown(false);
 222             webAppContext.start();
 223         }
 224         catch (Exception e)
 225         {
 226             TaskLog.log(e.toString());
 227         }
 228     }
 229
 230     /**
 231      * @see com.sabre.ant.jetty.WebApplicationProxy#stop()
 232      */
 233     public void stop()
 234     {
 235         try
 236         {
 237             TaskLog.logWithTimestamp("Stopping web application " + name + " ...");
 238             webAppContext.setShutdown(true);
 239             Thread.currentThread().sleep(500L);
 240             webAppContext.stop();
 241         }
 242         catch (InterruptedException e)
 243         {
 244             TaskLog.log(e.toString());
 245         }
 246         catch (Exception e)
 247         {
 248             TaskLog.log(e.toString());
 249         }
 250     }
 251
 252     /**
 253      * @see com.sabre.ant.jetty.WebApplicationProxy#createApplicationContext(org.mortbay.jetty.handler.ContextHandlerCollection)
 254      */
 255     public void createApplicationContext(ContextHandlerCollection contexts)
 256     {
 257         webAppContext = new WebAppContext(contexts, warFile.getAbsolutePath(), contextPath);
 258         webAppContext.setDisplayName(name);
 259
 260         configurePaths();
 261         configureHandlers(contexts);
 262
 263         applyConfiguration();
 264     }
 265
 266     private void configureHandlers(ContextHandlerCollection contexts)
 267     {
 268         // adding extra context handlers
 269         Iterator handlersIterator = contextHandlers.iterator();
 270         while (handlersIterator.hasNext())
 271         {
 272             ContextHandler contextHandler = (ContextHandler) handlersIterator.next();
 273             contexts.addHandler(contextHandler);
 274         }
 275     }
 276
 277     private void configurePaths()
 278     {
 279         // configuring temp directory
 280         File tempDir = new File(baseTempDirectory, contextPath);
 281         if (!tempDir.exists())
 282         {
 283             tempDir.mkdirs();
 284         }
 285         webAppContext.setTempDirectory(tempDir);
 286         tempDir.deleteOnExit();
 287         TaskLog.log("Temp directory = " + tempDir.getAbsolutePath());
 288
 289         // configuring WAR directory for packaged web applications
 290         if (warFile.isFile())
 291         {
 292             warFile = new File(tempDir, "webapp");
 293             webXmlFile = new File(new File(warFile, "WEB-INF"), "web.xml");
 294         }
 295     }
 296
 297     /**
 298      * Applies web application configuration at the end of configuration process
 299      * or after application restart.
 300      */
 301     void applyConfiguration()
 302     {
 303         for (int i = 0; i < configurations.length; i++)
 304         {
 305             if (configurations[i] instanceof EnvConfiguration)
 306             {
 307                 try
 308                 {
 309                     if (jettyEnvXml != null && jettyEnvXml.exists())
 310                     {
 311                         ((EnvConfiguration) configurations[i]).setJettyEnvXml(jettyEnvXml.toURL());
 312                     }
 313                 }
 314                 catch (MalformedURLException e)
 315                 {
 316                     throw new RuntimeException(e);
 317                 }
 318             }
 319             else if (configurations[i] instanceof JettyWebAppConfiguration)
 320             {
 321                 ((JettyWebAppConfiguration) configurations[i]).setClassPathFiles(classPathFiles);
 322                 ((JettyWebAppConfiguration) configurations[i]).setWebAppBaseDir(warFile);
 323                 ((JettyWebAppConfiguration) configurations[i]).setWebXmlFile(webXmlFile);
 324             }
 325         }
 326
 327         try
 328         {
 329             ClassLoader loader = new WebAppClassLoader(this.getClass().getClassLoader(),
 330                     webAppContext);
 331             webAppContext.setParentLoaderPriority(true);
 332             webAppContext.setClassLoader(loader);
 333         }
 334         catch (IOException e)
 335         {
 336             TaskLog.log(e.toString());
 337         }
 338
 339         webAppContext.setConfigurations(configurations);
 340     }
 341 }