vif.properties
This document describes the application’s settings defined in the application’s properties file. You find these settings in $TOMCAT_HOME/webapps/vifapp/WEB-INF/conf/vif.properties [VIF production] or $INSTALL_DIR/vif_embedded/configuration/config.ini [VIF testing].
- Application i18n
- Application resources
- Bundle selection
- Application debugging
- Database connection configuration
- Search index configuration
- Mailhost configuration
- Forum configuration
- Application XML an XSL configuration
Application i18n
- org.hip.vif.dftLanguage
- The forum’s default language. The default language is displayed selected on the
forum’s login page. (Default: en).
Example: org.hip.vif.dftLanguage=en - org.hip.vif.dftCountry
- The forum’s default locale setting. This setting is used for date formatting. (Default: US).
Example: org.hip.vif.dftCountry=US - org.hip.vif.datePattern
- The pattern the user has to enter date values (in date fields).
Example: org.hip.vif.datePattern=MM/dd/yyyy - org.hip.vif.content.language
- The language in which the discussion takes place. This language setting is used to properly configure the search index (i.e. to select the Lucene indexer). (Default: en).
Example: org.hip.vif.content.language=de
Application resources
- org.hip.vif.docs.root
- The path to the documents in the file system. This path can be relative
to the base of the Servlet container.
Example: org.hip.vif.docs.root=./ - org.hip.vif.conf.root
- The path to the application’s configuration files in the file system.
This path can be relative to the base of the Servlet container.
Example: org.hip.vif.conf.root=./WEB-INF/conf/ - org.hip.vif.logPath
- The path to the application’s log files in the file system. This path
can be relative to the base of the Servlet container.
Example: org.hip.vif.logPath=./webapps/vifapp/logs
Bundle selection
- org.hip.vif.authenticator
- The bundle to use for member authentication. Note: The bundle has to provide an implementation of the org.hip.vifapp.authenticators extension point.
Example: org.hip.vif.authenticator=org.hip.vif.member.standard - org.hip.vif.memberSearcher
- The bundle to use when searching for members. Note: The bundle has to provide an implementation of the org.hip.vifapp.memberSearchers extension point.
Example: org.hip.vif.memberSearcher=org.hip.vif.member.standard - org.hip.vif.skin
- The bundle to use as default skin, i.e. when the application is started up for the first time. Note: The bundle has to provide an implementation of the org.hip.vifapp.skins extension point.
Example: org.hip.vif.skin=org.hip.vif.skin.default
Application debugging
- org.hip.vif.error.msg.basename
- The name of the properties file containing the application’s error messages. (Default: ErrorMessages).
Example: org.hip.vif.error.msg.basename=VIFErrMessages - org.hip.vif.smoke
- Switch to enable the smoke test (i.e. the web page containing useful information
about the actual configuration settings requested by http://localhost:8080/vifapp/admin?requestType=smoke).
Should be disabled in production.
Example: org.hip.vif.smoke=true -
-
- org.hip.vif.trace
- Switch to enable tracing of application processing. If turned on, messages
generated by the application are written into a rotating set of files with name tracerN.log (in the directory specified by the org.hip.vif.logPath property).
Default: true, should be disabled in production.
Example: org.hip.vif.trace=true - org.hip.vif.trace.format
- Format of the traced messages. Possible values are message
and complete. If message is set, only the message (without date/time information) is written.
(Default: complete).
Example: org.hip.vif.trace.format=complete - org.hip.error.log
- Switch to enable logging of error messages. If turned on, error messages encountered are written into a rotating
set of files with name errorN.log (in the directory specified by the org.hip.vif.logPath property).
Default: true.
Example: org.hip.error.log=true
Database connection configuration
- org.hip.vif.db.driver
- The JDBC driver to be used.
Example: org.hip.vif.db.driver=com.mysql.jdbc.Driver - org.hip.vif.db.url
- The URI to connect to the database.
Example: org.hip.vif.db.url=jdbc:mysql://localhost/vif - org.hip.vif.db.userId
- The user name defined for accessing the data.
Example: org.hip.vif.db.userId=DB_user - org.hip.vif.db.password
- The user’s password for accessing the data.
Example: org.hip.vif.db.password=DB_password
If you use an external database for user authentication, you have to provide the necessary information for that the application can connect to the external database.
- org.hip.vif.xmember.driver
- The JDBC driver to be used to connect to the external database.
Example: org.hip.vif.xmember.driver=oracle.jdbc.driver.OracleDriver - org.hip.vif.xmember.url
- The URI to connect to the external database.
Example: org.hip.vif.xmember.url=jdbc:oracle:thin:@my.org:1523:myorg - org.hip.vif.xmember.userId
- The user name defined for accessing the data in the external database.
Example: org.hip.vif.xmember.url=DB_user - org.hip.vif.xmember.password
- The user’s password for accessing the data the external database.
Example: org.hip.vif.xmember.password=DB_password
Search index configuration
- org.hip.vif.search.directory.db
- Switch to enable storing of Lucene search indexes in the database. Default
(false) is storing in the file system. Note: Building the search
index in the file system is about four time faster.
Example: org.hip.vif.search.directory.db=false
Mailhost configuration
- org.hip.vif.mail.host
- The mail host to use for sending the forum notifications.
Example: org.hip.vif.mail.host=localhost
Forum configuration
- org.hip.vif.guest.allowed
- Switch to allow read access for unauthenticated users. If enabled, read
access can be restricted on discussion group level.
Example: org.hip.vif.guest.allowed=true - org.hip.vif.password.display
- Switch to display the passwords generated by the application when they
are sent to the members. Should be disabled in production.
Example: org.hip.vif.password.display=false -
-
- org.hip.vif.forum.name
- Name of the discussion forum. This name is used when the application
sends mail to the members.
Example: org.hip.vif.forum.name=VIF - org.hip.vif.mail.address
- The discussion forum’s mail address. This information is used as sender’s
address when the application sends mail to the members.
Example: org.hip.vif.mail.address=nothing@my.site.org - org.hip.vif.mail.subjectId
- Prefix for mail subject line. This prefix is used for all mails the
application generates.
Example: org.hip.vif.mail.subjectId=[VIF] - org.hip.vif.mail.subjectText
- The default text for the mail’s subject line. The most generic mails
sent by the application use this subject text.
Example: org.hip.vif.mail.subjectText=Message from the forum administration - org.hip.vif.mail.naming
- The naming of the institution operating the discussion forum. The mails
generated by the application are sent on behalf of the institution named
here.
Example: org.hip.vif.mail.naming=The VIF Administration
Application XML an XSL configuration
- javax.xml.parsers.SAXParserFactory
- The Java factory for the SAX parser. You can use your preferred parser
if it is on the system’s classpath.
Example: javax.xml.parsers.SAXParserFactory= org.apache.xerces.jaxp.SAXParserFactoryImpl - javax.xml.parsers.DocumentBuilderFactory
- The Java factory for the DOM builder. You can use your preferred builder
if it is on the system’s classpath.
Example: javax.xml.parsers.DocumentBuilderFactory= org.apache.xerces.jaxp.DocumentBuilderFactoryImpl - javax.xml.transform.TransformerFactory
- The Java factory for the XSL transformer. You can use your preferred transformer
if it is on the system’s classpath.
Example: javax.xml.transform.TransformerFactory= org.apache.xalan.processor.TransformerFactoryImpl -
-