public class ServletModule extends AbstractModule
You should subclass this module to register servlets and
filters in the configureServlets() method.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ServletModule.FilterKeyBindingBuilder
See the EDSL examples at
configureServlets() |
static interface |
ServletModule.ServletKeyBindingBuilder
See the EDSL examples at
configureServlets() |
| Constructor and Description |
|---|
ServletModule() |
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBindingprotected final void configure()
AbstractModuleBinder via the exposed methods.configure in class AbstractModuleprotected void configureServlets()
Part of the EDSL builder language for configuring servlets and filters with guice-servlet. Think of this as an in-code replacement for web.xml. Filters and servlets are configured here using simple java method calls. Here is a typical example of registering a filter when creating your Guice injector:
Guice.createInjector(..., new ServletModule() {
@Override
protected void configureServlets() {
serve("*.html").with(MyServlet.class)
}
}
This registers a servlet (subclass of HttpServlet) called MyServlet to service
any web pages ending in .html. You can also use a path-style syntax to register
servlets:
serve("/my/*").with(MyServlet.class)
Every servlet (or filter) is required to be a singleton. If you cannot annotate the class
directly, you should add a separate bind(..).in(Singleton.class) rule elsewhere in
your module. Mapping a servlet that is bound under any other scope is an error.
Guice.createInjector(..., new ServletModule() {
@Override
protected void configureServlets() {
filter("/*").through(MyFilter.class);
filter("*.css").through(MyCssFilter.class);
filter("*.jpg").through(new MyJpgFilter());
// etc..
serve("*.html").with(MyServlet.class);
serve("/my/*").with(MyServlet.class);
serve("*.jpg").with(new MyServlet());
// etc..
}
}
This will traverse down the list of rules in lexical order. For example, a url
"/my/file.js" (after it runs through the matching filters) will first
be compared against the servlet mapping:
serve("*.html").with(MyServlet.class);
And failing that, it will descend to the next servlet mapping:
serve("/my/*").with(MyServlet.class);
Since this rule matches, Guice Servlet will dispatch to MyServlet. These
two mapping rules can also be written in more compact form using varargs syntax:
serve("*.html", "/my/*").with(MyServlet.class);
This way you can map several URI patterns to the same servlet. A similar syntax is
also available for filter mappings.
serveRegex("(.)*ajax(.)*").with(MyAjaxServlet.class)
This will map any URI containing the text "ajax" in it to MyAjaxServlet. Such as:
<init-param> tag in web.xml. You can similarly pass in parameters to
Servlets and filters registered in Guice-servlet using a Map of parameter
name/value pairs. For example, to initialize MyServlet with two parameters
(name="Dhanji", site="google.com") you could write:
Map<String, String> params = new HashMap<String, String>();
params.put("name", "Dhanji");
params.put("site", "google.com");
...
serve("/*").with(MyServlet.class, params)
...
filter("/*").through(Key.get(Filter.class, Fave.class));
Where Filter.class refers to the Servlet API interface and Fave.class is a
custom binding annotation. Elsewhere (in one of your own modules) you can bind this
filter's implementation:
bind(Filter.class).annotatedWith(Fave.class).to(MyFilterImpl.class);See
Binder for more information on binding syntax.
Guice Servlet allows you to register several instances of ServletModule to your
injector. The order in which these modules are installed determines the dispatch order
of filters and the precedence order of servlets. For example, if you had two servlet modules,
RpcModule and WebServiceModule and they each contained a filter that mapped
to the same URI pattern, "/*":
In RpcModule:
filter("/*").through(RpcFilter.class);
In WebServiceModule:
filter("/*").through(WebServiceFilter.class);
Then the order in which these filters are dispatched is determined by the order in which
the modules are installed:
install(new WebServiceModule()); install(new RpcModule());In the case shown above
WebServiceFilter will run first.protected final ServletModule.FilterKeyBindingBuilder filter(String urlPattern, String... morePatterns)
urlPattern - Any Servlet-style pattern. examples: /*, /html/*, *.html, etc.protected final ServletModule.FilterKeyBindingBuilder filter(Iterable<String> urlPatterns)
urlPatterns - Any Servlet-style patterns. examples: /*, /html/*, *.html, etc.protected final ServletModule.FilterKeyBindingBuilder filterRegex(String regex, String... regexes)
regex - Any Java-style regular expression.protected final ServletModule.FilterKeyBindingBuilder filterRegex(Iterable<String> regexes)
regexes - Any Java-style regular expressions.protected final ServletModule.ServletKeyBindingBuilder serve(String urlPattern, String... morePatterns)
urlPattern - Any Servlet-style pattern. examples: /*, /html/*, *.html, etc.protected final ServletModule.ServletKeyBindingBuilder serve(Iterable<String> urlPatterns)
urlPatterns - Any Servlet-style patterns. examples: /*, /html/*, *.html, etc.protected final ServletModule.ServletKeyBindingBuilder serveRegex(String regex, String... regexes)
regex - Any Java-style regular expression.protected final ServletModule.ServletKeyBindingBuilder serveRegex(Iterable<String> regexes)
regexes - Any Java-style regular expressions.protected final ServletContext getServletContext()