org.apache.velocity.tools.view
Interface JeeConfig

All Known Implementing Classes:

JeeContextConfig, JeeFilterConfig, JeeServletConfig

public interface JeeConfig

Because sometimes you don't care about the difference between a servlet and a filter. Why isn't there a common interface for FilterConfig and ServletConfig already? Sheesh.

Anyway, this also adds the ability to fake everything if you don't have either a FilterConfig or a ServletConfig handy. Just implement it and override the methods that return things you care about. Oh, and if you don't have any init-params at all, just use JeeContextConfig as ServletContext is the only really essential thing for creating a VelocityView.

Since:

2.0

Version:

$Id$

Method Summary

java.lang.String	findInitParameter(java.lang.String key) Looks for the specified init-param in the servlet/filter config (i.e.
java.lang.String	getInitParameter(java.lang.String name) Returns an initialization parameter.
java.util.Enumeration	getInitParameterNames() Returns all the parameter names.
java.lang.String	getName() Returns the name of the servlet (or filter) being used.
javax.servlet.ServletContext	getServletContext() Returns the servlet context.

Method Detail

getInitParameter

java.lang.String getInitParameter(java.lang.String name)

Returns an initialization parameter.

Parameters:

name - The name of the initialization parameter.

Returns:

The value of the parameter.

findInitParameter

java.lang.String findInitParameter(java.lang.String key)

Looks for the specified init-param in the servlet/filter config (i.e. calls getInitParameter(java.lang.String)). If no such init-param is found there, it checks the ServletContext's init-params for the specified parameter.

Parameters:

key - The name of the initialization parameter.

Returns:

The value of the initialization parameter.

getInitParameterNames

java.util.Enumeration getInitParameterNames()

Returns all the parameter names.

Returns:

The enumeration containing the parameter names.

getName

java.lang.String getName()

Returns the name of the servlet (or filter) being used.

Returns:

The name of the configuration.

getServletContext

javax.servlet.ServletContext getServletContext()

Returns the servlet context.

Returns:

The servlet context.