View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.osgi.boot.internal.serverfactory;
20  
21  import java.io.File;
22  import java.net.MalformedURLException;
23  import java.net.URI;
24  import java.net.URL;
25  import java.util.ArrayList;
26  import java.util.Dictionary;
27  import java.util.Enumeration;
28  import java.util.Hashtable;
29  import java.util.List;
30  import java.util.StringTokenizer;
31  
32  import org.eclipse.jetty.osgi.boot.JettyBootstrapActivator;
33  import org.eclipse.jetty.osgi.boot.OSGiServerConstants;
34  import org.eclipse.jetty.osgi.boot.utils.BundleFileLocatorHelperFactory;
35  import org.eclipse.jetty.osgi.boot.utils.OSGiClassLoader;
36  import org.eclipse.jetty.osgi.boot.utils.Util;
37  import org.eclipse.jetty.server.Server;
38  import org.eclipse.jetty.util.log.Log;
39  import org.eclipse.jetty.util.log.Logger;
40  import org.eclipse.jetty.util.resource.JarResource;
41  import org.eclipse.jetty.util.resource.Resource;
42  import org.osgi.framework.Bundle;
43  import org.osgi.framework.BundleContext;
44  
45  /**
46   * DefaultJettyAtJettyHomeHelper
47   * 
48   * 
49   * Creates a default instance of Jetty, based on the values of the
50   * System properties "jetty.home" or "jetty.home.bundle", one of which
51   * must be specified in order to create the default instance.
52   * 
53   * Called by the {@link JettyBootstrapActivator} during the starting of the
54   * bundle. 
55   */
56  public class DefaultJettyAtJettyHomeHelper
57  {
58      private static final Logger LOG = Log.getLogger(DefaultJettyAtJettyHomeHelper.class);
59  
60      /**
61       * contains a comma separated list of paths to the etc/jetty-*.xml files
62       */
63      public static final String JETTY_ETC_FILES = OSGiServerConstants.MANAGED_JETTY_XML_CONFIG_URLS;
64  
65      /**
66       * Set of config files to apply to a jetty Server instance if none are supplied by SYS_PROP_JETTY_ETC_FILES
67       */
68      public static final String DEFAULT_JETTY_ETC_FILES = "etc/jetty.xml,etc/jetty-selector.xml,etc/jetty-deployer.xml";
69      
70      /**
71       * Default location within bundle of a jetty home dir.
72       */
73      public static final String DEFAULT_JETTYHOME = "/jettyhome";
74      
75      
76      
77      /* ------------------------------------------------------------ */
78      /**
79       * Called by the JettyBootStrapActivator. If the system property jetty.home
80       * is defined and points to a folder, creates a corresponding jetty
81       * server.
82       * <p>
83       * If the system property jetty.home.bundle is defined and points to a
84       * bundle, look for the configuration of jetty inside that bundle.
85       * </p>
86       * <p>
87       * In both cases reads the system property 'jetty.etc.config.urls' to locate
88       * the configuration files for the deployed jetty. It is a comma separated
89       * list of URLs or relative paths inside the bundle or folder to the config
90       * files.
91       * </p>
92       * <p>
93       * In both cases the system properties jetty.host, jetty.port and
94       * jetty.port.ssl are passed to the configuration files that might use them
95       * as part of their properties.
96       * </p>
97       */
98      public static Server startJettyAtJettyHome(BundleContext bundleContext) throws Exception
99      {
100         String jettyHomeSysProp = System.getProperty(OSGiServerConstants.JETTY_HOME);
101         String jettyHomeBundleSysProp = System.getProperty(OSGiServerConstants.JETTY_HOME_BUNDLE);
102         File jettyHomeDir = null;
103         Bundle jettyHomeBundle = null;
104      
105         Dictionary<String,String> properties = new Hashtable<String,String>();
106         if (jettyHomeSysProp != null)
107         {
108             jettyHomeSysProp = Util.resolvePropertyValue(jettyHomeSysProp);
109             // bug 329621
110             if (jettyHomeSysProp.startsWith("\"") && jettyHomeSysProp.endsWith("\"") || (jettyHomeSysProp.startsWith("'") && jettyHomeSysProp.endsWith("'")))
111                 jettyHomeSysProp = jettyHomeSysProp.substring(1, jettyHomeSysProp.length() - 1);
112          
113             if (jettyHomeBundleSysProp != null)
114                 LOG.warn("Both jetty.home and jetty.home.bundle property defined: jetty.home.bundle ignored.");
115            
116             jettyHomeDir = new File(jettyHomeSysProp);
117             if (!jettyHomeDir.exists() || !jettyHomeDir.isDirectory())
118             {
119                 LOG.warn("Unable to locate the jetty.home folder " + jettyHomeSysProp);
120                 return null;
121             }
122             
123             //set jetty.home
124             Util.setProperty(properties, OSGiServerConstants.JETTY_HOME, jettyHomeDir.getAbsolutePath());
125         }
126         else if (jettyHomeBundleSysProp != null)
127         {
128             jettyHomeBundleSysProp = Util.resolvePropertyValue(jettyHomeBundleSysProp);
129             for (Bundle b : bundleContext.getBundles())
130             {
131                 if (b.getState() == Bundle.UNINSTALLED)
132                     continue;
133                 
134                 if (b.getSymbolicName().equals(jettyHomeBundleSysProp))
135                 {
136                     jettyHomeBundle = b;
137                     break;
138                 }
139             }
140             if (jettyHomeBundle == null)
141             {
142                 LOG.warn("Unable to find the jetty.home.bundle named " + jettyHomeSysProp);
143                 return null;
144             }
145         }
146         
147         if (jettyHomeDir == null && jettyHomeBundle == null)
148         {
149             LOG.warn("No default jetty created.");
150             return null;
151         }
152         
153         
154         
155         //configure the server here rather than letting the JettyServerServiceTracker do it, because we want to be able to
156         //configure the ThreadPool, which can only be done via the constructor, ie from within the xml configuration processing
157         List<URL> configURLs = jettyHomeDir != null ? getJettyConfigurationURLs(jettyHomeDir) : getJettyConfigurationURLs(jettyHomeBundle, properties);
158 
159         LOG.info("Configuring the default jetty server with {}",configURLs);
160         LOG.info("JETTY.HOME="+properties.get(OSGiServerConstants.JETTY_HOME));
161         ClassLoader contextCl = Thread.currentThread().getContextClassLoader();
162         try
163         {
164             Thread.currentThread().setContextClassLoader(JettyBootstrapActivator.class.getClassLoader());
165             
166             // these properties usually are the ones passed to this type of
167             // configuration.
168             properties.put(OSGiServerConstants.MANAGED_JETTY_SERVER_NAME, OSGiServerConstants.MANAGED_JETTY_SERVER_DEFAULT_NAME);
169             Util.setProperty(properties, OSGiServerConstants.JETTY_HOST, System.getProperty(OSGiServerConstants.JETTY_HOST));
170             Util.setProperty(properties, OSGiServerConstants.JETTY_PORT, System.getProperty(OSGiServerConstants.JETTY_PORT));
171             Util.setProperty(properties, OSGiServerConstants.JETTY_PORT_SSL, System.getProperty(OSGiServerConstants.JETTY_PORT_SSL));
172 
173             Server server = ServerInstanceWrapper.configure(null, configURLs, properties);
174             //ensure jetty.home is set
175             server.setAttribute(OSGiServerConstants.JETTY_HOME, properties.get(OSGiServerConstants.JETTY_HOME));
176             
177             //Register the default Server instance as an OSGi service.
178             //The JettyServerServiceTracker will notice it and set it up to deploy bundles as wars etc
179             bundleContext.registerService(Server.class.getName(), server, properties);
180             LOG.info("Default jetty server configured");
181             return server;
182         }
183         finally
184         {
185             Thread.currentThread().setContextClassLoader(contextCl);
186         }
187     }
188 
189     
190    
191     
192     /* ------------------------------------------------------------ */
193     /**
194      * Minimum setup for the location of the configuration files given a
195      * jettyhome folder. Reads the system property jetty.etc.config.urls and
196      * look for the corresponding jetty configuration files that will be used to
197      * setup the jetty server.
198      * 
199      * @param jettyhome
200      * @return
201      * @throws MalformedURLException 
202      */
203     private static List<URL> getJettyConfigurationURLs(File jettyhome) 
204     throws MalformedURLException
205     {
206         List<URL> configURLs = new ArrayList<URL>();
207         String jettyetc = System.getProperty(JETTY_ETC_FILES, DEFAULT_JETTY_ETC_FILES);
208         StringTokenizer tokenizer = new StringTokenizer(jettyetc, ";,", false);
209         while (tokenizer.hasMoreTokens())
210         {
211             String next = tokenizer.nextToken().trim();
212             //etc files can either be relative to jetty.home or absolute disk locations
213             if (!next.startsWith("/") && (next.indexOf(':') == -1))    
214                 configURLs.add(new File(jettyhome, next).toURI().toURL());
215             else 
216                 configURLs.add(new URL(next));
217         }
218         return configURLs;
219     }
220 
221     /* ------------------------------------------------------------ */
222     /**
223      * Minimum setup for the location of the configuration files given a
224      * configuration embedded inside a bundle. Reads the system property
225      * jetty.etc.config.urls and look for the corresponding jetty configuration
226      * files that will be used to setup the jetty server.
227      * 
228      * @param jettyhome
229      * @return
230      */
231     private static List<URL> getJettyConfigurationURLs(Bundle configurationBundle, Dictionary properties)
232     throws Exception
233     {
234         List<URL> configURLs = new ArrayList<URL>();
235         String files = System.getProperty(JETTY_ETC_FILES, DEFAULT_JETTY_ETC_FILES);       
236         StringTokenizer tokenizer = new StringTokenizer(files, ";,", false);
237 
238         while (tokenizer.hasMoreTokens())
239         {
240             String etcFile = tokenizer.nextToken().trim();
241 
242             //file path is absolute
243             if (etcFile.startsWith("/") || etcFile.indexOf(":") != -1)
244                 configURLs.add(new URL(etcFile));
245             else //relative file path
246             {
247                 Enumeration<URL> enUrls = BundleFileLocatorHelperFactory.getFactory().getHelper().findEntries(configurationBundle, etcFile);
248 
249                 String home = null;
250                 // default for org.eclipse.osgi.boot where we look inside
251                 // jettyhome/ for the default embedded configuration.
252                 if ((enUrls == null || !enUrls.hasMoreElements()))
253                 {
254                     home = DEFAULT_JETTYHOME;
255                     String tmp = DEFAULT_JETTYHOME+(DEFAULT_JETTYHOME.endsWith("/")?"":"/")+etcFile;
256                     enUrls = BundleFileLocatorHelperFactory.getFactory().getHelper().findEntries(configurationBundle, tmp);                    
257                     LOG.info("Configuring jetty from bundle: {} with {}", configurationBundle.getSymbolicName(),tmp);
258                 }          
259 
260                 //lazily ensure jetty.home value is set based on location of etc files
261                 if (properties.get(OSGiServerConstants.JETTY_HOME) == null)
262                 {
263                     Resource res = findDir(configurationBundle, home);
264                     if (res != null)
265                         properties.put(OSGiServerConstants.JETTY_HOME, res.toString());
266                 }
267          
268                 if (enUrls == null || !enUrls.hasMoreElements())
269                     throw new IllegalStateException ("Unable to locate a jetty configuration file for " + etcFile);
270 
271                 URL url = BundleFileLocatorHelperFactory.getFactory().getHelper().getFileURL(enUrls.nextElement());
272                 configURLs.add(url);
273            
274             }
275         }
276         return configURLs;
277     }
278     
279     /* ------------------------------------------------------------ */
280     /**
281      * Get a resource representing a directory inside a bundle. If the dir is null,
282      * return a resource representing the installation location of the bundle.
283      * @param bundle
284      * @param dir
285      * @return
286      */
287     public static Resource findDir (Bundle bundle, String dir)
288     {
289         if (bundle == null)
290             return null;
291 
292         try
293         {
294             File f = BundleFileLocatorHelperFactory.getFactory().getHelper().getBundleInstallLocation(bundle);
295             URL u = f.toURI().toURL();
296             u = BundleFileLocatorHelperFactory.getFactory().getHelper().getLocalURL(u);
297             Resource res = Resource.newResource(u);
298             String s = res.toString();
299    
300             //check if it is an unarchived bundle
301             if (s.endsWith(".jar") && s.startsWith("file:"))
302                 res = JarResource.newJarResource(res);
303             
304             //if looking for a directory 
305             if (dir != null)
306                 res = res.addPath(dir);
307             
308             return res;
309           
310         }
311         catch (Exception e)
312         {
313             LOG.warn("Bad bundle location" , e);
314             return null;
315         }
316     }
317 }