A B C D E G H I J L M P R S T

A

AbstractServerFactory - Class in io.dropwizard.server

A base class for ServerFactory implementations.

AbstractServerFactory() - Constructor for class io.dropwizard.server.AbstractServerFactory

addBundle(Bundle) - Method in class io.dropwizard.setup.Bootstrap

Adds the given bundle to the bootstrap.

addBundle(ConfiguredBundle<? super T>) - Method in class io.dropwizard.setup.Bootstrap

Adds the given bundle to the bootstrap.

addCommand(Command) - Method in class io.dropwizard.setup.Bootstrap

Adds the given command to the bootstrap.

addCommand(ConfiguredCommand<T>) - Method in class io.dropwizard.setup.Bootstrap

Adds the given command to the bootstrap.

addRequestLog(Server, Handler, String) - Method in class io.dropwizard.server.AbstractServerFactory

addStatsHandler(Handler) - Method in class io.dropwizard.server.AbstractServerFactory

addTask(Task) - Method in class io.dropwizard.setup.AdminEnvironment

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

admin() - Method in class io.dropwizard.setup.Environment

Returns the application's AdminEnvironment.

AdminEnvironment - Class in io.dropwizard.setup

The administrative environment of a Dropwizard application.

AdminEnvironment(MutableServletContextHandler, HealthCheckRegistry, MetricRegistry) - Constructor for class io.dropwizard.setup.AdminEnvironment

Creates a new AdminEnvironment.

Application<T extends Configuration> - Class in io.dropwizard

The base class for Dropwizard applications.

Application() - Constructor for class io.dropwizard.Application

B

Bootstrap<T extends Configuration> - Class in io.dropwizard.setup

The pre-start application environment, containing everything required to bootstrap a Dropwizard command.

Bootstrap(Application<T>) - Constructor for class io.dropwizard.setup.Bootstrap

Creates a new Bootstrap for the given application.

build(Environment) - Method in class io.dropwizard.server.DefaultServerFactory

build(Environment) - Method in interface io.dropwizard.server.ServerFactory

Build a server for the given Dropwizard application.

build(Environment) - Method in class io.dropwizard.server.SimpleServerFactory

buildServer(LifecycleEnvironment, ThreadPool) - Method in class io.dropwizard.server.AbstractServerFactory

buildSetUIDListener() - Method in class io.dropwizard.server.AbstractServerFactory

Bundle - Interface in io.dropwizard

A reusable bundle of functionality, used to define blocks of application behavior.

C

CheckCommand<T extends Configuration> - Class in io.dropwizard.cli

Parses and validates the application's configuration.

CheckCommand(Application<T>) - Constructor for class io.dropwizard.cli.CheckCommand

cleanup() - Method in class io.dropwizard.cli.ConfiguredCommand

cleanupAsynchronously() - Method in class io.dropwizard.cli.ConfiguredCommand

Cli - Class in io.dropwizard.cli

The command-line runner for Dropwizard application.

Cli(JarLocation, Bootstrap<?>, OutputStream, OutputStream) - Constructor for class io.dropwizard.cli.Cli

Create a new CLI interface for a application and its bootstrapped environment.

Command - Class in io.dropwizard.cli

A basic CLI command.

Command(String, String) - Constructor for class io.dropwizard.cli.Command

Create a new command with the given name and description.

Configuration - Class in io.dropwizard

An object representation of the YAML configuration file.

Configuration() - Constructor for class io.dropwizard.Configuration

configure(Subparser) - Method in class io.dropwizard.cli.Command

Configure the command's Subparser.

configure(Subparser) - Method in class io.dropwizard.cli.ConfiguredCommand

Configure the command's Subparser.

ConfiguredBundle<T> - Interface in io.dropwizard

A reusable bundle of functionality, used to define blocks of application behavior that are conditional on configuration parameters.

ConfiguredCommand<T extends Configuration> - Class in io.dropwizard.cli

A command whose first parameter is the location of a YAML configuration file.

ConfiguredCommand(String, String) - Constructor for class io.dropwizard.cli.ConfiguredCommand

createAdminServlet(Server, MutableServletContextHandler, MetricRegistry, HealthCheckRegistry) - Method in class io.dropwizard.server.AbstractServerFactory

createAppServlet(Server, JerseyEnvironment, ObjectMapper, Validator, MutableServletContextHandler, Servlet, MetricRegistry) - Method in class io.dropwizard.server.AbstractServerFactory

createThreadPool(MetricRegistry) - Method in class io.dropwizard.server.AbstractServerFactory

D

DefaultServerFactory - Class in io.dropwizard.server

The default implementation of ServerFactory, which allows for multiple sets of application and admin connectors, all running on separate ports.

DefaultServerFactory() - Constructor for class io.dropwizard.server.DefaultServerFactory

E

Environment - Class in io.dropwizard.setup

A Dropwizard application's environment.

Environment(String, ObjectMapper, Validator, MetricRegistry, ClassLoader) - Constructor for class io.dropwizard.setup.Environment

Creates a new environment.

EnvironmentCommand<T extends Configuration> - Class in io.dropwizard.cli

A command which executes with a configured Environment.

EnvironmentCommand(Application<T>, String, String) - Constructor for class io.dropwizard.cli.EnvironmentCommand

Creates a new environment command.

G

getAdminConnectors() - Method in class io.dropwizard.server.DefaultServerFactory

getAdminContext() - Method in class io.dropwizard.setup.Environment

getAdminContextPath() - Method in class io.dropwizard.server.DefaultServerFactory

getAdminContextPath() - Method in class io.dropwizard.server.SimpleServerFactory

getAdminMaxThreads() - Method in class io.dropwizard.server.DefaultServerFactory

getAdminMinThreads() - Method in class io.dropwizard.server.DefaultServerFactory

getAllowedMethods() - Method in class io.dropwizard.server.AbstractServerFactory

getApplication() - Method in class io.dropwizard.setup.Bootstrap

Returns the bootstrap's Application.

getApplicationConnectors() - Method in class io.dropwizard.server.DefaultServerFactory

getApplicationContext() - Method in class io.dropwizard.setup.Environment

getApplicationContextPath() - Method in class io.dropwizard.server.DefaultServerFactory

getApplicationContextPath() - Method in class io.dropwizard.server.SimpleServerFactory

getClassLoader() - Method in class io.dropwizard.setup.Bootstrap

Returns the bootstrap's class loader.

getCommands() - Method in class io.dropwizard.setup.Bootstrap

Returns the application's commands.

getConfigurationClass() - Method in class io.dropwizard.Application

Returns the Class of the configuration class type parameter.

getConfigurationClass() - Method in class io.dropwizard.cli.CheckCommand

getConfigurationClass() - Method in class io.dropwizard.cli.ConfiguredCommand

Returns the Class of the configuration type.

getConfigurationClass() - Method in class io.dropwizard.cli.ServerCommand

getConfigurationFactoryFactory() - Method in class io.dropwizard.setup.Bootstrap

getConfigurationSourceProvider() - Method in class io.dropwizard.setup.Bootstrap

Returns the bootstrap's ConfigurationSourceProvider.

getConnector() - Method in class io.dropwizard.server.SimpleServerFactory

getDescription() - Method in class io.dropwizard.cli.Command

Returns the command's description.

getGid() - Method in class io.dropwizard.server.AbstractServerFactory

getGroup() - Method in class io.dropwizard.server.AbstractServerFactory

getGzipFilterFactory() - Method in class io.dropwizard.server.AbstractServerFactory

getHealthCheckExecutorService() - Method in class io.dropwizard.setup.Environment

Returns an ExecutorService to run time bound health checks

getIdleThreadTimeout() - Method in class io.dropwizard.server.AbstractServerFactory

getJerseyRootPath() - Method in class io.dropwizard.server.AbstractServerFactory

getJerseyServletContainer() - Method in class io.dropwizard.setup.Environment

getLoggingFactory() - Method in class io.dropwizard.Configuration

Returns the logging-specific section of the configuration file.

getMaxQueuedRequests() - Method in class io.dropwizard.server.AbstractServerFactory

getMaxThreads() - Method in class io.dropwizard.server.AbstractServerFactory

getMetricRegistry() - Method in class io.dropwizard.setup.Bootstrap

Returns the application metrics.

getMetricsFactory() - Method in class io.dropwizard.Configuration

getMinThreads() - Method in class io.dropwizard.server.AbstractServerFactory

getName() - Method in class io.dropwizard.Application

Returns the name of the application.

getName() - Method in class io.dropwizard.cli.Command

Returns the command's name.

getName() - Method in class io.dropwizard.setup.Environment

Returns the application's name.

getNofileHardLimit() - Method in class io.dropwizard.server.AbstractServerFactory

getNofileSoftLimit() - Method in class io.dropwizard.server.AbstractServerFactory

getObjectMapper() - Method in class io.dropwizard.setup.Bootstrap

Returns the bootstrap's ObjectMapper.

getObjectMapper() - Method in class io.dropwizard.setup.Environment

Returns the application's ObjectMapper.

getRegisterDefaultExceptionMappers() - Method in class io.dropwizard.server.AbstractServerFactory

getRequestLogFactory() - Method in class io.dropwizard.server.AbstractServerFactory

getServerFactory() - Method in class io.dropwizard.Configuration

Returns the server-specific section of the configuration file.

getShutdownGracePeriod() - Method in class io.dropwizard.server.AbstractServerFactory

getStartsAsRoot() - Method in class io.dropwizard.server.AbstractServerFactory

getUid() - Method in class io.dropwizard.server.AbstractServerFactory

getUmask() - Method in class io.dropwizard.server.AbstractServerFactory

getUser() - Method in class io.dropwizard.server.AbstractServerFactory

getValidator() - Method in class io.dropwizard.setup.Environment

Returns the application's Validator.

getValidatorFactory() - Method in class io.dropwizard.setup.Bootstrap

Returns the application's validator factory.

H

healthChecks() - Method in class io.dropwizard.setup.Environment

Returns the application's HealthCheckRegistry.

I

initialize(Bootstrap<T>) - Method in class io.dropwizard.Application

Initializes the application bootstrap.

initialize(Bootstrap<?>) - Method in interface io.dropwizard.Bundle

Initializes the application bootstrap.

initialize(Bootstrap<?>) - Method in interface io.dropwizard.ConfiguredBundle

Initializes the application bootstrap.

io.dropwizard - package io.dropwizard

io.dropwizard.cli - package io.dropwizard.cli

io.dropwizard.server - package io.dropwizard.server

io.dropwizard.setup - package io.dropwizard.setup

isThreadPoolSizedCorrectly() - Method in class io.dropwizard.server.AbstractServerFactory

J

jersey() - Method in class io.dropwizard.setup.Environment

Returns the application's JerseyEnvironment.

L

lifecycle() - Method in class io.dropwizard.setup.Environment

Returns the application's LifecycleEnvironment.

M

metrics() - Method in class io.dropwizard.setup.Environment

Returns the application's MetricRegistry.

P

printBanner(String) - Method in class io.dropwizard.server.AbstractServerFactory

R

registerMetrics() - Method in class io.dropwizard.setup.Bootstrap

Registers the JVM metrics to the metric registry and start to report the registry metrics via JMX.

run(T, Environment) - Method in class io.dropwizard.Application

When the application runs, this is called after the Bundles are run.

run(String...) - Method in class io.dropwizard.Application

Parses command-line arguments and runs the application.

run(Environment) - Method in interface io.dropwizard.Bundle

Initializes the application environment.

run(Bootstrap<T>, Namespace, T) - Method in class io.dropwizard.cli.CheckCommand

run(String...) - Method in class io.dropwizard.cli.Cli

Runs the command line interface given some arguments.

run(Bootstrap<?>, Namespace) - Method in class io.dropwizard.cli.Command

Executes when the user runs this specific command.

run(Bootstrap<?>, Namespace) - Method in class io.dropwizard.cli.ConfiguredCommand

run(Bootstrap<T>, Namespace, T) - Method in class io.dropwizard.cli.ConfiguredCommand

Runs the command with the given Bootstrap and Configuration.

run(Bootstrap<T>, Namespace, T) - Method in class io.dropwizard.cli.EnvironmentCommand

run(Environment, Namespace, T) - Method in class io.dropwizard.cli.EnvironmentCommand

Runs the command with the given Environment and Configuration.

run(Environment, Namespace, T) - Method in class io.dropwizard.cli.ServerCommand

run(T, Environment) - Method in interface io.dropwizard.ConfiguredBundle

Initializes the environment.

run(T, Environment) - Method in class io.dropwizard.setup.Bootstrap

Runs the bootstrap's bundles with the given configuration and environment.

S

ServerCommand<T extends Configuration> - Class in io.dropwizard.cli

Runs a application as an HTTP server.

ServerCommand(Application<T>) - Constructor for class io.dropwizard.cli.ServerCommand

ServerFactory - Interface in io.dropwizard.server

A factory for building Server instances for Dropwizard applications.

servlets() - Method in class io.dropwizard.setup.Environment

Returns the application's ServletEnvironment.

setAdminConnectors(List<ConnectorFactory>) - Method in class io.dropwizard.server.DefaultServerFactory

setAdminContextPath(String) - Method in class io.dropwizard.server.DefaultServerFactory

setAdminContextPath(String) - Method in class io.dropwizard.server.SimpleServerFactory

setAdminMaxThreads(int) - Method in class io.dropwizard.server.DefaultServerFactory

setAdminMinThreads(int) - Method in class io.dropwizard.server.DefaultServerFactory

setAllowedMethods(Set<String>) - Method in class io.dropwizard.server.AbstractServerFactory

setApplicationConnectors(List<ConnectorFactory>) - Method in class io.dropwizard.server.DefaultServerFactory

setApplicationContextPath(String) - Method in class io.dropwizard.server.DefaultServerFactory

setApplicationContextPath(String) - Method in class io.dropwizard.server.SimpleServerFactory

setClassLoader(ClassLoader) - Method in class io.dropwizard.setup.Bootstrap

Sets the bootstrap's class loader.

setConfigurationFactoryFactory(ConfigurationFactoryFactory<T>) - Method in class io.dropwizard.setup.Bootstrap

setConfigurationSourceProvider(ConfigurationSourceProvider) - Method in class io.dropwizard.setup.Bootstrap

Sets the bootstrap's ConfigurationSourceProvider.

setConnector(ConnectorFactory) - Method in class io.dropwizard.server.SimpleServerFactory

setGid(Integer) - Method in class io.dropwizard.server.AbstractServerFactory

setGroup(String) - Method in class io.dropwizard.server.AbstractServerFactory

setGzipFilterFactory(GzipFilterFactory) - Method in class io.dropwizard.server.AbstractServerFactory

setIdleThreadTimeout(Duration) - Method in class io.dropwizard.server.AbstractServerFactory

setJerseyRootPath(String) - Method in class io.dropwizard.server.AbstractServerFactory

setLoggingFactory(LoggingFactory) - Method in class io.dropwizard.Configuration

Sets the logging-specific section of the configuration file.

setMaxQueuedRequests(int) - Method in class io.dropwizard.server.AbstractServerFactory

setMaxThreads(int) - Method in class io.dropwizard.server.AbstractServerFactory

setMetricRegistry(MetricRegistry) - Method in class io.dropwizard.setup.Bootstrap

Sets a custom registry for the application metrics.

setMetricsFactory(MetricsFactory) - Method in class io.dropwizard.Configuration

setMinThreads(int) - Method in class io.dropwizard.server.AbstractServerFactory

setNofileHardLimit(Integer) - Method in class io.dropwizard.server.AbstractServerFactory

setNofileSoftLimit(Integer) - Method in class io.dropwizard.server.AbstractServerFactory

setObjectMapper(ObjectMapper) - Method in class io.dropwizard.setup.Bootstrap

Sets the given ObjectMapper to the bootstrap.

setRegisterDefaultExceptionMappers(Boolean) - Method in class io.dropwizard.server.AbstractServerFactory

setRequestLogFactory(RequestLogFactory) - Method in class io.dropwizard.server.AbstractServerFactory

setServerFactory(ServerFactory) - Method in class io.dropwizard.Configuration

Sets the HTTP-specific section of the configuration file.

setShutdownGracePeriod(Duration) - Method in class io.dropwizard.server.AbstractServerFactory

setStartsAsRoot(Boolean) - Method in class io.dropwizard.server.AbstractServerFactory

setUid(Integer) - Method in class io.dropwizard.server.AbstractServerFactory

setUmask(String) - Method in class io.dropwizard.server.AbstractServerFactory

setUser(String) - Method in class io.dropwizard.server.AbstractServerFactory

setValidator(Validator) - Method in class io.dropwizard.setup.Environment

Sets the application's Validator.

setValidatorFactory(ValidatorFactory) - Method in class io.dropwizard.setup.Bootstrap

SimpleServerFactory - Class in io.dropwizard.server

A single-connector implementation of ServerFactory, suitable for PaaS deployments (e.g., Heroku) where applications are limited to a single, runtime-defined port.

SimpleServerFactory() - Constructor for class io.dropwizard.server.SimpleServerFactory

T

toString() - Method in class io.dropwizard.Configuration

toString() - Method in class io.dropwizard.server.DefaultServerFactory

A B C D E G H I J L M P R S T