A B C D E G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ACQUIRE_FAIL - org.kiwiproject.dropwizard.util.startup.StartupLockInfo.LockState
- ACQUIRED - org.kiwiproject.dropwizard.util.startup.StartupLockInfo.LockState
- acquireStartupLock(String, Duration, PortAssigner.PortAssignment, CuratorConfig, Environment) - Method in class org.kiwiproject.dropwizard.util.startup.StartupLocker
-
Attempts to acquire a lock from ZooKeeper during startup.
- addFallbackJettyStartupLifeCycleListener(StartupLockInfo, Environment) - Method in class org.kiwiproject.dropwizard.util.startup.StartupLocker
-
Adds a
StartupJettyLifeCycleListener
in case the lock was never acquired. - addProcessIdLoggingLifecycleListener(Long, Environment) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Adds a lifecycle listener that logs the current process id on startup.
- addRegistryLifecycleListeners(RegistryService, ServiceInfo, Environment) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Adds lifecycle listeners to the Dropwizard environment that will register and unregister the service at startup and shutdown, respectively.
- addServerConnectorLoggingLifecycleListener(Environment) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Adds a server lifecycle listener that logs the server connector information on startup.
- addServiceRunningLifecycleListener(ServiceInfo, Environment) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Adds a lifecycle listener to print out the status of the server with configured ports at startup.
- AdminConfigurator - Class in org.kiwiproject.dropwizard.util.admin
-
A utility to configure and setup various "standard" settings for a Dropwizard service.
- AdminConfigurator(Environment) - Constructor for class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Creates a new
AdminConfigurator
with a given DropwizardEnvironment
- AllowablePortRange - Class in org.kiwiproject.dropwizard.util.startup
-
Defines the allowable port range for a service to bind to, for situations where there is a restriction.
- AllowablePortRange(int, int) - Constructor for class org.kiwiproject.dropwizard.util.startup.AllowablePortRange
-
Creates a new AllowablePortRange
- assignDynamicPorts() - Method in class org.kiwiproject.dropwizard.util.startup.PortAssigner
-
Sets up the connectors with a dynamic available port if
PortAssigner
is configured for dynamic ports.
B
- builder() - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Builder to allow for customizing all aspects of a
MonitoredJob
and then registering it. - Builder() - Constructor for class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
C
- check() - Method in class org.kiwiproject.dropwizard.util.health.HttpConnectionsHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.keystore.ExpiringKeystoreHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.MongoHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.MonitoredJobHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.ProcessGrepHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.ProcessKillHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.ProcessLaunchHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.ServerErrorHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.util.health.UnknownPropertiesHealthCheck
- ConfigResource - Class in org.kiwiproject.dropwizard.util.resource
-
JAX-RS resource that enables the retrieval of the current runtime configuration of the service.
- ConfigResource(Configuration, List<String>) - Constructor for class org.kiwiproject.dropwizard.util.resource.ConfigResource
- configure() - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Terminal operation of this configurator that adds all the configured features into the server setup.
- configureKiwiValidator(Environment) - Static method in class org.kiwiproject.dropwizard.util.environment.StandardEnvironmentConfigurations
-
Sets the validator for
KiwiValidations
to the validator in the environment.
D
- decisionFunction(Predicate<MonitoredJob>) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- DEFAULT_MSG - Static variable in class org.kiwiproject.dropwizard.util.exception.JsonProcessingExceptionMapper
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.HttpConnectionsHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.MongoHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.ProcessGrepHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.ProcessKillHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.ProcessLaunchHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.ServerErrorHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_NAME - Static variable in class org.kiwiproject.dropwizard.util.health.UnknownPropertiesHealthCheck
-
A default name that can be used when registering this health check.
- DEFAULT_WARNING_THRESHOLD - Static variable in class org.kiwiproject.dropwizard.util.health.HttpConnectionsHealthCheck
-
Default percent above which this health check will report unhealthy.
- didExit() - Method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.ExitFlaggingExecutionStrategy
- DropwizardConnectors - Class in org.kiwiproject.dropwizard.util.server
-
Utility class that assists with setting up the server connectors in Dropwizard.
- DropwizardConnectors() - Constructor for class org.kiwiproject.dropwizard.util.server.DropwizardConnectors
- DropwizardConnectors.ConnectorType - Enum in org.kiwiproject.dropwizard.util.server
-
Enum defining the possible options for a connector type in Dropwizard.
- DYNAMIC - org.kiwiproject.dropwizard.util.startup.PortAssigner.PortAssignment
E
- EarlyEofExceptionMapper - Class in org.kiwiproject.dropwizard.util.exception
-
Override default Dropwizard mapper to use kiwi's
ErrorMessage
. - EarlyEofExceptionMapper() - Constructor for class org.kiwiproject.dropwizard.util.exception.EarlyEofExceptionMapper
- EmptyOptionalExceptionMapper - Class in org.kiwiproject.dropwizard.util.exception
-
Override default Dropwizard mapper to use kiwi's
ErrorMessage
. - EmptyOptionalExceptionMapper() - Constructor for class org.kiwiproject.dropwizard.util.exception.EmptyOptionalExceptionMapper
- enableWadlGeneration(Environment) - Static method in class org.kiwiproject.dropwizard.util.environment.StandardEnvironmentConfigurations
-
Enables the generation of the WADL endpoint in the Dropwizard service
- environment(Environment) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- errorHandler(JobErrorHandler) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- execute(Map<String, List<String>>, PrintWriter) - Method in class org.kiwiproject.dropwizard.util.task.ServerLoadTask
- ExecutionStrategies - Class in org.kiwiproject.dropwizard.util.startup
-
Factory for
ExecutionStrategy
instances. - ExecutionStrategies() - Constructor for class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies
- ExecutionStrategies.ExitFlaggingExecutionStrategy - Class in org.kiwiproject.dropwizard.util.startup
-
Implementation of
ExecutionStrategy
that "flags" a call toExecutionStrategies.ExitFlaggingExecutionStrategy.exit()
but does not actually exit the JVM. - ExecutionStrategies.NoOpExecutionStrategy - Class in org.kiwiproject.dropwizard.util.startup
-
Implementation of
ExecutionStrategy
that does nothing. - ExecutionStrategies.SystemExitExecutionStrategy - Class in org.kiwiproject.dropwizard.util.startup
-
Implementation of
ExecutionStrategy
that usesSystem.exit(int)
. - ExecutionStrategy - Interface in org.kiwiproject.dropwizard.util.startup
-
Defines a strategy used in
SystemExecutioner
to terminate the JVM. - executor(ScheduledExecutorService) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- exit() - Method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.ExitFlaggingExecutionStrategy
- exit() - Method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.NoOpExecutionStrategy
-
A no-op.
- exit() - Method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.SystemExitExecutionStrategy
-
Terminates the currently running JVM.
- exit() - Method in interface org.kiwiproject.dropwizard.util.startup.ExecutionStrategy
-
Performs the exit operation.
- exit() - Method in class org.kiwiproject.dropwizard.util.startup.SystemExecutioner
-
Exits immediately.
- exit(long, TimeUnit) - Method in class org.kiwiproject.dropwizard.util.startup.SystemExecutioner
-
Waits the given amount of time, then exits.
- exitFlagging() - Static method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies
-
Returns a strategy that "flags" when the
exit()
method is called, but does not actually terminate the JVM. - ExitFlaggingExecutionStrategy() - Constructor for class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.ExitFlaggingExecutionStrategy
- ExpiringKeystoreHealthCheck - Class in org.kiwiproject.dropwizard.util.health.keystore
-
Health check that checks whether X.509 certificates are valid, expired, or will be expiring soon as configured in a
KeystoreConfig
. - ExpiringKeystoreHealthCheck(KeystoreConfig) - Constructor for class org.kiwiproject.dropwizard.util.health.keystore.ExpiringKeystoreHealthCheck
G
- get() - Method in class org.kiwiproject.dropwizard.util.metrics.ServerLoadFetcher
-
Example format on Linux-based systems:
- getAdminPort(DefaultServerFactory, DropwizardConnectors.ConnectorType) - Static method in class org.kiwiproject.dropwizard.util.server.DropwizardConnectors
-
Determines the admin port for the Dropwizard server that matches the given connectorType
- getApplicationPort(DefaultServerFactory, DropwizardConnectors.ConnectorType) - Static method in class org.kiwiproject.dropwizard.util.server.DropwizardConnectors
-
Determines the application port for the Dropwizard server that matches the given connectorType
- getCurrentConfiguration() - Method in class org.kiwiproject.dropwizard.util.resource.ConfigResource
- getName() - Method in class org.kiwiproject.dropwizard.util.config.HttpHealthCheckConfig
- getValue() - Method in class org.kiwiproject.dropwizard.util.metrics.ServerLoadGauge
- getWarningThreshold() - Method in class org.kiwiproject.dropwizard.util.config.HttpHealthCheckConfig
H
- handle(MonitoredJob, Exception) - Method in interface org.kiwiproject.dropwizard.util.job.JobErrorHandler
-
Handles an
Exception
that occurred during the run of theMonitoredJob
. - handleExceptionSafely(Exception) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJob
- HTTP - org.kiwiproject.dropwizard.util.server.DropwizardConnectors.ConnectorType
- HttpConnectionsHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that checks the percent of leased connections against the maximum number of connections for JAX-RS
Client
instances that were created using Dropwizard'sio.dropwizard.client.JerseyClientBuilder
, which creates an HTTP connection pool and registers various connection metrics that we can query. - HttpConnectionsHealthCheck(MetricRegistry) - Constructor for class org.kiwiproject.dropwizard.util.health.HttpConnectionsHealthCheck
- HttpConnectionsHealthCheck(MetricRegistry, double) - Constructor for class org.kiwiproject.dropwizard.util.health.HttpConnectionsHealthCheck
- HttpHealthCheckConfig - Class in org.kiwiproject.dropwizard.util.config
-
Configuration to use for the
HttpConnectionsHealthCheck
- HttpHealthCheckConfig() - Constructor for class org.kiwiproject.dropwizard.util.config.HttpHealthCheckConfig
- HTTPS - org.kiwiproject.dropwizard.util.server.DropwizardConnectors.ConnectorType
I
- INFORMATIONAL - org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck.DependencyImportance
- isActive() - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJob
-
Checks if the job should be active and execute by delegating to the decision function.
J
- JacksonConfig - Class in org.kiwiproject.dropwizard.util.config
- JacksonConfig() - Constructor for class org.kiwiproject.dropwizard.util.config.JacksonConfig
- JerseyViolationExceptionMapper - Class in org.kiwiproject.dropwizard.util.exception
-
Override default Dropwizard mapper to use kiwi's
ErrorMessage
. - JerseyViolationExceptionMapper() - Constructor for class org.kiwiproject.dropwizard.util.exception.JerseyViolationExceptionMapper
- JobErrorHandler - Interface in org.kiwiproject.dropwizard.util.job
-
Interface that defines a handler for when a
MonitoredJob
encounters an error. - JobErrorHandlers - Class in org.kiwiproject.dropwizard.util.job
-
Factory for a few simple
JobErrorHandler
implementations. - JobErrorHandlers() - Constructor for class org.kiwiproject.dropwizard.util.job.JobErrorHandlers
- JobSchedule - Class in org.kiwiproject.dropwizard.util.config
-
Config object that defines a schedule for background jobs.
- JobSchedule() - Constructor for class org.kiwiproject.dropwizard.util.config.JobSchedule
- JsonProcessingExceptionMapper - Class in org.kiwiproject.dropwizard.util.exception
-
Override default Dropwizard mapper to use kiwi's
ErrorMessage
. - JsonProcessingExceptionMapper() - Constructor for class org.kiwiproject.dropwizard.util.exception.JsonProcessingExceptionMapper
K
- KeystoreConfig - Class in org.kiwiproject.dropwizard.util.config
-
Configuration for keystore health checks.
- KeystoreConfig() - Constructor for class org.kiwiproject.dropwizard.util.config.KeystoreConfig
- kiwiEnvironment(KiwiEnvironment) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
L
- lifeCycleFailure(LifeCycle, Throwable) - Method in class org.kiwiproject.dropwizard.util.startup.listener.StartupJettyLifeCycleListener
- lifeCycleFailure(LifeCycle, Throwable) - Method in class org.kiwiproject.dropwizard.util.startup.listener.StartupWithLockJettyLifeCycleListener
- lifeCycleStarted(LifeCycle) - Method in class org.kiwiproject.dropwizard.util.startup.listener.StartupWithLockJettyLifeCycleListener
- lifeCycleStopped(LifeCycle) - Method in class org.kiwiproject.dropwizard.util.startup.listener.StartupWithLockJettyLifeCycleListener
- LoggingExceptionMapper<E extends Throwable> - Class in org.kiwiproject.dropwizard.util.exception
-
Override default Dropwizard mapper to use kiwi's
ErrorMessage
. - LoggingExceptionMapper() - Constructor for class org.kiwiproject.dropwizard.util.exception.LoggingExceptionMapper
- loggingHandler() - Static method in class org.kiwiproject.dropwizard.util.job.JobErrorHandlers
-
An error handler that logs the job name and exception at WARN level.
- loggingHandler(Logger) - Static method in class org.kiwiproject.dropwizard.util.job.JobErrorHandlers
-
An error handler that logs the job name and exception at WARN level using the given
Logger
. - logServiceStatusWarningWithStatus(String) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Logs the given server status.
M
- MongoHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that attempts to pull dbStats from Mongo and report on the status.
- MongoHealthCheck(DB) - Constructor for class org.kiwiproject.dropwizard.util.health.MongoHealthCheck
- MonitoredJob - Class in org.kiwiproject.dropwizard.util.job
-
Sets up a job from a
Runnable
that can be monitored through health checks to ensure it is running correctly. - MonitoredJobHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that monitors a
MonitoredJob
to ensure that it is running on schedule and not encountering errors while running. - MonitoredJobs - Class in org.kiwiproject.dropwizard.util.job
-
A set of utilities to assist in setting up MonitoredJobs with health checks.
- MonitoredJobs() - Constructor for class org.kiwiproject.dropwizard.util.job.MonitoredJobs
- MonitoredJobs.Builder - Class in org.kiwiproject.dropwizard.util.job
-
Builder for creating and registering
MonitoredJob
instances.
N
- name(String) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- NAME - Static variable in class org.kiwiproject.dropwizard.util.metrics.ServerLoadGauge
- nameFor(ServiceIdentifier) - Static method in class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
-
Resolves a health check name for a given
ServiceIdentifier
. - newScheduledExecutor(Environment, String) - Static method in class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
-
Create a new
ScheduledExecutorService
whose lifecycle is managed by Dropwizard. - NO_VALUE - Static variable in class org.kiwiproject.dropwizard.util.metrics.ServerLoadFetcher
-
Can be used if you need to report some value for load average in the case when
ServerLoadFetcher.get()
returns an emptyOptional
- NoAvailablePortException - Exception in org.kiwiproject.dropwizard.util.exception
-
Exception indicating that all attempts to find an open part have been exhausted.
- NoAvailablePortException(String) - Constructor for exception org.kiwiproject.dropwizard.util.exception.NoAvailablePortException
- NON_SECURE - org.kiwiproject.dropwizard.util.startup.PortAssigner.PortSecurity
- noOp() - Static method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies
-
Returns a strategy that does nothing (is a "no-op").
- NoOpExecutionStrategy() - Constructor for class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.NoOpExecutionStrategy
- noOpHandler() - Static method in class org.kiwiproject.dropwizard.util.job.JobErrorHandlers
-
A no-op error handler.
- NOT_ATTEMPTED - org.kiwiproject.dropwizard.util.startup.StartupLockInfo.LockState
O
- ofIntervalDelay(Duration) - Static method in class org.kiwiproject.dropwizard.util.config.JobSchedule
-
Create a new
JobSchedule
instance with the given interval delay and the default initial delay. - ofIntervalDelay(Duration) - Static method in class org.kiwiproject.dropwizard.util.config.JobSchedule
-
Create a new
JobSchedule
instance with the given interval delay and the default initial delay. - org.kiwiproject.dropwizard.util.admin - package org.kiwiproject.dropwizard.util.admin
- org.kiwiproject.dropwizard.util.config - package org.kiwiproject.dropwizard.util.config
- org.kiwiproject.dropwizard.util.environment - package org.kiwiproject.dropwizard.util.environment
- org.kiwiproject.dropwizard.util.exception - package org.kiwiproject.dropwizard.util.exception
- org.kiwiproject.dropwizard.util.health - package org.kiwiproject.dropwizard.util.health
- org.kiwiproject.dropwizard.util.health.keystore - package org.kiwiproject.dropwizard.util.health.keystore
- org.kiwiproject.dropwizard.util.jackson - package org.kiwiproject.dropwizard.util.jackson
- org.kiwiproject.dropwizard.util.job - package org.kiwiproject.dropwizard.util.job
- org.kiwiproject.dropwizard.util.lifecycle - package org.kiwiproject.dropwizard.util.lifecycle
- org.kiwiproject.dropwizard.util.metrics - package org.kiwiproject.dropwizard.util.metrics
- org.kiwiproject.dropwizard.util.resource - package org.kiwiproject.dropwizard.util.resource
- org.kiwiproject.dropwizard.util.server - package org.kiwiproject.dropwizard.util.server
- org.kiwiproject.dropwizard.util.startup - package org.kiwiproject.dropwizard.util.startup
- org.kiwiproject.dropwizard.util.startup.listener - package org.kiwiproject.dropwizard.util.startup.listener
- org.kiwiproject.dropwizard.util.task - package org.kiwiproject.dropwizard.util.task
P
- PortAssigner - Class in org.kiwiproject.dropwizard.util.startup
-
Finds open ports and sets up the application and admin connectors with those ports.
- PortAssigner.PortAssignment - Enum in org.kiwiproject.dropwizard.util.startup
- PortAssigner.PortSecurity - Enum in org.kiwiproject.dropwizard.util.startup
- ProcessGrepHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
A health check that checks if we are able to find processes using pgrep, specifically via
ProcessHelper.pgrep(String)
. - ProcessGrepHealthCheck(ProcessHelper) - Constructor for class org.kiwiproject.dropwizard.util.health.ProcessGrepHealthCheck
- ProcessKillHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that checks if we are able to kill processes.
- ProcessKillHealthCheck(ProcessHelper) - Constructor for class org.kiwiproject.dropwizard.util.health.ProcessKillHealthCheck
- ProcessLaunchHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that checks if we are able to launch processes.
- ProcessLaunchHealthCheck(ProcessHelper) - Constructor for class org.kiwiproject.dropwizard.util.health.ProcessLaunchHealthCheck
R
- register(ServerFactory, Environment) - Static method in class org.kiwiproject.dropwizard.util.exception.StandardExceptionMappers
-
Registers the "standard" set of exception mappers.
- registerAllStandardJacksonConfigurations(JacksonConfig, Environment) - Static method in class org.kiwiproject.dropwizard.util.jackson.StandardJacksonConfigurations
-
Registers all the "standard" Jackson configurations on the
ObjectMapper
contained in the given DropwizardEnvironment
according to the values in theJacksonConfig
. - registerJacksonDeserializationProblemHandler(JacksonConfig, ObjectMapper, HealthCheckRegistry) - Static method in class org.kiwiproject.dropwizard.util.jackson.StandardJacksonConfigurations
-
Optionally configures a
LoggingDeserializationProblemHandler
to log Jackson deserialization issues. - registerJacksonTimestampSerialization(JacksonConfig, ObjectMapper) - Static method in class org.kiwiproject.dropwizard.util.jackson.StandardJacksonConfigurations
-
Optionally configures the
ObjectMapper
to convert all Timestamps into milliseconds. - registerJaxbSerializer(JacksonConfig, ObjectMapper) - Static method in class org.kiwiproject.dropwizard.util.jackson.StandardJacksonConfigurations
-
Optionally configures the
ObjectMapper
to convert all nilJAXBElement
into null. - registerJob() - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
-
This is the terminal operation that builds a new
MonitoredJob
instance and registers it. - registerJob(Environment, String, JobSchedule, Runnable) - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Create a new
MonitoredJob
, set up theMonitoredJobHealthCheck
and schedule the job on the givenEnvironment
, with the given name, schedule and runnable. - registerJob(Environment, String, JobSchedule, Runnable, Predicate<MonitoredJob>) - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Create a new
MonitoredJob
, set up theMonitoredJobHealthCheck
and schedule the job on the givenEnvironment
, with the given name, schedule, runnable and decision function. - registerJob(Environment, String, JobSchedule, Runnable, Predicate<MonitoredJob>, ScheduledExecutorService) - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Create a new
MonitoredJob
, set up theMonitoredJobHealthCheck
and schedule the job on the givenEnvironment
, with the given name, schedule, runnable, decision function andScheduledExecutorService
. - registerJob(Environment, MonitoredJob, JobSchedule) - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Using the given
MonitoredJob
, set up theMonitoredJobHealthCheck
and schedule the job on the givenEnvironment
, using the given schedule. - registerJob(Environment, MonitoredJob, JobSchedule, ScheduledExecutorService) - Static method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs
-
Using a given
MonitoredJob
, set up theMonitoredJobHealthCheck
and schedule the job on the givenEnvironment
, with the job's name, the given schedule and the given job. - registerServiceChecks(HealthCheckRegistry, RegistryAwareClient, ServicePingHealthCheck.DependencyImportance, ServiceIdentifier...) - Static method in class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
-
Registers a
ServicePingHealthCheck
for each of the givenServiceIdentifier
s given, using the given importance for each. - registerServiceChecks(HealthCheckRegistry, RegistryAwareClient, ServiceIdentifier...) - Static method in class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
-
Registers a
ServicePingHealthCheck
for each of the givenServiceIdentifier
s given, defaulting the importance toREQUIRED
. - releaseStartupLockIfPresent(StartupLockInfo) - Method in class org.kiwiproject.dropwizard.util.startup.StartupLocker
-
Cleans up the startup lock if it was acquired.
- REQUIRED - org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck.DependencyImportance
- requireDefaultServerFactory(ServerFactory) - Static method in class org.kiwiproject.dropwizard.util.server.DropwizardConnectors
-
Requires that the given
ServerFactory
is in fact aDefaultServerFactory
. - runSafely() - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJob
S
- schedule(JobSchedule) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- SECURE - org.kiwiproject.dropwizard.util.startup.PortAssigner.PortSecurity
- ServerErrorHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Checks for Status 5xx responses.
- ServerErrorHealthCheck(MetricRegistry) - Constructor for class org.kiwiproject.dropwizard.util.health.ServerErrorHealthCheck
-
Create the health check with the given
MetricRegistry
, defaulting the warning and critical thresholds. - ServerErrorHealthCheck(MetricRegistry, int, int) - Constructor for class org.kiwiproject.dropwizard.util.health.ServerErrorHealthCheck
-
Create the health check with the given
MetricRegistry
, warning, and critical thresholds. - ServerLoadFetcher - Class in org.kiwiproject.dropwizard.util.metrics
-
Attempts to get the server load average as reported by the
uptime
command. - ServerLoadFetcher() - Constructor for class org.kiwiproject.dropwizard.util.metrics.ServerLoadFetcher
- ServerLoadGauge - Class in org.kiwiproject.dropwizard.util.metrics
-
A
Gauge
that reports the current server load average, as reported by theuptime
command. - ServerLoadGauge() - Constructor for class org.kiwiproject.dropwizard.util.metrics.ServerLoadGauge
- ServerLoadTask - Class in org.kiwiproject.dropwizard.util.task
-
Send a POST on the admin port to
/tasks/serverLoad
to get the current server load average. - ServerLoadTask() - Constructor for class org.kiwiproject.dropwizard.util.task.ServerLoadTask
- ServicePingHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check to perform a ping on a configured dependent service to ensure the service is at least running.
- ServicePingHealthCheck(ServiceIdentifier, RegistryAwareClient) - Constructor for class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
-
Creates the health check set up to ping a service defined by the given
ServiceIdentifier
using the givenRegistryAwareClient
. - ServicePingHealthCheck(ServiceIdentifier, RegistryAwareClient, ServicePingHealthCheck.DependencyImportance) - Constructor for class org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck
-
Creates the health check set up to ping a service defined by the given
ServiceIdentifier
using the givenRegistryAwareClient
and marking the importance of the dependency by the givenServicePingHealthCheck.DependencyImportance
. - ServicePingHealthCheck.DependencyImportance - Enum in org.kiwiproject.dropwizard.util.health
-
Indicator of how important a dependent service is to the current service.
- StandardEnvironmentConfigurations - Class in org.kiwiproject.dropwizard.util.environment
-
Set of utilities that assist in setting up the Dropwizard environment
- StandardEnvironmentConfigurations() - Constructor for class org.kiwiproject.dropwizard.util.environment.StandardEnvironmentConfigurations
- StandardExceptionMappers - Class in org.kiwiproject.dropwizard.util.exception
-
Utility to configure an opinionated "standard" set of exception mappers.
- StandardExceptionMappers() - Constructor for class org.kiwiproject.dropwizard.util.exception.StandardExceptionMappers
- StandardJacksonConfigurations - Class in org.kiwiproject.dropwizard.util.jackson
-
Set of opinionated "standard" utilities to configure Jackson.
- StandardJacksonConfigurations() - Constructor for class org.kiwiproject.dropwizard.util.jackson.StandardJacksonConfigurations
- StandardLifecycles - Class in org.kiwiproject.dropwizard.util.lifecycle
-
Contains some "standard" static utilities related to Dropwizard and Jetty lifecycles.
- StandardLifecycles() - Constructor for class org.kiwiproject.dropwizard.util.lifecycle.StandardLifecycles
- StartupJettyLifeCycleListener - Class in org.kiwiproject.dropwizard.util.startup.listener
-
A Jetty
LifeCycle.Listener
that shuts down the system in the case of a lifecycle failure. - StartupJettyLifeCycleListener(SystemExecutioner) - Constructor for class org.kiwiproject.dropwizard.util.startup.listener.StartupJettyLifeCycleListener
- StartupLocker - Class in org.kiwiproject.dropwizard.util.startup
-
Utility to acquire and release a lock from ZooKeeper during startup of a Dropwizard service.
- StartupLockInfo - Class in org.kiwiproject.dropwizard.util.startup
-
A value class that contains information about a startup lock, such as whether a lock was successfully acquired, the lock path, the lock itself, as well as information when any exception occurs.
- StartupLockInfo.LockState - Enum in org.kiwiproject.dropwizard.util.startup
- StartupWithLockJettyLifeCycleListener - Class in org.kiwiproject.dropwizard.util.startup.listener
-
A Jetty
LifeCycle.Listener
that releases the ZooKeeper startup lock if it exists. - StartupWithLockJettyLifeCycleListener(CuratorFramework, InterProcessLock, String, SystemExecutioner) - Constructor for class org.kiwiproject.dropwizard.util.startup.listener.StartupWithLockJettyLifeCycleListener
- STATIC - org.kiwiproject.dropwizard.util.startup.PortAssigner.PortAssignment
- SystemExecutioner - Class in org.kiwiproject.dropwizard.util.startup
-
Wrapper around
System.exit(int)
for situations in which the JVM must be exited. - SystemExecutioner() - Constructor for class org.kiwiproject.dropwizard.util.startup.SystemExecutioner
-
Creates a new
SystemExecutioner
using the defaultExecutionStrategy
, which isExecutionStrategies.SystemExitExecutionStrategy
. - SystemExecutioner(ExecutionStrategy) - Constructor for class org.kiwiproject.dropwizard.util.startup.SystemExecutioner
-
Creates a new
SystemExecutioner
using the givenExecutionStrategy
. - systemExit() - Static method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies
-
Returns a strategy that uses the
System
class to exit/terminate the JVM. - systemExit(int) - Static method in class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies
-
Returns a strategy that uses the
System
class to exit/terminate the JVM. - SystemExitExecutionStrategy() - Constructor for class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.SystemExitExecutionStrategy
-
Construct an instance that will set the exit code to 1 (one).
- SystemExitExecutionStrategy(int) - Constructor for class org.kiwiproject.dropwizard.util.startup.ExecutionStrategies.SystemExitExecutionStrategy
-
Construct an instance that will use the given exit code.
T
- task(Runnable) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- timeout(Duration) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- timeout(Duration) - Method in class org.kiwiproject.dropwizard.util.job.MonitoredJobs.Builder
- toResponse(JsonProcessingException) - Method in class org.kiwiproject.dropwizard.util.exception.JsonProcessingExceptionMapper
- toResponse(E) - Method in class org.kiwiproject.dropwizard.util.exception.LoggingExceptionMapper
- toResponse(EmptyOptionalException) - Method in class org.kiwiproject.dropwizard.util.exception.EmptyOptionalExceptionMapper
- toResponse(JerseyViolationException) - Method in class org.kiwiproject.dropwizard.util.exception.JerseyViolationExceptionMapper
- toResponse(EofException) - Method in class org.kiwiproject.dropwizard.util.exception.EarlyEofExceptionMapper
U
- UnknownPropertiesHealthCheck - Class in org.kiwiproject.dropwizard.util.health
-
Health check that checks for unknown properties found during Jackson deserialization.
- UnknownPropertiesHealthCheck(LoggingDeserializationProblemHandler) - Constructor for class org.kiwiproject.dropwizard.util.health.UnknownPropertiesHealthCheck
V
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck.DependencyImportance
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.util.server.DropwizardConnectors.ConnectorType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.util.startup.PortAssigner.PortAssignment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.util.startup.PortAssigner.PortSecurity
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.util.startup.StartupLockInfo.LockState
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck.DependencyImportance
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.kiwiproject.dropwizard.util.server.DropwizardConnectors.ConnectorType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.kiwiproject.dropwizard.util.startup.PortAssigner.PortAssignment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.kiwiproject.dropwizard.util.startup.PortAssigner.PortSecurity
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.kiwiproject.dropwizard.util.startup.StartupLockInfo.LockState
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WANTED - org.kiwiproject.dropwizard.util.health.ServicePingHealthCheck.DependencyImportance
- withConfigResource(T, List<String>) - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
ConfigResource
on the service with the given config and optional list of regex patterns to exclude from the output. - withExpiringKeystoreHealthCheck(TlsContextConfiguration) - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
ExpiringKeystoreHealthCheck
on the service with the givenTlsContextConfiguration
. - withHttpConnectionsHealthCheck() - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
HttpConnectionsHealthCheck
on the service with the default warning threshold. - withHttpConnectionsHealthCheck(HttpHealthCheckConfig) - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
HttpConnectionsHealthCheck
on the service with the given warning threshold. - withServerLoadMetric() - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
ServerLoadGauge
on the service. - withServerLoadTask() - Method in class org.kiwiproject.dropwizard.util.admin.AdminConfigurator
-
Enables setup of the
ServerLoadTask
on the service.
All Classes All Packages