How to portably read configuration data from a servlet

Question

I'm writing a Java servlet that needs to read some site-specific configuration data; I would like it to be easily accessible/modifiable by the sysadmins at deployment time. There is no sensible default, so the data needs to be provided by the site admin. It consists of a few string key/value pairs (think Properties). It would only be read once (at initialization time).

I'm aware of this SO question and the ServletContext.getInitParameter() mechanism, but as far as my understanding goes, they require the data to be bundled in the servlet package (either as a properties file, or specified in the web.xml), which makes it inconvenient to upgrade the servlet code.

Is there any "standard" interface for a servlet to get this kind of key/value configuration data? It would be ok if the programming interface is the same everywhere, but the actual way of setting the configuration data depends on the actual servlet container being used.

I'm looking preferably at portable solutions, but I'd be content with something that only works in Tomcat and Jetty.

Thanks!

Answer 1

• Configure the external location of the properties - either via a jvm argument (when starting the servlet container), or in the web.xml

• in the external location use config.properties and read it with java.util.Properties

Answer 2

You may take Preferences or hack with user.home, user.dir, etc. But for a few key/value keep things simple.

Write a small Singleton to wrap around Properties and load them from a fix & absolute location

public class LocalConfig extends Properties {

  public static LocalConfig $ = new LocalConfig();

  private LocalConfig() throws IOException {
    load(new File("/etc/myconfig.properties"));
  }

}

Answer 3

The recommended way to configure an application server for a web application is per JNDI.

Every application server (including Jetty and Tomcat) allows you to configure JNDI parameters.

For Jetty you can add the following to your jetty.xml to add the JNDI parameter param.file:

<!--  JNDI java:comp/env --> 
<New id="param.file" class="org.mortbay.jetty.plus.naming.EnvEntry">
  <Arg>param.file</Arg> 
  <Arg type="java.lang.String"><SystemProperty name="jetty.home" default="."/>etc/config.properties</Arg> 
  <Arg type="boolean">true</Arg> 
</New> 

Then in your servlet you can read the JNDI parameter:

import javax.naming.InitialContext;
import javax.naming.NamingException;

...

public Object readJndi(String paramName) {
  Object jndiValue = null;
  try {
    final InitialContext ic = new InitialContext();
    jndiValue = ic.lookup("java:comp/env/" + paramName);
  } catch (NamingException e) {
    // handle exception
  }
  return jndiValue;
}


public String getConfigPath() {
  return (String) readJndi("param.file");
}

The way to set JNDI values differs for other application servers but the code to read the configuration is always the same.

Answer 4

The Servlet init parameters are the right (and standardized) way of defining properties which can be configured by the administrator. Many of the application servers provide a GUI backend where the parameters can be configured.

For an example for Tomcat, see http://stackoverflow.com/questions/1626018/defining-tomcat-servlet-init-parameters