A C D E F G H I M N O R S T V W

A

add(ResultLog.Entry) - Method in class org.apache.sling.hc.api.ResultLog

Add an entry to this log.

ASYNC_CRON_EXPRESSION - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: If this property is set the health check will be executed asynchronously using the cron expression provided.

C

check(Object, String, ResultLog) - Method in class org.apache.sling.hc.util.SimpleConstraintChecker

Check value against expression and report to result

CONTAINS - Static variable in class org.apache.sling.hc.util.SimpleConstraintChecker

critical(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog

D

debug(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog

dispose() - Method in class org.apache.sling.hc.util.HealthCheckFilter

Dispose all used service references

E

empty() - Static method in class org.apache.sling.hc.api.execution.HealthCheckSelector

Entry(Result.Status, String) - Constructor for class org.apache.sling.hc.api.ResultLog.Entry

Entry(Result.Status, String, Exception) - Constructor for class org.apache.sling.hc.api.ResultLog.Entry

equals(Object) - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

equals(Object) - Method in class org.apache.sling.hc.util.HealthCheckMetadata

execute(HealthCheckSelector) - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutor

Executes all health checks matching the supplied filter options.

execute(HealthCheckSelector, HealthCheckExecutionOptions) - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutor

Executes all health checks with the supplied filter options.

execute(String...) - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutor

Deprecated.

use execute(HealthCheckFilter.Options)

execute(HealthCheckExecutionOptions, String...) - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutor

Deprecated.

use execute(HealthCheckFilter.Options, HealthCheckExecutionOptions)

execute() - Method in interface org.apache.sling.hc.api.HealthCheck

Execute this health check and return a Result This is meant to execute quickly, access to external systems, for example, should be managed asynchronously.

F

FormattingResultLog - Class in org.apache.sling.hc.util

Utility that provides a logging-like facade on a ResultLog

FormattingResultLog() - Constructor for class org.apache.sling.hc.util.FormattingResultLog

G

getAggregateStatus() - Method in class org.apache.sling.hc.api.ResultLog

Return our aggregate status, i.e.

getAsyncCronExpression() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

Return the cron expression used for asynchronous execution.

getElapsedTimeInMs() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult

Get the elapsed time in ms

getException() - Method in class org.apache.sling.hc.api.ResultLog.Entry

getFinishedAt() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult

Get the date, the health check finished or if the execution timed out, the execution was aborted.

getHealthCheckMetadata() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult

Get the meta data about the health check service

getHealthCheckResult() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult

Get the result of the health check run.

getHealthChecks(HealthCheckSelector) - Method in class org.apache.sling.hc.util.HealthCheckFilter

getHealthCheckServiceReferences(HealthCheckSelector) - Method in class org.apache.sling.hc.util.HealthCheckFilter

getHealthCheckServiceReferences(HealthCheckSelector, boolean) - Method in class org.apache.sling.hc.util.HealthCheckFilter

getMBeanName() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

The mbean name of the health check as defined through the HealthCheck.MBEAN_NAME property.

getMessage() - Method in class org.apache.sling.hc.api.ResultLog.Entry

getName() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

The name of the health check as defined through the HealthCheck.NAME property.

getOverrideGlobalTimeout() - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

getResultCacheTtlInMs() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

TTL for the result cache in ms.

getServiceId() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

Return the service id.

getServiceReference() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

Get the service reference.

getStatus() - Method in class org.apache.sling.hc.api.Result

Return our Status

getStatus() - Method in class org.apache.sling.hc.api.ResultLog.Entry

getTaggedHealthChecks(String...) - Method in class org.apache.sling.hc.util.HealthCheckFilter

Deprecated.

use getHealthChecks() instead

getTaggedHealthCheckServiceReferences(String...) - Method in class org.apache.sling.hc.util.HealthCheckFilter

Deprecated.

use getHealthCheckServiceReferences() instead

getTaggedHealthCheckServiceReferences(boolean, String...) - Method in class org.apache.sling.hc.util.HealthCheckFilter

Deprecated.

use getHealthCheckServiceReferences() instead

getTags() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

Return the list of defined tags for this check as set through HealthCheckMetadata.tags

getTitle() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

The title of the health check.

getWarningsStickForMinutes() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

Make warnings stick for the given amount of time.

H

hashCode() - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

hashCode() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

hasTimedOut() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult

Returns true if the execution has timed out.

HealthCheck - Interface in org.apache.sling.hc.api

Health Check services can be executed and return an execution Result.

healthCheckError(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog

HealthCheckExecutionOptions - Class in org.apache.sling.hc.api.execution

Options for behavior of health check execution.

HealthCheckExecutionOptions() - Constructor for class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

HealthCheckExecutionResult - Interface in org.apache.sling.hc.api.execution

Interface for health check executions via the HealthCheckExecutor.

HealthCheckExecutor - Interface in org.apache.sling.hc.api.execution

Executes health checks registered as OSGi services and implementing the interface HealthCheck.

HealthCheckFilter - Class in org.apache.sling.hc.util

Select from available HealthCheck services.

HealthCheckFilter(BundleContext) - Constructor for class org.apache.sling.hc.util.HealthCheckFilter

Create a new filter object

HealthCheckMetadata - Class in org.apache.sling.hc.util

This class helps retrieving meta data information about a health check service.

HealthCheckMetadata(ServiceReference) - Constructor for class org.apache.sling.hc.util.HealthCheckMetadata

HealthCheckSelector - Class in org.apache.sling.hc.api.execution

Parameter class to pass a set of tags and names to the filter.

I

info(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog

isCombineTagsWithOr() - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

isForceInstantExecution() - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

isOk() - Method in class org.apache.sling.hc.api.Result

True if our status is OK - provides a convenient way of checking that.

iterator() - Method in class org.apache.sling.hc.api.Result

Return an Iterator on the entries of our ResultLog

iterator() - Method in class org.apache.sling.hc.api.ResultLog

Return an Iterator on our entries

M

MBEAN_NAME - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: the name of the MBean for registering the health check as an MBean.

msHumanReadable(long) - Static method in class org.apache.sling.hc.util.FormattingResultLog

Utility method to return any magnitude of milliseconds in a human readable format using the appropriate time unit (ms, sec, min) depending on the magnitude of the input.

N

NAME - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: the name of a health check.

names() - Method in class org.apache.sling.hc.api.execution.HealthCheckSelector

names(String...) - Static method in class org.apache.sling.hc.api.execution.HealthCheckSelector

O

OMIT_PREFIX - Static variable in class org.apache.sling.hc.util.HealthCheckFilter

org.apache.sling.hc.api - package org.apache.sling.hc.api

org.apache.sling.hc.api.execution - package org.apache.sling.hc.api.execution

org.apache.sling.hc.util - package org.apache.sling.hc.util

R

Result - Class in org.apache.sling.hc.api

The result of executing a HealthCheck

Result(Result.Status, String) - Constructor for class org.apache.sling.hc.api.Result

Build a single-value Result

Result(Result.Status, String, Exception) - Constructor for class org.apache.sling.hc.api.Result

Build a single-value Result with exception

Result(ResultLog) - Constructor for class org.apache.sling.hc.api.Result

Build a a Result based on a ResultLog, which can provide more details than a single-value Result.

Result.Status - Enum in org.apache.sling.hc.api

RESULT_CACHE_TTL_IN_MS - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: TTL for health check Result.

resultLog - Variable in class org.apache.sling.hc.api.Result

ResultLog - Class in org.apache.sling.hc.api

The log of a Result, allows for providing multiple lines of information which are aggregated as a single Result.

ResultLog() - Constructor for class org.apache.sling.hc.api.ResultLog

Build a log.

ResultLog(ResultLog) - Constructor for class org.apache.sling.hc.api.ResultLog

Create a copy of the result log

ResultLog.Entry - Class in org.apache.sling.hc.api

An entry in this log

S

setCombineTagsWithOr(boolean) - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

If activated, the given tags will be combined with a logical "or" instead of "and".

setForceInstantExecution(boolean) - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

If activated, this will ensure that asynchronous checks will be executed immediately.

setOverrideGlobalTimeout(int) - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

Allows to override the global timeout for this particular execution of the health check.

SimpleConstraintChecker - Class in org.apache.sling.hc.util

Simple check of numeric values against expressions like < N, > N, between two values etc.

SimpleConstraintChecker() - Constructor for class org.apache.sling.hc.util.SimpleConstraintChecker

T

tags() - Method in class org.apache.sling.hc.api.execution.HealthCheckSelector

tags(String...) - Static method in class org.apache.sling.hc.api.execution.HealthCheckSelector

TAGS - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: tags for categorizing the health check services.

toString() - Method in class org.apache.sling.hc.api.execution.HealthCheckExecutionOptions

toString() - Method in class org.apache.sling.hc.api.execution.HealthCheckSelector

toString() - Method in class org.apache.sling.hc.api.Result

toString() - Method in class org.apache.sling.hc.api.ResultLog.Entry

toString() - Method in class org.apache.sling.hc.api.ResultLog

toString() - Method in class org.apache.sling.hc.util.HealthCheckMetadata

V

valueOf(String) - Static method in enum org.apache.sling.hc.api.Result.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.sling.hc.api.Result.Status

Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog

WARNINGS_STICK_FOR_MINUTES - Static variable in interface org.apache.sling.hc.api.HealthCheck

Optional service property: If given, warning results (that is WARN, CRITICAL or HEALTH_CHECK_ERROR) from the past executions will be taken into account as well for the given minutes (use Integer.MAX_VALUE for indefinitely).

withNames(String...) - Method in class org.apache.sling.hc.api.execution.HealthCheckSelector

Copy the specified names into the current names array.

withTags(String...) - Method in class org.apache.sling.hc.api.execution.HealthCheckSelector

Copy the specified names into the current tags array.

A C D E F G H I M N O R S T V W