Package nl.vpro.web.servlet

Class ConfigurationServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

nl.vpro.web.servlet.ConfigurationServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class ConfigurationServlet
extends jakarta.servlet.http.HttpServlet

Serves a 'configuration.js' for javascript clients. Expects an init param "name" with that it determines the 'environment' via

• Either it is the system property vpro.[name].env
• If that is missing it is the application context variable vpro/[name]/env
• If that is missing too, it is ConfigurationServlet.Environment.PROD

Then it loads properties from all of:

• The resource [name].properties
• The resource [name].[env];properties (if exists)
• The file /WEB-INF/classes/[name].properties (if exists)
• The file /WEB-INF/classes/[name].[env];properties (if exists)
• The file ${user.home}/conf/[name].properties (if exists)
• The file ${user.home}/conf/[name].[env];properties (if exists)

while it overrides already defined ones.

The result is then, together with some other properties returned in a javascript structure.

Since:

0.3

Author:

Michiel Meeuwissen

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	ConfigurationServlet.Environment

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,Map<String,String>>	SYSTEM_PROP_MAP

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
ConfigurationServlet()

Method Summary

Modifier and Type	Method	Description
protected void	doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
static Context	getContext()
protected ConfigurationServlet.Environment	getEnvironment()
protected long	getLastModified(jakarta.servlet.http.HttpServletRequest req)
protected String	getName()
protected Map<String,Object>	getProperties(jakarta.servlet.http.HttpServletRequest req)
static Map<String,Object>	getProperties(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request)
protected Map<String,String>	getSystem(jakarta.servlet.http.HttpServletRequest req)
void	init()
protected void	merge(jakarta.servlet.http.HttpServletRequest req, File file, Map<String,Object> map)
protected void	merge(jakarta.servlet.http.HttpServletRequest req, InputStream is, Map<String,Object> map)
protected void	mergeServletContextResource(jakarta.servlet.http.HttpServletRequest req, String path, Map<String,Object> map)
protected void	write(String varName, @NonNull OutputStream outputStream, @NonNull Map<String,String> system, @NonNull Map<String,Object> props)

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, init, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SYSTEM_PROP_MAP

protected static final Map<String,Map<String,String>> SYSTEM_PROP_MAP

Constructor Details

ConfigurationServlet

public ConfigurationServlet()

Method Details

getContext

public static Context getContext()
                          throws NamingException

Throws:

NamingException

getProperties

public static Map<String,Object> getProperties(jakarta.servlet.ServletContext context,
 jakarta.servlet.http.HttpServletRequest request)

init

public void init()

Overrides:

init in class jakarta.servlet.GenericServlet

getLastModified

protected long getLastModified(jakarta.servlet.http.HttpServletRequest req)

Overrides:

getLastModified in class jakarta.servlet.http.HttpServlet

doGet

protected void doGet(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp)
              throws IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

IOException

write

protected void write(String varName,
 @NonNull OutputStream outputStream,
 @NonNull Map<String,String> system,
 @NonNull Map<String,Object> props)
              throws IOException

Throws:

IOException

merge

protected void merge(jakarta.servlet.http.HttpServletRequest req,
 InputStream is,
 Map<String,Object> map)
              throws IOException

Throws:

IOException

merge

protected void merge(jakarta.servlet.http.HttpServletRequest req,
 File file,
 Map<String,Object> map)
              throws IOException

Throws:

IOException

mergeServletContextResource

protected void mergeServletContextResource(jakarta.servlet.http.HttpServletRequest req,
 String path,
 Map<String,Object> map)
                                    throws IOException

Throws:

IOException

getSystem

protected Map<String,String> getSystem(jakarta.servlet.http.HttpServletRequest req)
                                throws IOException

Throws:

IOException

getEnvironment

protected ConfigurationServlet.Environment getEnvironment()

getProperties

protected Map<String,Object> getProperties(jakarta.servlet.http.HttpServletRequest req)
                                    throws IOException

Throws:

IOException

getName

protected String getName()