com.yammer.metrics.guice.servlet

Class AdminServletModule

java.lang.Object

com.google.inject.AbstractModule

com.google.inject.servlet.ServletModule

com.yammer.metrics.guice.servlet.AdminServletModule

All Implemented Interfaces:

com.google.inject.Module

public class AdminServletModule
extends com.google.inject.servlet.ServletModule

A guice servlet module that registers the AdminServlet via guice and also configures all healthchecks bound via guice to it. To use, install this module in your servlet module (or add as a separate module), and bind the health checks via a multi binder:

 install(new AdminServletModule());

 Multibinder<HealthCheck> healthChecksBinder = Multibinder.newSetBinder(binder(), HealthCheck.class);

 healthChecksBinder.addBinding().to(MyCoolHealthCheck.class);
 healthChecksBinder.addBinding().to(MyOtherCoolHealthCheck.class);
 
 

The module offers the same overloaded constructors to specifiy a custom JsonFactory and the uris for the healthcheck, metrics, etc. E.g.

 install(new AdminServletModule("/1.0/healthcheck", "/1.0/metrics", "/1.0/ping", "/1.0/threads"));
 
 

In order to use this module, you need the guice-servlet and guice-multibindings dependencies in addition to the normal guice dependency:

 <dependency>
   <groupId>com.google.inject</groupId>
   <artifactId>guice</artifactId>
   <version>3.0</version>
 </dependency>
 <dependency>
   <groupId>com.google.inject.extensions</groupId>
   <artifactId>guice-servlet</artifactId>
   <version>3.0</version>
 </dependency>
 <dependency>
   <groupId>com.google.inject.extensions</groupId>
   <artifactId>guice-multibindings</artifactId>
   <version>3.0</version>
 </dependency>
 
 

Nested Class Summary

Nested classes/interfaces inherited from class com.google.inject.servlet.ServletModule

com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder, com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder

Constructor Summary

Constructors

Constructor and Description
AdminServletModule()
AdminServletModule(com.fasterxml.jackson.core.JsonFactory jsonFactory)
AdminServletModule(com.fasterxml.jackson.core.JsonFactory jsonFactory, String healthcheckUri, String metricsUri, String pingUri, String threadsUri)
AdminServletModule(String healthcheckUri, String metricsUri, String pingUri, String threadsUri)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureServlets()

Methods inherited from class com.google.inject.servlet.ServletModule

configure, filter, filterRegex, getServletContext, serve, serveRegex

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

AdminServletModule

public AdminServletModule()

AdminServletModule

public AdminServletModule(com.fasterxml.jackson.core.JsonFactory jsonFactory)

AdminServletModule

public AdminServletModule(String healthcheckUri,
                  String metricsUri,
                  String pingUri,
                  String threadsUri)

AdminServletModule

public AdminServletModule(com.fasterxml.jackson.core.JsonFactory jsonFactory,
                  String healthcheckUri,
                  String metricsUri,
                  String pingUri,
                  String threadsUri)

Method Detail

configureServlets

protected void configureServlets()

Overrides:

configureServlets in class com.google.inject.servlet.ServletModule