Package com.google.inject.servlet
Class FilterDefinition
java.lang.Object
com.google.inject.servlet.FilterDefinition
- All Implemented Interfaces:
Provider<FilterDefinition>
,ProviderWithExtensionVisitor<FilterDefinition>
,javax.inject.Provider<FilterDefinition>
An internal representation of a filter definition against a particular URI pattern.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AtomicReference<javax.servlet.Filter>
private final javax.servlet.Filter
private final Key<? extends javax.servlet.Filter>
private final UriPatternMatcher
-
Constructor Summary
ConstructorsConstructorDescriptionFilterDefinition
(Key<? extends javax.servlet.Filter> filterKey, UriPatternMatcher patternMatcher, Map<String, String> initParams, javax.servlet.Filter filterInstance) -
Method Summary
Modifier and TypeMethodDescription<B,
V> V acceptExtensionVisitor
(BindingTargetVisitor<B, V> visitor, ProviderInstanceBinding<? extends B> binding) Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method.void
get()
Provides an instance ofT
.(package private) javax.servlet.Filter
javax.servlet.Filter
getFilterIfMatching
(javax.servlet.http.HttpServletRequest request) void
init
(javax.servlet.ServletContext servletContext, Injector injector, Set<javax.servlet.Filter> initializedSoFar) private boolean
shouldFilter
(String uri)
-
Field Details
-
filterKey
-
patternMatcher
-
initParams
-
filterInstance
private final javax.servlet.Filter filterInstance -
filter
-
-
Constructor Details
-
FilterDefinition
public FilterDefinition(Key<? extends javax.servlet.Filter> filterKey, UriPatternMatcher patternMatcher, Map<String, String> initParams, javax.servlet.Filter filterInstance)
-
-
Method Details
-
get
Description copied from interface:Provider
Provides an instance ofT
.- Specified by:
get
in interfaceProvider<FilterDefinition>
- Specified by:
get
in interfacejavax.inject.Provider<FilterDefinition>
-
acceptExtensionVisitor
public <B,V> V acceptExtensionVisitor(BindingTargetVisitor<B, V> visitor, ProviderInstanceBinding<? extends B> binding) Description copied from interface:ProviderWithExtensionVisitor
Instructs the extension determine if the visitor is an instance of a custom extension visitor, and if so, visit it using that method. If the visitor is not an instance of the custom extension visitor, this method MUST call visitor.visit(binding).Due to issues with generics, the type parameters of this method do not relate to the type of the provider. In practice, the 'B' type will always be a supertype of 'T'.
- Specified by:
acceptExtensionVisitor
in interfaceProviderWithExtensionVisitor<FilterDefinition>
-
shouldFilter
-
init
public void init(javax.servlet.ServletContext servletContext, Injector injector, Set<javax.servlet.Filter> initializedSoFar) throws javax.servlet.ServletException - Throws:
javax.servlet.ServletException
-
destroy
-
getFilterIfMatching
public javax.servlet.Filter getFilterIfMatching(javax.servlet.http.HttpServletRequest request) -
getFilter
javax.servlet.Filter getFilter()
-