public abstract class AbstractHttpServlet extends HttpServlet implements ResourceConnector
Also implements Groovy's ResourceConnector
in a dynamic
manner. It allows you to modify the resource name that is searched for with a
replace all operation. See Pattern
and
Matcher
for details.
The servlet init parameter names are:
"resource.name.regex" = empty - defaults to null resource.name.replacement = empty - defaults to null resource.name.replace.all = true (default) | false means replaceFirst()Note: If you specify a regex, you have to specify a replacement string too! Otherwise an exception gets raised.
This implementation provides a verbosity flag switching log statements. The servlet init parameter name is:
verbose = false(default) | true
In order to support class-loading-troubles-debugging with Tomcat 4 or higher, you can log the class loader responsible for loading some classes. See GROOVY-861 for details. The servlet init parameter name is:
log.GROOVY861 = false(default) | true
If you experience class-loading-troubles with Tomcat 4 (or higher) or any other servlet container using custom class loader setups, you can fallback to use (slower) reflection in Groovy's MetaClass implementation. Please contact the dev team with your problem! Thanks. The servlet init parameter name is:
reflection = false(default) | true
Modifier and Type | Field and Description |
---|---|
static String |
CONTENT_TYPE_TEXT_HTML
Content type of the HTTP response.
|
protected String |
encoding
Encoding to use, becomes charset part of contentType.
|
static String |
INC_PATH_INFO
Servlet API include key name: path_info
|
static String |
INC_REQUEST_URI |
static String |
INC_SERVLET_PATH
Servlet API include key name: servlet_path
|
static String |
INIT_PARAM_RESOURCE_NAME_REGEX |
static String |
INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS |
protected String |
namePrefix
a.fink: it was in
removeNamePrefix(java.lang.String) , but was extracted to var for optimization |
protected boolean |
reflection
Mirrors the static value of the reflection flag in MetaClass.
|
protected Pattern |
resourceNamePattern
Either
null or a compiled pattern read from ""resource.name.regex""
and used in getScriptUri(HttpServletRequest) . |
protected boolean |
resourceNameReplaceAll
The replace method to use on the matcher.
|
protected String |
resourceNameReplacement
The replacement used by the resource name matcher.
|
protected ServletContext |
servletContext
Servlet (or the web application) context.
|
protected boolean |
verbose
Controls almost all log output.
|
Constructor and Description |
---|
AbstractHttpServlet()
Initializes all fields with default values.
|
Modifier and Type | Method and Description |
---|---|
protected String |
applyResourceNameMatcher(String uri) |
protected void |
generateNamePrefixOnce() |
URLConnection |
getResourceConnection(String name)
Interface method for ResourceContainer.
|
protected String |
getScriptUri(HttpServletRequest request)
Returns the include-aware uri of the script or template file.
|
protected File |
getScriptUriAsFile(HttpServletRequest request)
Parses the http request for the real script or template source file.
|
void |
init(ServletConfig config)
Overrides the generic init method to set some debug flags.
|
protected String |
removeNamePrefix(String name) |
protected void |
setVariables(ServletBinding binding)
Override this method to set your variables to the Groovy binding.
|
doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
public static final String INIT_PARAM_RESOURCE_NAME_REGEX
public static final String INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS
public static final String CONTENT_TYPE_TEXT_HTML
public static final String INC_PATH_INFO
public static final String INC_REQUEST_URI
public static final String INC_SERVLET_PATH
protected ServletContext servletContext
protected Pattern resourceNamePattern
null
or a compiled pattern read from ""resource.name.regex""
and used in getScriptUri(HttpServletRequest)
.protected String resourceNameReplacement
protected boolean resourceNameReplaceAll
true - replaceAll(resourceNameReplacement); (default) false - replaceFirst(resourceNameReplacement);
protected boolean verbose
protected String encoding
protected boolean reflection
protected String namePrefix
removeNamePrefix(java.lang.String)
, but was extracted to var for optimizationpublic AbstractHttpServlet()
protected void generateNamePrefixOnce()
protected String removeNamePrefix(String name) throws ResourceException
ResourceException
public URLConnection getResourceConnection(String name) throws ResourceException
getResourceConnection
in interface ResourceConnector
ResourceException
protected String getScriptUri(HttpServletRequest request)
request
- the http request to analyzeprotected File getScriptUriAsFile(HttpServletRequest request)
request
- the http request to analyzenull
if the
servlet container cannot translate the virtual path to a real
path for any reason (such as when the content is being made
available from a .war archive).public void init(ServletConfig config) throws ServletException
init
in interface Servlet
init
in class GenericServlet
config
- the servlet configuration provided by the containerServletException
- if init() method defined in super class
javax.servlet.GenericServlet throws itprotected void setVariables(ServletBinding binding)
All variables bound the binding are passed to the template source text, e.g. the HTML file, when the template is merged.
The binding provided by TemplateServlet does already include some default
variables. As of this writing, they are (copied from
ServletBinding
):
And via implicit hard-coded keywords:
The binding also provides convenient methods:
Example binding all servlet context variables:
class MyServlet extends TemplateServlet {
protected void setVariables(ServletBinding binding) {
// Bind a simple variable
binding.setVariable("answer", new Long(42));
// Bind all servlet context attributes...
ServletContext context = (ServletContext) binding.getVariable("context");
Enumeration enumeration = context.getAttributeNames();
while (enumeration.hasMoreElements()) {
String name = (String) enumeration.nextElement();
binding.setVariable(name, context.getAttribute(name));
}
}
}
binding
- to be modified