View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.engine;
18  
19  /***
20   * This interface contains all the constants for the engine.
21   *
22   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
23   * @version $Id: JetspeedEngineConstants.java 516448 2007-03-09 16:25:47Z ate $
24   */
25  public interface JetspeedEngineConstants
26  {
27      /***
28       * <p>The prefix used to denote the namespace reserved for and
29       * used by Jetspeed-specific configuration parameters (such as
30       * those passed in via servlet container's config file
31       * (<code>server.xml</code>), or the web app deployment descriptor
32       * (<code>web.xml</code>).</p>
33       *
34       * <p>For example, a parameter in the Jetspeed namespace would be
35       * <code>org.apache.jetspeed.loggingRoot</code>.</p>
36       */
37      public static final String CONFIG_NAMESPACE = "org.apache.jetspeed";
38  
39      /*** The key for the Log4J File */
40      public static final String LOG4J_CONFIG_FILE = "log4j.file";
41  
42      /*** The default value for the Log4J File */
43      public static final String LOG4J_CONFIG_FILE_DEFAULT = "/WEB-INF/conf/Log4j.properties";
44  
45      /*** This is the default log file to be used for logging */
46      public static final String DEFAULT_LOGGER = "jetspeed";
47      public static final String CONSOLE_LOGGER = "console";
48  
49      /***
50       * The logging facility which captures output from the SchedulerService.
51       */
52      public static final String SCHEDULER_LOG_FACILITY = "scheduler";
53  
54      /***
55       * SMTP server uses to send mail.
56       */
57      public static final String MAIL_SERVER_KEY = "mail.server";
58  
59  
60      /*** Default Value for the Logging Directory, relative to the webroot */
61      public static final String LOGGING_ROOT_DEFAULT = "/logs";
62      public static final String LOGGING_ROOT = "loggingRoot";
63  
64      public static final String JETSPEED_PROPERTIES_KEY = "properties";
65      public static final String JETSPEED_PROPERTIES_DEFAULT = "/WEB-INF/conf/jetspeed.properties";
66  
67      /*** If this value is set as applicationRoot, then the webContext is used
68       * as application root
69       */
70      public static final String WEB_CONTEXT = "webContext";
71  
72      /*** Key for the Path to the Resources.properties File */
73      public static final String APPLICATION_ROOT_KEY = "applicationRoot";
74  
75      /*** Default Value for the Path to the Resources.properties File */
76      public static final String APPLICATION_ROOT_DEFAULT = WEB_CONTEXT;
77  
78      /*** This is the key used in the jetspeed.properties to access resources
79       * relative to the Web Application root. It might differ from the
80       * Application root, but the normal case is, that the webapp root
81       * and the application root point to the same path.
82       */
83      public static final String WEBAPP_ROOT_KEY = "webappRoot";
84  
85      public static final String PIPELINE_CLASS = "pipeline.class";
86      public static final String PIPELINE_DEFAULT = "pipeline.default";
87      public static final String PIPELINE_DIRECTORY = "pipeline.directory";
88  
89      /***
90       * This specifies the factory to use the Jetspeed java.util.prefs.Preferences
91       * implementation.
92       */
93      public static final String PREFERENCES_FACTORY = "preferences.factory";
94      public static final String PREFERENCES_FACTORY_DEFAULT =
95          "org.apache.jetspeed.spi.services.prefs.impl.PreferencesFactoryImpl";
96  
97  }