A C D E F G I L M N O P R S T U V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addPollLatencyMeasurement(long) - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Adds a new latency measurement for how long a poll took.
- addPollLatencyMeasurement(long) - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
-
See section "Cumulative moving average" (CMA) on Moving Average page: https://en.wikipedia.org/wiki/Moving_average
- andRegisterHealthChecks(Environment) - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Named specifically to be used as part of the fluent builder API, e.g.
- andRegisterHealthChecks(Environment, PollerHealthCheckConfig) - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Named specifically to be used as part of the fluent builder API, e.g.
- ASYNC - org.kiwiproject.dropwizard.poller.ConsumerType
- averagePollLatencyInMillis() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The average number of milliseconds it takes per poll.
- averagePollLatencyInMillis() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
C
- check() - Method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
- check() - Method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
- ClientPoller - Class in org.kiwiproject.dropwizard.poller
-
Polls a specified HTTP(S) endpoint either synchronously or asynchronously using a JAX-RS
SyncInvoker
. - ClientPoller() - Constructor for class org.kiwiproject.dropwizard.poller.ClientPoller
- ClientPoller.DelayType - Enum in org.kiwiproject.dropwizard.poller
-
Whether to poll using fixed rate or with fixed delay, as defined by
ScheduledExecutorService
. - ClientPollerHealthChecks - Class in org.kiwiproject.dropwizard.poller.health
-
Utility class used by the poller health checks that provides common utilities for generating names and results for the health check.
- ClientPollerHealthChecks() - Constructor for class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
- ClientPollerHealthChecks.PollerHealthCheck - Class in org.kiwiproject.dropwizard.poller.health
- ClientPollerLatencyBasedHealthCheck - Class in org.kiwiproject.dropwizard.poller.health
-
Health check that monitors and alerts if the average polling latency grows beyond an acceptable threshold
- ClientPollerMissedPollHealthCheck - Class in org.kiwiproject.dropwizard.poller.health
-
Health check that monitors and alerts if missed polls grows beyond an acceptable threshold
- ClientPollerStatistics - Interface in org.kiwiproject.dropwizard.poller.metrics
-
Defines contract for collecting basic statistics on
ClientPoller
instances. - ClientPollerTimeBasedHealthCheck - Class in org.kiwiproject.dropwizard.poller.health
- ClientPollerTimeBasedHealthCheck(long, TemporalUnit, int, int, ClientPollerStatistics, long, TemporalUnit, KiwiEnvironment) - Constructor for class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
- ConsumerType - Enum in org.kiwiproject.dropwizard.poller
-
Defines how to consume responses in the
ClientPoller
, either synchronously or asynchronously.
D
- DEFAULT_AVG_LATENCY_WARNING_THRESHOLD_MILLIS - Static variable in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
-
Default threshold amount for average latency above which this health check will report unhealthy.
- DEFAULT_FAILED_POLLS_UNHEALTHY_THRESHOLD_PERCENT - Static variable in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Defines the default threshold for failed polls within time window as 2%
- DEFAULT_INITIAL_EXECUTION_DELAY - Static variable in class org.kiwiproject.dropwizard.poller.ClientPoller
-
The default duration to wait before the first execution
- DEFAULT_MISSING_POLL_MULTIPLIER - Static variable in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
The default multiplier for computing the allowable time since the last attempted poll.
- DEFAULT_SUPPLIER_TIMEOUT - Static variable in class org.kiwiproject.dropwizard.poller.ClientPoller
-
The default timeout value for the
ClientPoller.supplier
- DEFAULT_SUPPLIER_TIMEOUT_UNIT - Static variable in class org.kiwiproject.dropwizard.poller.ClientPoller
-
The default timeout unit for the
ClientPoller.supplier
- DEFAULT_SYNC_RESPONSE_CONSUMER_TIMEOUT - Static variable in class org.kiwiproject.dropwizard.poller.ClientPoller
-
The default timeout value when polling synchronously
- DEFAULT_SYNC_RESPONSE_CONSUMER_TIMEOUT_UNIT - Static variable in class org.kiwiproject.dropwizard.poller.ClientPoller
-
The default timeout unit when polling synchronously
- DEFAULT_TIME_WINDOW_MINUTES - Static variable in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Default time window amount in minutes
- defaultClass() - Static method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The default class to be used when no
ClientPollerStatistics
is specified. - DefaultClientPollerStatistics - Class in org.kiwiproject.dropwizard.poller.metrics
-
The default implementation of
ClientPollerStatistics
. - DefaultClientPollerStatistics() - Constructor for class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- DefaultClientPollerStatistics.FailedPollResult - Class in org.kiwiproject.dropwizard.poller.metrics
E
- EXCEPTION_MESSAGE_KEY - Static variable in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
- EXCEPTION_TYPE_KEY - Static variable in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
F
- failureCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The number of failed polls.
- failureCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- FIXED_DELAY - org.kiwiproject.dropwizard.poller.ClientPoller.DelayType
- FIXED_RATE - org.kiwiproject.dropwizard.poller.ClientPoller.DelayType
G
- getDetails() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
I
- incrementCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Increment the number of attempted polls.
- incrementCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- incrementFailureCount(String) - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Increment the number of failed polls.
- incrementFailureCount(String) - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- incrementFailureCount(Throwable) - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Increment the number of failed polls.
- incrementFailureCount(Throwable) - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- incrementSkipCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Increment the number of times polling was skipped.
- incrementSkipCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- incrementSuccessCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Increment the number of successful polls.
- incrementSuccessCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- isAsync() - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Return
true
if this poller is asynchronous, otherwisefalse
. - isAsync() - Method in enum org.kiwiproject.dropwizard.poller.ConsumerType
- isPolling() - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Return
true
if this poller is currently polling, orfalse
if it has not been started yet or if it has been stopped. - isSync() - Method in enum org.kiwiproject.dropwizard.poller.ConsumerType
L
- lastAttemptTimeInMillis() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Number of milliseconds since the epoch that the last poll attempt was made.
- lastAttemptTimeInMillis() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- lastFailureTimeInMillis() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Number of milliseconds since the epoch that the last failure occurred.
- lastFailureTimeInMillis() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- lastSkipTimeInMillis() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Number of milliseconds since the epoch that the last poll attempt was skipped.
- lastSkipTimeInMillis() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
M
- maxRecentFailureTimes() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Return the maximum number of failure times this implementation supports.
- maxRecentFailureTimes() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- MESSAGE_KEY - Static variable in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
N
- nameFor(String) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
- nameFor(String) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
Return a name that can be used for a health check polling the given URI as a string.
- nameFor(String) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Return a name that can be used for a health check polling the given URI as a string.
- nameFor(String, String) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Build a name for the given
healthCheckType
andpollingUri
- nameFor(String, URI) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Build a name for the given
healthCheckType
andpollingUri
- nameFor(URI) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
-
Return a name that can be used for a health check polling the given URI.
- nameFor(URI) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
Return a name that can be used for a health check polling the given URI.
- nameFor(URI) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Return a name that can be used for a health check polling the given URI.
- newClientPollerStatisticsOfDefaultType() - Static method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Factory method to create an instance of the default class for this interface.
O
- of(long, TemporalUnit, int, ClientPollerStatistics, long, TemporalUnit, KiwiEnvironment) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poll interval/units, with the givenClientPollerStatistics
, with the given time window/units, and the givenKiwiEnvironment
. - of(long, TemporalUnit, ClientPollerStatistics) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poll interval/units and with the givenClientPollerStatistics
- of(long, TemporalUnit, ClientPollerStatistics, long, TemporalUnit) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poll interval/units, with the givenClientPollerStatistics
, and with the given time window/units. - of(ClientPoller) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poller with the default multiplier - of(ClientPoller, Integer) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poller with the given multiplier - of(ClientPoller, PollerHealthCheckConfig) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
-
Create instance using given
ClientPoller
andPollerHealthCheckConfig
- of(ClientPoller, PollerHealthCheckConfig) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerMissedPollHealthCheck
-
Create a new
ClientPollerMissedPollHealthCheck
for the given poller with the givenPollerHealthCheckConfig
- of(ClientPoller, PollerHealthCheckConfig) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerTimeBasedHealthCheck
-
Create a new
ClientPollerTimeBasedHealthCheck
for the given poller with the givenPollerHealthCheckConfig
- of(ClientPollerStatistics) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
-
Create instance using given statistics and a default latency threshold of
DEFAULT_AVG_LATENCY_WARNING_THRESHOLD_MILLIS
. - of(ClientPollerStatistics, long, TemporalUnit) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerLatencyBasedHealthCheck
-
Create instance using given statistics, and specified latency warning threshold.
- org.kiwiproject.dropwizard.poller - package org.kiwiproject.dropwizard.poller
- org.kiwiproject.dropwizard.poller.config - package org.kiwiproject.dropwizard.poller.config
- org.kiwiproject.dropwizard.poller.health - package org.kiwiproject.dropwizard.poller.health
- org.kiwiproject.dropwizard.poller.metrics - package org.kiwiproject.dropwizard.poller.metrics
P
- PollerHealthCheck() - Constructor for class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks.PollerHealthCheck
- PollerHealthCheckConfig - Class in org.kiwiproject.dropwizard.poller.config
-
Specifies configuration properties for the various poller health checks.
- PollerSyncInvokerWrapper - Class in org.kiwiproject.dropwizard.poller
-
A wrapper for a
SyncInvoker
in order for the poller to have access to the original URI for logging and debugging - PollerSyncInvokerWrapper() - Constructor for class org.kiwiproject.dropwizard.poller.PollerSyncInvokerWrapper
R
- recentFailureDetails() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Returns a
Stream
of Map<String, Object> of error attributes for recent poll failures - recentFailureDetails() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- recentFailureTimesInMillis() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
Returns a
Stream
over recent timestamps of poll failures. - recentFailureTimesInMillis() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- registerHealthChecks(Environment) - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Registers client poller health checks on this poller.
- registerHealthChecks(Environment, PollerHealthCheckConfig) - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Registers client poller health checks on this poller using the given
PollerHealthCheckConfig
. - registerPollerHealthChecks(ClientPoller, Environment) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Convenience method that registers the following health checks for the given poller and Dropwizard environment:
ClientPollerTimeBasedHealthCheck
,ClientPollerLatencyBasedHealthCheck
, andClientPollerMissedPollHealthCheck
- registerPollerHealthChecks(ClientPoller, Environment, PollerHealthCheckConfig) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Convenience method that registers the following health checks for the given poller and Dropwizard environment:
ClientPollerTimeBasedHealthCheck
,ClientPollerLatencyBasedHealthCheck
, andClientPollerMissedPollHealthCheck
S
- skipCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The number of skipped polls.
- skipCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- start() - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Starts the poller with default delay type of FIXED_DELAY
- start(ClientPoller.DelayType) - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
- statistics() - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Returns the
ClientPollerStatistics
instance that is collecting stats for this poller. - stop() - Method in class org.kiwiproject.dropwizard.poller.ClientPoller
-
Stops the poller.
- successCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The number of successful polls.
- successCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
- SYNC - org.kiwiproject.dropwizard.poller.ConsumerType
T
- TIME_KEY - Static variable in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
- TIME_STRING_KEY - Static variable in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics.FailedPollResult
- totalCount() - Method in interface org.kiwiproject.dropwizard.poller.metrics.ClientPollerStatistics
-
The sum of the incremented success and failure counts.
- totalCount() - Method in class org.kiwiproject.dropwizard.poller.metrics.DefaultClientPollerStatistics
U
- unhealthy(ClientPollerStatistics, String, Object...) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Build an unhealthy
HealthCheck.Result
using the given statistics, message, and arguments usingHealthStatus.WARN
as the severity. - unhealthy(ClientPollerStatistics, HealthStatus, String, Object...) - Static method in class org.kiwiproject.dropwizard.poller.health.ClientPollerHealthChecks
-
Build an unhealthy
HealthCheck.Result
using the given statistics, severity, message, and arguments.
V
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.poller.ClientPoller.DelayType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.kiwiproject.dropwizard.poller.ConsumerType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.kiwiproject.dropwizard.poller.ClientPoller.DelayType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.kiwiproject.dropwizard.poller.ConsumerType
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes All Packages