net.sf.mmm.util.nls.base

Class AbstractNlsResourceBundleJavaScriptServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.sf.mmm.util.component.base.AbstractLoggableHttpServlet

net.sf.mmm.util.nls.base.AbstractNlsResourceBundleJavaScriptServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

NlsResourceBundleJavaScriptServlet

public abstract class AbstractNlsResourceBundleJavaScriptServlet
extends AbstractLoggableHttpServlet

This is a HttpServlet that dynamically generates some JavaScript containing the content of NlsBundles and ResourceBundles for the users locale.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID
static String	URL_PARAM_NAME The query string for URL_PATH to query the bundle name as GET-parameter.
static String	URL_PARAM_NAME_QUERY The query string for URL_PATH to query the bundle name as GET-parameter.
static String	URL_PATH The URL path under which the bundle can be loaded.

Constructor Summary

Constructors

Constructor and Description
AbstractNlsResourceBundleJavaScriptServlet() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected String	escapeBundleKey(String key)
protected String	escapeBundleName(String name)
protected void	writeBundle(PrintWriter writer, String name, ResourceBundle bundle) This method writes the given ResourceBundle to the writer.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableHttpServlet

getLogger

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

URL_PATH

public static final String URL_PATH

The URL path under which the bundle can be loaded.

See Also:

Constant Field Values

URL_PARAM_NAME

public static final String URL_PARAM_NAME

The query string for URL_PATH to query the bundle name as GET-parameter.

See Also:

Constant Field Values

URL_PARAM_NAME_QUERY

public static final String URL_PARAM_NAME_QUERY

The query string for URL_PATH to query the bundle name as GET-parameter.

See Also:

Constant Field Values

Constructor Detail

AbstractNlsResourceBundleJavaScriptServlet

public AbstractNlsResourceBundleJavaScriptServlet()

The constructor.

Method Detail

doGet

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

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

writeBundle

protected void writeBundle(PrintWriter writer,
                           String name,
                           ResourceBundle bundle)

This method writes the given ResourceBundle to the writer.

Parameters:

writer - is the PrintWriter to use.

name - is the bundle name.

bundle - is the ResourceBundle for the users locale to write to the given writer.

escapeBundleKey

protected String escapeBundleKey(String key)

Parameters:

key - is the key to escape for JavaScript.

Returns:

the escaped key.

escapeBundleName

protected String escapeBundleName(String name)

Parameters:

name - is the bundle name to escape for JavaScript.

Returns:

the escaped name. As JavaScript does not accept periods (.) in variable names they are replaced with the dollar sign ($).