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;
20  
21  /**
22   * OSGiServerConstants
23   * 
24   * Name of the properties that configure a jetty Server OSGi service.
25   */
26  public class OSGiServerConstants
27  {
28      /**
29       * Usual system property used as the hostname for a typical jetty
30       * configuration.
31       */
32      public static final String JETTY_HOME = "jetty.home";
33      public static final String JETTY_BASE = "jetty.base";
34  
35      /**
36       * System property to point to a bundle that embeds a jetty configuration
37       * and that jetty configuration should be the default jetty server. First we
38       * look for jetty.home. If we don't find it then we look for this property.
39       */
40      public static final String JETTY_HOME_BUNDLE = "jetty.home.bundle";
41  
42      /**
43       * Usual system property used as the hostname for a typical jetty
44       * configuration.
45       */
46      public static final String JETTY_HOST = "jetty.http.host";
47  
48      /**
49       * Usual system property used as the port for http for a typical jetty
50       * configuration.
51       */
52      public static final String JETTY_PORT = "jetty.http.port";
53  
54      /**
55       * Usual system property used as the port for https for a typical jetty
56       * configuration.
57       */
58      public static final String JETTY_PORT_SSL = "jetty.ssl.port";
59  
60      //for managed jetty instances, name of the configuration parameters
61      /**
62       * PID of the jetty servers's ManagedFactory
63       */
64      public static final String MANAGED_JETTY_SERVER_FACTORY_PID = "org.eclipse.jetty.osgi.boot.managedserverfactory";
65      
66      /**
67       * The associated value of that configuration parameter is the name under which this
68       * instance of the jetty server is tracked.
69       * When a ContextHandler is deployed and it specifies the managedServerName property, it is deployed
70       * on the corresponding jetty managed server or it throws an exception: jetty server not available.
71       */
72      public static final String MANAGED_JETTY_SERVER_NAME = "managedServerName";
73      /**
74       * Name of the 'default' jetty server instance.
75       * Usually the first one to be created.
76       */
77      public static final String MANAGED_JETTY_SERVER_DEFAULT_NAME = "defaultJettyServer";
78      
79      /**
80       * List of URLs to the jetty.xml files that configure th server.
81       */
82      public static final String MANAGED_JETTY_XML_CONFIG_URLS = "jetty.etc.config.urls";
83      
84      /**
85       * List of URLs to the folders where the legacy J2EE shared libraries are stored aka lib/ext, lib/jsp etc.
86       */
87      public static final String MANAGED_JETTY_SHARED_LIB_FOLDER_URLS = "managedJettySharedLibFolderUrls";
88  }