001: /*
002: * Copyright (c) JForum Team
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms,
006: * with or without modification, are permitted provided
007: * that the following conditions are met:
008: *
009: * 1) Redistributions of source code must retain the above
010: * copyright notice, this list of conditions and the
011: * following disclaimer.
012: * 2) Redistributions in binary form must reproduce the
013: * above copyright notice, this list of conditions and
014: * the following disclaimer in the documentation and/or
015: * other materials provided with the distribution.
016: * 3) Neither the name of "Rafael Steil" nor
017: * the names of its contributors may be used to endorse
018: * or promote products derived from this software without
019: * specific prior written permission.
020: *
021: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
022: * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
023: * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
024: * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
025: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
026: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
027: * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
028: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
029: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
030: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
031: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
032: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
033: * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
034: * IN CONTRACT, STRICT LIABILITY, OR TORT
035: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
036: * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
037: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
038: *
039: * Created on May 29, 2004 by pieter
040: * The JForum Project
041: * http://www.jforum.net
042: */
043: package net.jforum.util.preferences;
044:
045: /**
046: * Encapsulate all configuration keys in constants. This is more typesafe and provides
047: * a nice overview of all configuration keys. Last but not least this lets us autocomplete
048: * configuration keys under eclipse ;-)
049: *
050: * @author Pieter Olivier
051: * @version $Id: ConfigKeys.java,v 1.120 2007/09/21 15:54:30 rafaelsteil Exp $
052: */
053:
054: public class ConfigKeys {
055: public static final String LOGGED = "logged";
056: public static final String APPLICATION_PATH = "application.path";
057: public static final String INSTALLATION = "installation";
058: public static final String INSTALLED = "installed";
059:
060: public static final String INSTALLATION_CONFIG = "installation.config";
061: public static final String CACHEABLE_OBJECTS = "cacheable.objects";
062:
063: public static final String FILECHANGES_DELAY = "file.changes.delay";
064: public static final String DATABASE_PING_DELAY = "database.ping.delay";
065: public static final String DATABASE_CONNECTION_IMPLEMENTATION = "database.connection.implementation";
066: public static final String DATABASE_DRIVER_NAME = "database.driver.name";
067: public static final String DATABASE_DRIVER_CONFIG = "database.driver.config";
068: public static final String DATABASE_CONNECTION_HOST = "database.connection.host";
069: public static final String DATABASE_CONNECTION_USERNAME = "database.connection.username";
070: public static final String DATABASE_CONNECTION_PASSWORD = "database.connection.password";
071: public static final String DATABASE_CONNECTION_DBNAME = "database.connection.dbname";
072: public static final String DATABASE_CONNECTION_ENCODING = "dbencoding";
073: public static final String DATABASE_CONNECTION_DRIVER = "database.connection.driver";
074: public static final String DATABASE_CONNECTION_STRING = "database.connection.string";
075: public static final String DATABASE_CONNECTION_PORT = "database.connection.port";
076: public static final String DATABASE_POOL_MIN = "database.connection.pool.min";
077: public static final String DATABASE_POOL_MAX = "database.connection.pool.max";
078: public static final String DATABASE_USE_TRANSACTIONS = "database.use.transactions";
079: public static final String DATABASE_DATASOURCE_NAME = "database.datasource.name";
080: public static final String DATABASE_ERROR_PAGE = "database.error.page";
081: public static final String DATABASE_MYSQL_UNICODE = "mysql.unicode";
082: public static final String DATABASE_MYSQL_ENCODING = "mysql.encoding";
083: public static final String DATABASE_AUTO_KEYS = "database.support.autokeys";
084: public static final String DATABASE_SUPPORT_SUBQUERIES = "database.support.subqueries";
085: public static final String C3P0_EXTRA_PARAMS = "c3p0.extra.params";
086:
087: public static final String AUTHENTICATION_TYPE = "authentication.type";
088: public static final String SSO_IMPLEMENTATION = "sso.implementation";
089: public static final String LOGIN_AUTHENTICATOR = "login.authenticator";
090: public static final String LOGIN_AUTHENTICATOR_INSTANCE = "login.authenticator.instance";
091: public static final String TYPE_DEFAULT = "default";
092: public static final String TYPE_SSO = "sso";
093: public static final String AUTO_LOGIN_ENABLED = "auto.login.enabled";
094:
095: public static final String SSO_PASSWORD_ATTRIBUTE = "sso.password.attribute";
096: public static final String SSO_EMAIL_ATTRIBUTE = "sso.email.attribute";
097: public static final String SSO_DEFAULT_PASSWORD = "sso.default.password";
098: public static final String SSO_DEFAULT_EMAIL = "sso.default.email";
099: public static final String SSO_REDIRECT = "sso.redirect";
100:
101: public static final String RESOURCE_DIR = "resource.dir";
102: public static final String CONFIG_DIR = "config.dir";
103: public static final String DATABASE_PROPERTIES = "database.properties";
104: public static final String DATABASE_DRIVER_PROPERTIES = "database.driver.properties";
105: public static final String SQL_QUERIES_GENERIC = "sql.queries.generic";
106: public static final String SQL_QUERIES_DRIVER = "sql.queries.driver";
107:
108: public static final String TEMPLATES_MAPPING = "templates.mapping";
109: public static final String TEMPLATE_DIR = "template.dir";
110: public static final String ENCODING = "encoding";
111: public static final String DEFAULT_CONTAINER_ENCODING = "default.container.encoding";
112: public static final String SERVLET_NAME = "servlet.name";
113: public static final String DEFAULT_CONFIG = "default.config";
114: public static final String CONTEXT_NAME = "context.name";
115: public static final String SERVLET_EXTENSION = "servlet.extension";
116: public static final String COOKIE_NAME_DATA = "cookie.name.data";
117: public static final String COOKIE_NAME_USER = "cookie.name.user";
118: public static final String COOKIE_AUTO_LOGIN = "cookie.name.autologin";
119: public static final String COOKIE_USER_HASH = "cookie.name.userHash";
120:
121: public static final String ANONYMOUS_USER_ID = "anonymous.userId";
122: public static final String DEFAULT_USER_GROUP = "defaultUserGroup";
123: public static final String USER_HASH_SEQUENCE = "user.hash.sequence";
124: public static final String TOPICS_READ_TIME = "topics.tracking";
125: public static final String TOPICS_READ_TIME_BY_FORUM = "topics.tracking.byforum";
126:
127: public static final String TOPIC_CACHE_ENABLED = "topic.cache.enabled";
128: public static final String SECURITY_CACHE_ENABLED = "security.cache.enabled";
129:
130: public static final String VERSION = "version";
131: public static final String BACKGROUND_TASKS = "background.tasks";
132:
133: public static final String FORUM_LINK = "forum.link";
134: public static final String HOMEPAGE_LINK = "homepage.link";
135: public static final String FORUM_NAME = "forum.name";
136: public static final String FORUM_PAGE_TITLE = "forum.page.title";
137: public static final String FORUM_PAGE_METATAG_KEYWORDS = "forum.page.metatag.keywords";
138: public static final String FORUM_PAGE_METATAG_DESCRIPTION = "forum.page.metatag.description";
139:
140: public static final String TMP_DIR = "tmp.dir";
141: public static final String CACHE_DIR = "cache.dir";
142:
143: public static final String DAO_DRIVER = "dao.driver";
144:
145: public static final String DATE_TIME_FORMAT = "dateTime.format";
146: public static final String RSS_DATE_TIME_FORMAT = "rss.datetime.format";
147: public static final String RSS_ENABLED = "rss.enabled";
148: public static final String HOT_TOPIC_BEGIN = "hot.topic.begin";
149:
150: public static final String TOPICS_PER_PAGE = "topicsPerPage";
151: public static final String POSTS_PER_PAGE = "postsPerPage";
152: public static final String USERS_PER_PAGE = "usersPerPage";
153: public static final String RECENT_TOPICS = "topic.recent";
154: public static final String HOTTEST_TOPICS = "topic.hottest";
155: public static final String POSTS_CACHE_SIZE = "posts.cache.size";
156: public static final String POSTS_CACHE_ENABLED = "posts.cache.enabled";
157:
158: public static final String CAPTCHA_IGNORE_CASE = "captcha.ignore.case";
159: public static final String CAPTCHA_REGISTRATION = "captcha.registration";
160: public static final String CAPTCHA_POSTS = "captcha.posts";
161: public static final String CAPTCHA_WIDTH = "captcha.width";
162: public static final String CAPTCHA_HEIGHT = "captcha.height";
163: public static final String CAPTCHA_MIN_FONT_SIZE = "captcha.min.font.size";
164: public static final String CAPTCHA_MAX_FONT_SIZE = "captcha.max.font.size";
165: public static final String CAPTCHA_MIN_WORDS = "captcha.min.words";
166: public static final String CAPTCHA_MAX_WORDS = "captcha.max.words";
167:
168: public static final String I18N_DEFAULT = "i18n.board.default";
169: public static final String I18N_DEFAULT_ADMIN = "i18n.internal";
170: public static final String I18N_IMAGES_DIR = "i18n.images.dir";
171: public static final String LOCALES_DIR = "locales.dir";
172: public static final String LOCALES_NAMES = "locales.names";
173:
174: public static final String MAIL_LOST_PASSWORD_MESSAGE_FILE = "mail.lostPassword.messageFile";
175: public static final String MAIL_LOST_PASSWORD_SUBJECT = "mail.lostPassword.subject";
176: public static final String MAIL_NOTIFY_ANSWERS = "mail.notify.answers";
177: public static final String MAIL_SENDER = "mail.sender";
178: public static final String MAIL_CHARSET = "mail.charset";
179: public static final String MAIL_TEMPLATE_ENCODING = "mail.template.encoding";
180: public static final String MAIL_NEW_ANSWER_MESSAGE_FILE = "mail.newAnswer.messageFile";
181: public static final String MAIL_NEW_ANSWER_SUBJECT = "mail.newAnswer.subject";
182: public static final String MAIL_NEW_PM_SUBJECT = "mail.newPm.subject";
183: public static final String MAIL_NEW_PM_MESSAGE_FILE = "mail.newPm.messageFile";
184: public static final String MAIL_MESSSAGE_FORMAT = "mail.messageFormat";
185:
186: public static final String MAIL_POP3_DEBUG_KEEP_MESSAGES = "mail.pop3.debug.keep.messages";
187: public static final String MAIL_POP3_INTEGRATION_ENABLED = "mail.pop3.integration.enabled";
188:
189: public static final String MAIL_SMTP_AUTH = "mail.smtp.auth";
190: public static final String MAIL_SMTP_HOST = "mail.smtp.host";
191: public static final String MAIL_SMTP_PORT = "mail.smtp.port";
192:
193: public static final String MAIL_SMTP_SSL_AUTH = "mail.smtps.auth";
194: public static final String MAIL_SMTP_SSL_HOST = "mail.smtps.host";
195: public static final String MAIL_SMTP_SSL_PORT = "mail.smtps.port";
196: public static final String MAIL_SMTP_SSL_LOCALHOST = "mail.smtps.localhost";
197:
198: public static final String MAIL_SMTP_SSL = "mail.smtp.ssl";
199:
200: public static final String MAIL_SMTP_LOCALHOST = "mail.smtp.localhost";
201: public static final String MAIL_SMTP_USERNAME = "mail.smtp.username";
202: public static final String MAIL_SMTP_PASSWORD = "mail.smtp.password";
203: public static final String MAIL_SMTP_DELAY = "mail.smtp.delay";
204:
205: public static final String MAIL_USER_EMAIL_AUTH = "mail.user.email.auth";
206: public static final String MAIL_ACTIVATION_KEY_MESSAGE_FILE = "mail.activationKey.messageFile";
207: public static final String MAIL_ACTIVATION_KEY_SUBJECT = "mail.activationKey.subject";
208:
209: public static final String MAIL_NEW_TOPIC_MESSAGE_FILE = "mail.newTopic.messageFile";
210: public static final String MAIL_NEW_TOPIC_SUBJECT = "mail.newTopic.subject";
211:
212: public static final String HTML_TAGS_WELCOME = "html.tags.welcome";
213: public static final String HTML_ATTRIBUTES_WELCOME = "html.attributes.welcome";
214: public static final String HTML_LINKS_ALLOW_RELATIVE = "html.links.allow.relative";
215: public static final String HTML_LINKS_ALLOW_PROTOCOLS = "html.links.allow.protocols";
216:
217: public static final String SMILIE_IMAGE_DIR = "smilie.image.dir";
218: public static final String SMILIE_IMAGE_PATTERN = "smilie.image.pattern";
219:
220: public static final String AVATAR_MAX_WIDTH = "avatar.maxWidth";
221: public static final String AVATAR_MAX_HEIGHT = "avatar.maxHeight";
222: public static final String AVATAR_ALLOW_EXTERNAL_URL = "avatar.allow.external.url";
223:
224: public static final String MOST_USERS_EVER_ONLINE = "most.users.ever.online";
225: public static final String MOST_USER_EVER_ONLINE_DATE = "most.users.ever.online.date";
226:
227: public static final String JBOSS_CACHE_PROPERTIES = "jboss.cache.properties";
228: public static final String CACHE_IMPLEMENTATION = "cache.engine.implementation";
229:
230: public static final String ATTACHMENTS_MAX_POST = "attachments.max.post";
231: public static final String ATTACHMENTS_IMAGES_CREATE_THUMB = "attachments.images.createthumb";
232: public static final String ATTACHMENTS_IMAGES_MAX_THUMB_W = "attachments.images.thumb.maxsize.w";
233: public static final String ATTACHMENTS_IMAGES_MAX_THUMB_H = "attachments.images.thumb.maxsize.h";
234: public static final String ATTACHMENTS_IMAGES_THUMB_BOX_SHOW = "attachments.images.thumb.box.show";
235: public static final String ATTACHMENTS_ICON = "attachments.icon";
236: public static final String ATTACHMENTS_STORE_DIR = "attachments.store.dir";
237: public static final String ATTACHMENTS_UPLOAD_DIR = "attachments.upload.dir";
238: public static final String ATTACHMENTS_ANONYMOUS = "attachments.anonymous";
239:
240: public static final String AGREEMENT_SHOW = "agreement.show";
241: public static final String AGREEMENT_ACCEPTED = "agreement.accepted";
242: public static final String AGREEMENT_DEFAULT_FILE = "agreement.default.file";
243: public static final String AGREEMENT_FILES_PATH = "agreement.files.path";
244: public static final String REGISTRATION_ENABLED = "registration.enabled";
245: public static final String USERNAME_MAX_LENGTH = "username.max.length";
246:
247: public static final String QUARTZ_CONFIG = "quartz.config";
248:
249: public static final String QUARTZ_CONTEXT = "org.quartz.context.";
250: public static final String SEARCH_INDEXING_ENABLED = "search.indexing.enabled";
251: public static final String SEARCH_INDEXER_IMPLEMENTATION = "search.indexer.implementation";
252: public static final String SEARCH_INDEXER_CRON_EXPRESSON = "indexer.cron.expression";
253: public static final String EXTENSION_FIELD = "extension.field";
254:
255: public static final String LDAP_SECURITY_PROTOCOL = "ldap.security.protocol";
256: public static final String LDAP_AUTHENTICATION = "ldap.authentication";
257: public static final String LDAP_FACTORY = "ldap.factory";
258: public static final String LDAP_LOGIN_PREFIX = "ldap.login.prefix";
259: public static final String LDAP_LOGIN_SUFFIX = "ldap.login.suffix";
260: public static final String LDAP_SERVER_URL = "ldap.server.url";
261: public static final String LDAP_FIELD_EMAIL = "ldap.field.email";
262: public static final String LDAP_LOOKUP_PREFIX = "ldap.lookup.prefix";
263: public static final String LDAP_LOOKUP_SUFFIX = "ldap.lookup.suffix";
264:
265: public static final String CLICKSTREAM_CONFIG = "clickstream.config";
266: public static final String IS_BOT = "clickstream.is.bot";
267:
268: public static final String POSTS_NEW_DELAY = "posts.new.delay";
269: public static final String LAST_POST_TIME = "last.post.time";
270:
271: public static final String KARMA_MIN_POINTS = "karma.min.points";
272: public static final String KARMA_MAX_POINTS = "karma.max.points";
273:
274: public static final String MAIL_SUMMARY_SUBJECT = "mail.summary.weekly.subject";
275: public static final String MAIL_SUMMARY_FILE = "mail.summary.weekly.messageFile";
276: public static final String SUMMARY_DAYS_BEFORE = "summary.days.before";
277: public static final String SUMMARY_IS_ENABLED = "summary.enabled";
278:
279: public static final String STACKTRACE_MODERATORS_ONLY = "stacktrace.moderators.only";
280: public static final String JFORUM_VERSION_URL = "jforum.version.url";
281: public static final String REQUEST_IGNORE_CAPTCHA = "request.ignore.captcha";
282:
283: public static final String API_SECURITY_KEY = "api.security.key";
284: public static final String BANLIST_SEND_403FORBIDDEN = "banlist.send.403forbidden";
285:
286: public static final String LOGIN_IGNORE_XFORWARDEDHOST = "login.ignore.xforwardedhost";
287: public static final String LOGIN_IGNORE_REFERER = "login.ignore.referer";
288:
289: public static final String LUCENE_ANALYZER = "lucene.analyzer";
290: public static final String LUCENE_INDEX_WRITE_PATH = "lucene.index.write.path";
291: public static final String LUCENE_SETTINGS = "lucene.settings";
292: public static final String LUCENE_CURRENTLY_INDEXING = "lucene.currently.indexing";
293: public static final String LUCENE_INDEXER_RAM_NUMDOCS = "lucene.indexer.ram.numdocs";
294: public static final String LUCENE_INDEXER_DB_FETCH_COUNT = "lucene.indexer.db.fetch.count";
295:
296: public static final String MODERATION_LOGGING_ENABLED = "moderation.logging.enabled";
297: public static final String PROXIED_CONTEXT_PATH = "proxied.context.path";
298: public static final String REDIRECT_ABSOLUTE_PATHS = "redirect.absolute.paths";
299: public static final String REDIRECT_BASE_URL = "redirect.base.url";
300:
301: public static final String FREEMARKER_EXTRA_TEMPLATE_PATH = "freemarker.extra.template.path";
302:
303: private ConfigKeys() {
304: }
305: }
|