com.google.inject.servlet

Class FilterDefinition

java.lang.Object

com.google.inject.servlet.FilterDefinition

All Implemented Interfaces:

ProviderWithExtensionVisitor<FilterDefinition>, javax.inject.Provider<FilterDefinition>

public class FilterDefinition
extends Object
implements ProviderWithExtensionVisitor<FilterDefinition>

An internal representation of a filter definition against a particular URI pattern.

Author:

dhanji@gmail.com (Dhanji R. Prasanna)

Constructor Summary

Constructors

Constructor and Description
FilterDefinition(String pattern, Key<? extends javax.servlet.Filter> filterKey, UriPatternMatcher patternMatcher, Map<String,String> initParams, javax.servlet.Filter filterInstance)

Method Summary

Modifier and Type	Method and Description
<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	destroy(Set<javax.servlet.Filter> destroyedSoFar)
FilterDefinition	get() Provides an instance of T.
javax.servlet.Filter	getFilterIfMatching(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.ServletContext servletContext, Injector injector, Set<javax.servlet.Filter> initializedSoFar)
String	toPaddedString(int padding)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterDefinition

public FilterDefinition(String pattern,
                        Key<? extends javax.servlet.Filter> filterKey,
                        UriPatternMatcher patternMatcher,
                        Map<String,String> initParams,
                        javax.servlet.Filter filterInstance)

Method Detail

get

public FilterDefinition get()

Description copied from interface: Provider

Provides an instance of T. Must never return null.

Specified by:

get in interface javax.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 interface ProviderWithExtensionVisitor<FilterDefinition>

init

public void init(javax.servlet.ServletContext servletContext,
                 Injector injector,
                 Set<javax.servlet.Filter> initializedSoFar)
          throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

destroy

public void destroy(Set<javax.servlet.Filter> destroyedSoFar)

getFilterIfMatching

public javax.servlet.Filter getFilterIfMatching(javax.servlet.http.HttpServletRequest request)

toPaddedString

public String toPaddedString(int padding)