io.soabase.guice

Class JerseyGuiceModule

java.lang.Object

com.google.inject.AbstractModule

io.soabase.guice.JerseyGuiceModule

All Implemented Interfaces:

com.google.inject.Module

public class JerseyGuiceModule
extends com.google.inject.AbstractModule

Provides much of the functionality of the Guice ServletModule (https://github.com/google/guice/wiki/ServletModule). All registrations are forwarded to the appropriate Dropwizard/Jersey/Jetty methods.

heavily copied from Guice Servlet

Constructor Summary

Constructors

Constructor and Description
JerseyGuiceModule()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Configurable<?>	configurable()
protected void	configure()
protected void	configureServlets() Servlet Mapping EDSL
protected FilterKeyBindingBuilder	filter(String... urlPatterns)
javax.servlet.http.HttpServletRequest	provideHttpServletRequest()
javax.servlet.http.HttpServletResponse	provideHttpServletResponse()
javax.servlet.http.HttpSession	provideHttpSession()
Map<String,String[]>	provideParameterMap()
javax.ws.rs.container.ContainerRequestContext	providesContainerRequestContext()
javax.servlet.ServletContext	provideServletContext()
org.glassfish.jersey.server.ExtendedResourceContext	providesExtendedResourceContext()
javax.ws.rs.core.HttpHeaders	providesHttpHeaders()
org.glassfish.jersey.message.MessageBodyWorkers	providesMessageBodyWorkers()
javax.ws.rs.core.Request	providesRequest()
javax.ws.rs.container.ResourceContext	providesResourceContext()
javax.ws.rs.core.SecurityContext	providesSecurityContext()
javax.ws.rs.core.UriInfo	providesUriInfo()
protected ServletKeyBindingBuilder	serve(String... urlPatterns)

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyGuiceModule

public JerseyGuiceModule()

Method Detail

configurable

protected javax.ws.rs.core.Configurable<?> configurable()

filter

protected final FilterKeyBindingBuilder filter(String... urlPatterns)

serve

protected final ServletKeyBindingBuilder serve(String... urlPatterns)

configure

protected final void configure()

Specified by:

configure in class com.google.inject.AbstractModule

configureServlets

protected void configureServlets()

Servlet Mapping EDSL

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.

Initialization Parameters

Servlets (and filters) allow you to pass in init params using the <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)
 

Binding Keys

You can also bind keys rather than classes. This lets you hide implementations with package-local visbility and expose them using only a Guice module and an annotation:

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

provideHttpServletRequest

@Provides
public javax.servlet.http.HttpServletRequest provideHttpServletRequest()

provideHttpServletResponse

@Provides
public javax.servlet.http.HttpServletResponse provideHttpServletResponse()

provideServletContext

@Provides
public javax.servlet.ServletContext provideServletContext()

provideHttpSession

@Provides
public javax.servlet.http.HttpSession provideHttpSession()

provideParameterMap

@Provides
public Map<String,String[]> provideParameterMap()

providesContainerRequestContext

@Provides
public javax.ws.rs.container.ContainerRequestContext providesContainerRequestContext()

providesExtendedResourceContext

@Provides
public org.glassfish.jersey.server.ExtendedResourceContext providesExtendedResourceContext()

providesResourceContext

@Provides
public javax.ws.rs.container.ResourceContext providesResourceContext()

providesRequest

@Provides
public javax.ws.rs.core.Request providesRequest()

providesUriInfo

@Provides
public javax.ws.rs.core.UriInfo providesUriInfo()

providesHttpHeaders

@Provides
public javax.ws.rs.core.HttpHeaders providesHttpHeaders()

providesMessageBodyWorkers

@Provides
public org.glassfish.jersey.message.MessageBodyWorkers providesMessageBodyWorkers()

providesSecurityContext

@Provides
public javax.ws.rs.core.SecurityContext providesSecurityContext()