com.google.inject.servlet

Class ServletDefinition

java.lang.Object

com.google.inject.servlet.ServletDefinition

All Implemented Interfaces:

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

public class ServletDefinition
extends Object
implements ProviderWithExtensionVisitor<ServletDefinition>

An internal representation of a servlet definition mapped to a particular URI pattern. Also performs the request dispatch to that servlet. How nice and OO =)

Author:

dhanji@gmail.com (Dhanji R. Prasanna)

Constructor Summary

Constructors

Constructor and Description
ServletDefinition(String pattern, Key<? extends javax.servlet.http.HttpServlet> servletKey, UriPatternMatcher patternMatcher, Map<String,String> initParams, javax.servlet.http.HttpServlet servletInstance)

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.http.HttpServlet> destroyedSoFar)
ServletDefinition	get() Provides an instance of T.
void	init(javax.servlet.ServletContext servletContext, Injector injector, Set<javax.servlet.http.HttpServlet> initializedSoFar)
boolean	service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) Wrapper around the service chain to ensure a servlet is servicing what it must and provides it with a wrapped request.
String	toPaddedString(int padding)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletDefinition

public ServletDefinition(String pattern,
                         Key<? extends javax.servlet.http.HttpServlet> servletKey,
                         UriPatternMatcher patternMatcher,
                         Map<String,String> initParams,
                         javax.servlet.http.HttpServlet servletInstance)

Method Detail

get

public ServletDefinition get()

Description copied from interface: Provider

Provides an instance of T. Must never return null.

Specified by:

get in interface javax.inject.Provider<ServletDefinition>

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<ServletDefinition>

init

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

Throws:

javax.servlet.ServletException

destroy

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

service

public boolean service(javax.servlet.ServletRequest servletRequest,
                       javax.servlet.ServletResponse servletResponse)
                throws IOException,
                       javax.servlet.ServletException

Wrapper around the service chain to ensure a servlet is servicing what it must and provides it with a wrapped request.

Returns:

Returns true if this servlet triggered for the given request. Or false if guice-servlet should continue dispatching down the servlet pipeline.

Throws:

IOException - If thrown by underlying servlet

javax.servlet.ServletException - If thrown by underlying servlet

toPaddedString

public String toPaddedString(int padding)