Java > Open Source Codes > net > jforum > util > preferences > ConfigKeys


1 /*
2  * Copyright (c) Rafael Steil
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms,
6  * with or without modification, are permitted provided
7  * that the following conditions are met:
8  *
9  * 1) Redistributions of source code must retain the above
10  * copyright notice, this list of conditions and the
11  * following disclaimer.
12  * 2) Redistributions in binary form must reproduce the
13  * above copyright notice, this list of conditions and
14  * the following disclaimer in the documentation and/or
15  * other materials provided with the distribution.
16  * 3) Neither the name of "Rafael Steil" nor
17  * the names of its contributors may be used to endorse
18  * or promote products derived from this software without
19  * specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34  * IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  *
39  * Created on May 29, 2004 by pieter
40  * The JForum Project
41  * http://www.jforum.net
42  */
43 package net.jforum.util.preferences;
44
45 /**
46 * Encapsulate all configuration keys in constants. This is more typesafe and provides
47 * a nice overview of all configuration keys. Last but not least this lets us autocomplete
48 * configuration keys under eclipse ;-)
49 *
50 * @author Pieter Olivier
51 * @version $Id: ConfigKeys.java,v 1.85 2006/02/06 17:18:24 iper Exp $
52 */
53
54 public class ConfigKeys
55 {
56
57     public static final String APPLICATION_PATH = "application.path";
58     public static final String INSTALLATION = "installation";
59     public static final String INSTALLED = "installed";
60
61     public static final String INSTALLATION_CONFIG = "installation.config";
62     public static final String CACHEABLE_OBJECTS = "cacheable.objects";
63     
64     public static final String FILECHANGES_DELAY = "file.changes.delay";
65     public static final String DATABASE_PING_DELAY = "database.ping.delay";
66     public static final String DATABASE_CONNECTION_IMPLEMENTATION = "database.connection.implementation";
67     public static final String DATABASE_DRIVER_NAME = "database.driver.name";
68     public static final String DATABASE_DRIVER_CONFIG = "database.driver.config";
69     public static final String DATABASE_CONNECTION_HOST = "database.connection.host";
70     public static final String DATABASE_CONNECTION_USERNAME = "database.connection.username";
71     public static final String DATABASE_CONNECTION_PASSWORD = "database.connection.password";
72     public static final String DATABASE_CONNECTION_DBNAME = "database.connection.dbname";
73     public static final String DATABASE_CONNECTION_ENCODING = "dbencoding";
74     public static final String DATABASE_CONNECTION_DRIVER = "database.connection.driver";
75     public static final String DATABASE_CONNECTION_STRING = "database.connection.string";
76     public static final String DATABASE_POOL_MIN = "database.connection.pool.min";
77     public static final String DATABASE_POOL_MAX = "database.connection.pool.max";
78     public static final String DATABASE_USE_TRANSACTIONS = "database.use.transactions";
79     public static final String DATABASE_DATASOURCE_NAME = "database.datasource.name";
80     public static final String DATABASE_ERROR_PAGE = "database.error.page";
81     public static final String DATABASE_MYSQL_UNICODE = "mysql.unicode";
82     public static final String DATABASE_MYSQL_ENCODING = "mysql.encoding";
83     public static final String DATABASE_AUTO_KEYS = "database.support.autokeys";
84     public static final String DATABASE_SUPPORT_SUBQUERIES = "database.support_subqueries";
85     
86     public static final String AUTHENTICATION_TYPE = "authentication.type";
87     public static final String SSO_IMPLEMENTATION = "sso.implementation";
88     public static final String LOGIN_AUTHENTICATOR = "login.authenticator";
89     public static final String TYPE_DEFAULT = "default";
90     public static final String TYPE_SSO = "sso";
91     public static final String AUTO_LOGIN_ENABLED = "auto.login.enabled";
92     
93     public static final String SSO_PASSWORD_ATTRIBUTE = "sso.password.attribute";
94     public static final String SSO_EMAIL_ATTRIBUTE = "sso.email.attribute";
95     public static final String SSO_DEFAULT_PASSWORD = "sso.default.password";
96     public static final String SSO_DEFAULT_EMAIL = "sso.default.email";
97     public static final String SSO_REDIRECT = "sso.redirect";
98     
99     public static final String RESOURCE_DIR = "resource.dir";
100     public static final String CONFIG_DIR = "config.dir";
101     public static final String DATABASE_PROPERTIES = "database.properties";
102     public static final String DATABASE_DRIVER_PROPERTIES = "database.driver.properties";
103     public static final String SQL_QUERIES_GENERIC = "sql.queries.generic";
104     public static final String SQL_QUERIES_DRIVER = "sql.queries.driver";
105
106     public static final String TEMPLATES_MAPPING = "templates.mapping";
107     public static final String TEMPLATE_DIR = "template.dir";
108     public static final String ENCODING = "encoding";
109     public static final String DEFAULT_CONTAINER_ENCODING = "default.container.encoding";
110     public static final String SERVLET_NAME = "servlet.name";
111     public static final String DEFAULT_CONFIG = "default.config";
112     public static final String CONTEXT_NAME = "context.name";
113     public static final String SERVLET_EXTENSION = "servlet.extension";
114     public static final String COOKIE_NAME_DATA = "cookie.name.data";
115     public static final String COOKIE_NAME_USER = "cookie.name.user";
116     public static final String COOKIE_AUTO_LOGIN = "cookie.name.autologin";
117     public static final String COOKIE_USER_HASH = "cookie.name.userHash";
118         
119     public static final String ANONYMOUS_USER_ID = "anonymous.userId";
120     public static final String DEFAULT_USER_GROUP = "defaultUserGroup";
121     public static final String USER_HASH_SEQUENCE = "user.hash.sequence";
122     public static final String TOPICS_TRACKING = "topics.tracking";
123     
124     public static final String TOPIC_CACHE_ENABLED = "topic.cache.enabled";
125     public static final String SECURITY_CACHE_ENABLED = "security.cache.enabled";
126     public static final String FORUM_CACHE_ENABLED = "forum.cache.enabled";
127
128     public static final String VERSION = "version";
129     public static final String BACKGROUND_TASKS = "background.tasks";
130     public static final String REQUEST_DUMP = "request.dump";
131
132     public static final String FORUM_LINK = "forum.link";
133     public static final String HOMEPAGE_LINK = "homepage.link";
134     public static final String FORUM_NAME = "forum.name";
135     public static final String FORUM_PAGE_TITLE = "forum.page.title";
136     public static final String FORUM_PAGE_METATAG_KEYWORDS = "forum.page.metatag.keywords";
137     public static final String FORUM_PAGE_METATAG_DESCRIPTION = "forum.page.metatag.description";
138
139     public static final String TMP_DIR = "tmp.dir";
140     public static final String CACHE_DIR = "cache.dir";
141
142     public static final String DAO_DRIVER = "dao.driver";
143
144     public static final String DATE_TIME_FORMAT = "dateTime.format";
145     public static final String RSS_DATE_TIME_FORMAT = "rss.datetime.format";
146     public static final String RSS_ENABLED = "rss.enabled";
147     public static final String HOT_TOPIC_BEGIN = "hot.topic.begin";
148
149     public static final String TOPICS_PER_PAGE = "topicsPerPage";
150     public static final String POST_PER_PAGE = "postsPerPage";
151     public static final String USERS_PER_PAGE = "usersPerPage";
152     public static final String RECENT_TOPICS = "topic.recent";
153     public static final String POSTS_CACHE_SIZE = "posts.cache.size";
154     public static final String POSTS_CACHE_ENABLED = "posts.cache.enabled";
155
156     public static final String CAPTCHA_REGISTRATION = "captcha.registration";
157     public static final String CAPTCHA_POSTS = "captcha.posts";
158     public static final String CAPTCHA_WIDTH = "captcha.width";
159     public static final String CAPTCHA_HEIGHT = "captcha.height";
160     public static final String CAPTCHA_MIN_FONT_SIZE = "captcha.min.font.size";
161     public static final String CAPTCHA_MAX_FONT_SIZE = "captcha.max.font.size";
162     public static final String CAPTCHA_MIN_WORDS = "captcha.min.words";
163     public static final String CAPTCHA_MAX_WORDS = "captcha.max.words";
164     
165     public static final String I18N_DEFAULT = "i18n.board.default";
166     public static final String I18N_DEFAULT_ADMIN = "i18n.internal";
167     public static final String I18N_IMAGES_DIR = "i18n.images.dir";
168     public static final String LOCALES_DIR = "locales.dir";
169     public static final String LOCALES_NAMES = "locales.names";
170
171     public static final String MAIL_LOST_PASSWORD_MESSAGE_FILE = "mail.lostPassword.messageFile";
172     public static final String MAIL_LOST_PASSWORD_SUBJECT = "mail.lostPassword.subject";
173     public static final String MAIL_NOTIFY_ANSWERS = "mail.notify.answers";
174     public static final String MAIL_SENDER = "mail.sender";
175     public static final String MAIL_CHARSET = "mail.charset";
176     public static final String MAIL_TEMPLATE_ENCODING = "mail.template.encoding";
177     public static final String MAIL_NEW_ANSWER_MESSAGE_FILE = "mail.newAnswer.messageFile";
178     public static final String MAIL_NEW_ANSWER_SUBJECT = "mail.newAnswer.subject";
179     public static final String MAIL_NEW_PM_SUBJECT = "mail.newPm.subject";
180     public static final String MAIL_NEW_PM_MESSAGE_FILE = "mail.newPm.messageFile";
181     public static final String MAIL_MESSSAGE_FORMAT = "mail.messageFormat";
182     public static final String MAIL_SMTP_AUTH = "mail.smtp.auth";
183     public static final String MAIL_SMTP_HOST = "mail.smtp.host";
184     public static final String MAIL_SMTP_PORT = "mail.smtp.port";
185     public static final String MAIL_SMTP_LOCALHOST = "mail.smtp.localhost";
186     public static final String MAIL_SMTP_USERNAME = "mail.smtp.username";
187     public static final String MAIL_SMTP_PASSWORD = "mail.smtp.password";
188     public static final String MAIL_USER_EMAIL_AUTH = "mail.user.email.auth";
189     public static final String MAIL_ACTIVATION_KEY_MESSAGE_FILE = "mail.activationKey.messageFile";
190     public static final String MAIL_ACTIVATION_KEY_SUBJECT = "mail.activationKey.subject";
191
192     public static final String MAIL_NEW_TOPIC_MESSAGE_FILE = "mail.newTopic.messageFile";
193     public static final String MAIL_NEW_TOPIC_SUBJECT = "mail.newTopic.subject";
194
195     public static final String HTML_TAGS_WELCOME = "html.tags.welcome";
196
197     public static final String SMILIE_IMAGE_DIR = "smilie.image.dir";
198     public static final String SMILIE_IMAGE_PATTERN = "smilie.image.pattern";
199
200     public static final String AVATAR_MAX_WIDTH = "avatar.maxWidth";
201     public static final String AVATAR_MAX_HEIGHT = "avatar.maxHeight";
202
203     public static final String MOST_USERS_EVER_ONLINE = "most.users.ever.online";
204     public static final String MOST_USER_EVER_ONLINE_DATE = "most.users.ever.online.date";
205     
206     public static final String JBOSS_CACHE_PROPERTIES = "jboss.cache.properties";
207     public static final String CACHE_IMPLEMENTATION = "cache.engine.implementation";
208     
209     public static final String ATTACHMENTS_MAX_POST = "attachments.max.post";
210     public static final String ATTACHMENTS_IMAGES_CREATE_THUMB = "attachments.images.createthumb";
211     public static final String ATTACHMENTS_IMAGES_MAX_THUMB_W = "attachments.images.thumb.maxsize.w";
212     public static final String ATTACHMENTS_IMAGES_MAX_THUMB_H = "attachments.images.thumb.maxsize.h";
213     public static final String ATTACHMENTS_IMAGES_THUMB_BOX_SHOW = "attachments.images.thumb.box.show";
214     public static final String ATTACHMENTS_ICON = "attachments.icon";
215     public static final String ATTACHMENTS_DOWNLOAD_MODE = "attachments.download.mode";
216     public static final String ATTACHMENTS_STORE_DIR = "attachments.store.dir";
217     public static final String ATTACHMENTS_UPLOAD_DIR = "attachments.upload.dir";
218     public static final String ATTACHMENTS_ANONYMOUS = "attachments.anonymous";
219     
220     public static final String REGISTRATION_ENABLED = "registration.enabled";
221     public static final String USERNAME_MAX_LENGTH = "username.max.length";
222
223     public static final String QUARTZ_CONTEXT = "org.quartz.context.";
224     public static final String SEARCH_INDEXING_ENABLED = "search.indexing.enabled";
225     public static final String SEARCH_INDEXER_IMPLEMENTATION = "search.indexer.implementation";
226     public static final String SEARCH_INDEXER_QUARTZ_CONFIG = "search.indexer.quartz.config";
227     public static final String SEARCH_INDEXER_CRON_EXPRESSON = "indexer.cron.expression";
228     public static final String SEARCH_LAST_POST_ID = "last.post.id";
229     public static final String SEARCH_INDEXER_STEP = "indexer.step";
230     public static final String SEARCH_MIN_WORD_SIZE = "search.min.word.size";
231     public static final String SEARCH_MAX_WORD_SIZE = "search.max.word.size";
232     public static final String SEARCH_WORD_MATCHING = "search.word.matching";
233     public static final String SEARCH_WORD_FILTER_REGEX = "search.word.filter.regex";
234     public static final String SEARCH_MAX_WORDS_MESSAGE = "search.max.words.message";
235     
236     public static final String TOPIC_TIME_FIELD = "topic.time.field";
237     public static final String EXTENSION_FIELD = "extension.field";
238     
239     public static final String LDAP_SECURITY_PROTOCOL = "ldap.security.protocol";
240     public static final String LDAP_AUTHENTICATION = "ldap.authentication";
241     public static final String LDAP_FACTORY = "ldap.factory";
242     public static final String LDAP_LOGIN_PREFIX = "ldap.login.prefix";
243     public static final String LDAP_LOGIN_SUFFIX = "ldap.login.suffix";
244     public static final String LDAP_SERVER_URL = "ldap.server.url";
245     public static final String LDAP_FIELD_EMAIL = "ldap.field.email";
246     public static final String LDAP_LOOKUP_PREFIX = "ldap.lookup.prefix";
247     public static final String LDAP_LOOKUP_SUFFIX = "ldap.lookup.suffix";
248     
249     public static final String CLICKSTREAM_CONFIG = "clickstream.config";
250     public static final String IS_BOT = "clickstream.is.bot";
251
252     public static final String POSTS_NEW_DELAY = "posts.new.delay";
253     public static final String LAST_POST_TIME = "last.post.time";
254
255     public static final String KARMA_MIN_POINTS = "karma.min.points";
256     public static final String KARMA_MAX_POINTS = "karma.max.points";
257     
258     public static final String MAIL_SUMMARY_SUBJECT = "mail.summary.weekly.subject";
259     public static final String MAIL_SUMMARY_FILE = "mail.summary.weekly.messageFile";
260     public static final String SUMMARY_DAYS_BEFORE = "summary.days.before";
261     public static final String SUMMARY_IS_ENABLED = "summary.enabled";
262     
263     public static final String STACKTRACE_MODERATORS_ONLY = "stacktrace.moderators.only";
264     public static final String JFORUM_VERSION_URL = "jforum.version.url";
265     
266     private ConfigKeys() {}
267 }
268

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags