Package com.google.inject.servlet
Servlet API scopes, bindings and registration; this extension requires
guice-servlet.jar
.
Apply GuiceFilter
to any servlets which will use the servlet
scopes. Install ServletModule
into your Injector
to install everything at once.
-
Interface Summary Interface Description FilterPipeline An internal dispatcher for guice-servlet registered servlets and filters.InstanceFilterBinding A binding to a single instance of a filter.InstanceServletBinding A binding to a single instance of a servlet.LinkedFilterBinding A linked binding to a filter.LinkedServletBinding A linked binding to a servlet.RequestScoper Object that can be used to apply a request scope to a block of code.RequestScoper.CloseableScope Closeable subclass that does not throw any exceptions from close.ServletModule.FilterKeyBindingBuilder See the EDSL examples atServletModule.configureServlets()
ServletModule.ServletKeyBindingBuilder See the EDSL examples atServletModule.configureServlets()
ServletModuleBinding A binding created byServletModule
.ServletModuleTargetVisitor<T,V> A visitor for the servlet extension.UriPatternMatcher A general interface for matching a URI against a URI pattern. -
Class Summary Class Description AbstractServletModuleBinding<T> Abstract implementation for all servlet module bindingsContinuingHttpServletRequest A wrapper for requests that makes requests immutable, taking a snapshot of the original request.ContinuingHttpServletRequest.ImmutableCookie DefaultFilterPipeline This default pipeline simply dispatches to web.xml's servlet pipeline.FilterChainInvocation A Filter chain impl which basically passes itself to the "current" filter and iterates the chain ondoFilter()
.FilterDefinition An internal representation of a filter definition against a particular URI pattern.FiltersModuleBuilder Builds the guice module that binds configured filters, with their wrapper FilterDefinitions.GuiceFilter Apply this filter in web.xml above all other filters (typically), to all requests where you plan to use servlet scopes.GuiceFilter.Context GuiceServletContextListener As of Guice 2.0 you can still use (your subclasses of)GuiceServletContextListener
class as a logical place to create and configure your injector.InstanceFilterBindingImpl Default implementation of InstanceFilterBinding.InstanceServletBindingImpl Default implementation of InstanceServletBinding.InternalServletModule This is a left-factoring of all ServletModules installed in the system.InternalServletModule.BackwardsCompatibleServletContextProvider Special Provider that tries to obtain an injected servlet context, specific to the current injector, failing which, it falls back to the static singleton instance that is available in the legacy Guice Servlet.LinkedFilterBindingImpl Default implementation of LinkedFilterBinding.LinkedServletBindingImpl Default implementation of LinkedServletBinding.ManagedFilterPipeline Central routing/dispatch class handles lifecycle of managed filters, and delegates to the servlet pipeline.ManagedServletPipeline A wrapping dispatcher for servlets, in much the same way asManagedFilterPipeline
is for filters.ManagedServletPipeline.RequestDispatcherRequestWrapper ServletDefinition An internal representation of a servlet definition mapped to a particular URI pattern.ServletModule Configures the servlet scopes and creates bindings for the servlet API objects so you can inject the request, response, session, etc.ServletScopes Servlet scopes.ServletScopes.Context ServletScopes.RequestScope ServletScopes.SessionScope ServletsModuleBuilder Builds the guice module that binds configured servlets, with their wrapper ServletDefinitions.ServletUtils Some servlet utility methods.ServletUtils.ByteAccumulator Accumulates byte sequences while decoding strings, and encodes them into a StringBuilder.UriPatternType.RegexUriPatternMatcher Matches URIs using a regular expression.UriPatternType.ServletStyleUriPatternMatcher Matches URIs using the pattern grammar of the Servlet API and web.xml. -
Enum Summary Enum Description ServletScopes.NullObject A sentinel attribute value representing null.UriPatternType An enumeration of the available URI-pattern matching stylesUriPatternType.ServletStyleUriPatternMatcher.Kind -
Exception Summary Exception Description ScopingException Exception thrown when there was a failure entering request scope. -
Annotation Types Summary Annotation Type Description RequestParameters Apply this to field or parameters of typeMap<String, String[]>
when you want the HTTP request parameter map to be injected.RequestScoped Apply this to implementation classes when you want one instance per request.ScopingOnly Annotates aGuiceFilter
that provides scope functionality, but doesn't dispatch toServletModule
bound servlets or filters.SessionScoped Apply this to implementation classes when you want one instance per session.