Package io.dropwizard.core.setup

Class AdminEnvironment

java.lang.Object

io.dropwizard.jetty.setup.ServletEnvironment

io.dropwizard.core.setup.AdminEnvironment

public class AdminEnvironment
extends ServletEnvironment

The administrative environment of a Dropwizard application.

Constructor Summary

Constructors

Constructor	Description
AdminEnvironment(MutableServletContextHandler handler, com.codahale.metrics.health.HealthCheckRegistry healthChecks, com.codahale.metrics.MetricRegistry metricRegistry, AdminFactory adminFactory)	Creates a new AdminEnvironment.

Method Summary

Modifier and Type	Method	Description
void	addTask(Task task)	Adds the given task to the set of tasks exposed via the admin interface.
boolean	isHealthCheckServletEnabled()

Methods inherited from class io.dropwizard.jetty.setup.ServletEnvironment

addFilter, addFilter, addMimeMapping, addServlet, addServlet, addServletListeners, setBaseResource, setBaseResource, setBaseResource, setInitParameter, setProtectedTargets, setResourceBase, setSecurityHandler, setSessionHandler

Methods inherited from class java.lang.Object

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

Constructor Details

AdminEnvironment

public AdminEnvironment(MutableServletContextHandler handler,
 com.codahale.metrics.health.HealthCheckRegistry healthChecks,
 com.codahale.metrics.MetricRegistry metricRegistry,
 AdminFactory adminFactory)

Creates a new AdminEnvironment.

Parameters:

handler - a servlet context handler

healthChecks - a health check registry

Method Details

addTask

public void addTask(Task task)

Adds the given task to the set of tasks exposed via the admin interface.

Parameters:

task - a task

isHealthCheckServletEnabled

public boolean isHealthCheckServletEnabled()