io.dropwizard.setup

Class Environment

java.lang.Object

io.dropwizard.setup.Environment

public class Environment
extends Object

A Dropwizard application's environment.

Constructor Summary

Constructors

Constructor and Description
Environment(String name) Creates an environment with the system classloader, default object mapper, default validator factory, default health check registry, and default configuration for tests.
Environment(String name, com.fasterxml.jackson.databind.ObjectMapper objectMapper, javax.validation.ValidatorFactory validatorFactory, com.codahale.metrics.MetricRegistry metricRegistry, ClassLoader classLoader, com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, Configuration configuration) Creates a new environment.

Method Summary

Modifier and Type	Method and Description
AdminEnvironment	admin() Returns the application's AdminEnvironment.
MutableServletContextHandler	getAdminContext()
MutableServletContextHandler	getApplicationContext()
ExecutorService	getHealthCheckExecutorService() Returns an ExecutorService to run time bound health checks
javax.servlet.Servlet	getJerseyServletContainer()
String	getName() Returns the application's name.
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Returns the application's ObjectMapper.
javax.validation.Validator	getValidator() Returns the application's Validator.
HealthEnvironment	health() Returns the application's HealthEnvironment.
com.codahale.metrics.health.HealthCheckRegistry	healthChecks() Returns the application's HealthCheckRegistry.
JerseyEnvironment	jersey() Returns the application's JerseyEnvironment.
LifecycleEnvironment	lifecycle() Returns the application's LifecycleEnvironment.
com.codahale.metrics.MetricRegistry	metrics() Returns the application's MetricRegistry.
ServletEnvironment	servlets() Returns the application's ServletEnvironment.
void	setValidator(javax.validation.Validator validator) Sets the application's Validator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment(String name,
                   com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                   javax.validation.ValidatorFactory validatorFactory,
                   com.codahale.metrics.MetricRegistry metricRegistry,
                   @Nullable
                   ClassLoader classLoader,
                   com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
                   Configuration configuration)

Creates a new environment.

Parameters:

name - the name of the application

objectMapper - the ObjectMapper for the application

Environment

public Environment(String name)

Creates an environment with the system classloader, default object mapper, default validator factory, default health check registry, and default configuration for tests.

Since:

2.0

Method Detail

jersey

public JerseyEnvironment jersey()

Returns the application's JerseyEnvironment.

getHealthCheckExecutorService

public ExecutorService getHealthCheckExecutorService()

Returns an ExecutorService to run time bound health checks

admin

public AdminEnvironment admin()

Returns the application's AdminEnvironment.

lifecycle

public LifecycleEnvironment lifecycle()

Returns the application's LifecycleEnvironment.

servlets

public ServletEnvironment servlets()

Returns the application's ServletEnvironment.

health

public HealthEnvironment health()

Returns the application's HealthEnvironment.

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns the application's ObjectMapper.

getName

public String getName()

Returns the application's name.

getValidator

public javax.validation.Validator getValidator()

Returns the application's Validator.

setValidator

public void setValidator(javax.validation.Validator validator)

Sets the application's Validator.

metrics

public com.codahale.metrics.MetricRegistry metrics()

Returns the application's MetricRegistry.

healthChecks

public com.codahale.metrics.health.HealthCheckRegistry healthChecks()

Returns the application's HealthCheckRegistry.

getApplicationContext

public MutableServletContextHandler getApplicationContext()

getJerseyServletContainer

@Nullable
public javax.servlet.Servlet getJerseyServletContainer()

getAdminContext

public MutableServletContextHandler getAdminContext()