View Javadoc
1 package org.apache.turbine; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 /*** 58 * This interface contains all the constants used throughout 59 * the Turbine code base. 60 * 61 * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> 62 */ 63 public interface TurbineConstants 64 { 65 /*** 66 * The logging facility which captures output from Peers. 67 */ 68 public static final String SQL_LOG_FACILITY = "sql"; 69 70 /*** 71 * The logging facility which captures output from the SchedulerService. 72 */ 73 public static final String SCHEDULER_LOG_FACILITY = "scheduler"; 74 75 /*** 76 * SMTP server Turbine uses to send mail. 77 */ 78 public static final String MAIL_SERVER_KEY = "mail.server"; 79 80 /*** 81 * Property that controls whether Turbine modules are 82 * cached or not. 83 */ 84 public static final String MODULE_CACHE = "module.cache"; 85 86 /*** 87 * The size of the actions cache if module caching is on. 88 */ 89 public static final String ACTION_CACHE_SIZE = "action.cache.size"; 90 91 /*** 92 * The size of the layout cache if module caching is on. 93 */ 94 public static final String LAYOUT_CACHE_SIZE = "layout.cache.size"; 95 96 /*** 97 * The size of the navigation cache if module caching is on. 98 */ 99 public static final String NAVIGATION_CACHE_SIZE = "navigation.cache.size"; 100 101 /*** 102 * The size of the actions page if module caching is on. 103 */ 104 public static final String PAGE_CACHE_SIZE = "page.cache.size"; 105 106 /*** 107 * The size of the actions cache if module caching is on. 108 */ 109 public static final String SCREEN_CACHE_SIZE = "screen.cache.size"; 110 111 /*** 112 * The size of the actions cache if module caching is on. 113 */ 114 public static final String SCHEDULED_JOB_CACHE_SIZE = "scheduledjob.cache.size"; 115 116 /*** 117 * The packages where Turbine will look for modules. 118 * This is effectively Turbine's classpath. 119 */ 120 public static final String MODULE_PACKAGES = "module.packages"; 121 122 /*** 123 * JDBC database driver. 124 */ 125 public static final String DB_DRIVER = "database.default.driver"; 126 127 /*** 128 * JDBC database URL. 129 */ 130 public static final String DB_URL = "database.default.url"; 131 132 /*** 133 * JDBC username. 134 */ 135 public static final String DB_USERNAME = "database.default.username"; 136 137 /*** 138 * JDBC password. 139 */ 140 public static final String DB_PASSWORD = "database.default.password"; 141 142 /*** 143 * Maximum number of connections to pool. 144 */ 145 public static final String DB_MAXCONNECTIONS = "database.maxConnections"; 146 147 /*** 148 * Expiry time of database connections. 149 */ 150 public static final String DB_EXPIRYTIME = "database.expiryTime"; 151 152 /*** 153 * How long a connection request will wait before giving up. 154 */ 155 public static final String DB_CONNECTION_WAIT_TIMEOUT = "database.connectionWaitTimeout"; 156 157 /*** 158 * How often the PoolBrokerServer logs the status of the pool. 159 */ 160 public static final String DB_CONNECTION_LOG_INTERVAL = "database.logInterval"; 161 162 /*** 163 * Database adaptor. 164 */ 165 public static final String DB_ADAPTOR = "database.adaptor"; 166 167 /*** 168 * Indicates that the id broker will generate more ids 169 * if the demand is high. 170 */ 171 public static final String DB_IDBROKER_CLEVERQUANTITY = "database.idbroker.cleverquantity"; 172 173 /*** 174 * Home page template. 175 */ 176 public static final String TEMPLATE_HOMEPAGE = "template.homepage"; 177 178 /*** 179 * Login template. 180 */ 181 public static final String TEMPLATE_LOGIN = "template.login"; 182 183 /*** 184 * Login error template. 185 */ 186 public static final String TEMPLATE_ERROR = "template.error"; 187 188 /*** 189 * Home page screen. 190 */ 191 public static final String SCREEN_HOMEPAGE = "screen.homepage"; 192 193 /*** 194 * Login screen. 195 */ 196 public static final String SCREEN_LOGIN = "screen.login"; 197 198 /*** 199 * Login error screen. 200 */ 201 public static final String SCREEN_ERROR = "screen.error"; 202 public static final String SCREEN_INVALID_STATE = "screen.invalidstate"; 203 public static final String TEMPLATE_INVALID_STATE = "template.invalidstate"; 204 205 /*** 206 * Action to perform when a user logs in. 207 */ 208 public static final String ACTION_LOGIN = "action.login"; 209 210 /*** 211 * Action to perform when a user logs out. 212 */ 213 public static final String ACTION_LOGOUT = "action.logout"; 214 215 /*** 216 * Actions that performs session validation. 217 */ 218 public static final String ACTION_SESSION_VALIDATOR = "action.sessionvalidator"; 219 220 /*** 221 * I don't think this is being used, is it? 222 */ 223 public static final String ACTION_ACCESS_CONTROLLER = "action.accesscontroller"; 224 225 /*** 226 * Default layout. 227 */ 228 public static final String LAYOUT_DEFAULT = "layout.default"; 229 230 /*** 231 * Default page. 232 */ 233 public static final String PAGE_DEFAULT = "page.default"; 234 235 /*** 236 * Map building. This will probably be Torque generated at 237 * some point. 238 */ 239 public static final String MAPS_BUILDER = "database.maps.builder"; 240 241 /*** 242 * Message to display upon successful login. 243 */ 244 public static final String LOGIN_MESSAGE = "login.message"; 245 246 /*** 247 * Message to display when a user fails to login. 248 */ 249 public static final String LOGIN_ERROR = "login.error"; 250 251 /*** 252 * Message to display when screens variable invalid. 253 */ 254 public static final String LOGIN_MESSAGE_NOSCREEN = "login.message.noscreen"; 255 256 /*** 257 * Message to display when a user logs out. 258 */ 259 public static final String LOGOUT_MESSAGE = "logout.message"; 260 261 /*** 262 * Indicate whether this Turbine application is using SSL. 263 * Used for creating dynamic URIs. 264 */ 265 public static final String USE_SSL = "use.ssl"; 266 267 /*** 268 * Should the PP fold the case of everything. Possible values are 269 * "upper", "lower" and "none". 270 */ 271 public static final String PP_URL_CASE_FOLDING = "url.case.folding"; 272 273 /*** 274 * Default document type. 275 */ 276 public static final String DEFAULT_DOCUMENT_TYPE = "default.doctype"; 277 278 public static final String APPLICATION_ROOT = "applicationRoot"; 279 public static final String WEBAPP_ROOT = "webappRoot"; 280 }

This page was automatically generated by Maven