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

A

activate(ComponentContext) - Method in class org.apache.sling.hc.core.impl.CompositeHealthCheck
 
activate(ComponentContext) - Method in class org.apache.sling.hc.core.impl.executor.AsyncHealthCheckExecutor
 
activate(Map<String, Object>, BundleContext) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
activate(Map<String, Object>) - Method in class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
activate(ComponentContext) - Method in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
activate(BundleContext) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBeanCreator
 
add(ResultLog.Entry) - Method in class org.apache.sling.hc.api.ResultLog
Add an entry to this log.
addBindings(Bindings) - Method in class org.apache.sling.hc.core.impl.JmxScriptBindingsProvider
 
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.
AsyncHealthCheckExecutor - Class in org.apache.sling.hc.core.impl.executor
Runs health checks that are configured with a cron expression for asynchronous execution.
AsyncHealthCheckExecutor() - Constructor for class org.apache.sling.hc.core.impl.executor.AsyncHealthCheckExecutor
 
attribute(String, String) - Method in class org.apache.sling.hc.core.impl.JmxScriptBindingsProvider.AttributeBinding
 

B

bindBindingsValuesProvider(BindingsValuesProvider) - Method in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 

C

check(Object, String, ResultLog) - Method in class org.apache.sling.hc.util.SimpleConstraintChecker
Check value against expression and report to result
clear() - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
Clear the whole cache
compareTo(ExecutionResult) - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
Natural order of results (failed results are sorted before ok results).
CompositeHealthCheck - Class in org.apache.sling.hc.core.impl
HealthCheck that executes a number of other HealthChecks, selected by their tags, and merges their Results.
CompositeHealthCheck() - Constructor for class org.apache.sling.hc.core.impl.CompositeHealthCheck
 
CompositeResult - Class in org.apache.sling.hc.core.impl
 
CompositeResult(ResultLog, List<HealthCheckExecutionResult>) - Constructor for class org.apache.sling.hc.core.impl.CompositeResult
 
CONTAINS - Static variable in class org.apache.sling.hc.util.SimpleConstraintChecker
 
critical(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog
 

D

deactivate() - Method in class org.apache.sling.hc.core.impl.CompositeHealthCheck
 
deactivate(ComponentContext) - Method in class org.apache.sling.hc.core.impl.executor.AsyncHealthCheckExecutor
 
deactivate() - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
deactivate() - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBeanCreator
 
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

equals(Object) - Method in class org.apache.sling.hc.util.HealthCheckMetadata
 
execute(String...) - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutor
Executes all health checks with the supplied list of tags.
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.
execute() - Method in class org.apache.sling.hc.core.impl.CompositeHealthCheck
 
execute(ServiceReference) - Method in interface org.apache.sling.hc.core.impl.executor.ExtendedHealthCheckExecutor
 
execute(String...) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
execute(ServiceReference) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
execute() - Method in class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
execute() - Method in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
ExecutionResult - Class in org.apache.sling.hc.core.impl.executor
The result of executing a HealthCheck.
ExecutionResult(HealthCheckMetadata, Result, long, boolean) - Constructor for class org.apache.sling.hc.core.impl.executor.ExecutionResult
Full constructor
ExecutionResult(HealthCheckMetadata, Result, long) - Constructor for class org.apache.sling.hc.core.impl.executor.ExecutionResult
Shortcut constructor for a result
ExecutionResult(HealthCheckMetadata, Result.Status, String, long, boolean) - Constructor for class org.apache.sling.hc.core.impl.executor.ExecutionResult
Shortcut constructor to create error/timed out result.
ExtendedHealthCheckExecutor - Interface in org.apache.sling.hc.core.impl.executor
Internal service used by the JMX stuff

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.
getAttribute(String) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
getAttributes(String[]) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
getElapsedTimeInMs() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult
Get the elapsed time in ms
getElapsedTimeInMs() - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
 
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.
getFinishedAt() - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
 
getHealthCheckMetadata() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult
Get the meta data about the health check service
getHealthCheckMetadata() - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
 
getHealthCheckResult() - Method in interface org.apache.sling.hc.api.execution.HealthCheckExecutionResult
Get the result of the health check run.
getHealthCheckResult() - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
 
getMBeanInfo() - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
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.
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
Get all health check services with one of the supplied tags.
getTaggedHealthCheckServiceReferences(String...) - Method in class org.apache.sling.hc.util.HealthCheckFilter
Get all service references for health check services with one of the supplied tags.
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.

H

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.
hasTimedOut() - Method in class org.apache.sling.hc.core.impl.executor.ExecutionResult
 
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
 
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.
HealthCheckExecutorImpl - Class in org.apache.sling.hc.core.impl.executor
Runs health checks for a given list of tags in parallel.
HealthCheckExecutorImpl() - Constructor for class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
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
HealthCheckMBean - Class in org.apache.sling.hc.jmx.impl
A DynamicMBean used to execute a HealthCheck service
HealthCheckMBean(ServiceReference, ExtendedHealthCheckExecutor) - Constructor for class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
HealthCheckMBeanCreator - Class in org.apache.sling.hc.jmx.impl
Creates an HealthCheckMbean for every HealthCheckMBean service
HealthCheckMBeanCreator() - Constructor for class org.apache.sling.hc.jmx.impl.HealthCheckMBeanCreator
 
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
 
HealthCheckResultCache - Class in org.apache.sling.hc.core.impl.executor
Caches health check results.
HealthCheckResultCache() - Constructor for class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
 

I

info(String, Object...) - Method in class org.apache.sling.hc.util.FormattingResultLog
 
invoke(String, Object[], String[]) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
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

J

JMX_BINDING_NAME - Static variable in class org.apache.sling.hc.core.impl.JmxScriptBindingsProvider
 
JmxAttributeHealthCheck - Class in org.apache.sling.hc.core.impl
HealthCheck that checks a single JMX attribute
JmxAttributeHealthCheck() - Constructor for class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
JmxScriptBindingsProvider - Class in org.apache.sling.hc.core.impl
The JmxBinding is meant to be bound as "jmx" global variables in scripted rules, to allow for writing scripted expressions like jmx.attribute("java.lang:type=ClassLoading", "LoadedClassCount") > 100
JmxScriptBindingsProvider() - Constructor for class org.apache.sling.hc.core.impl.JmxScriptBindingsProvider
 
JmxScriptBindingsProvider.AttributeBinding - Class in org.apache.sling.hc.core.impl
 

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.
modified(Map<String, Object>) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
msHumanReadable(long) - Static method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 

N

NAME - Static variable in interface org.apache.sling.hc.api.HealthCheck
Optional service property: the name of a health check.

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.core.impl - package org.apache.sling.hc.core.impl
 
org.apache.sling.hc.core.impl.executor - package org.apache.sling.hc.core.impl.executor
 
org.apache.sling.hc.jmx.impl - package org.apache.sling.hc.jmx.impl
 
org.apache.sling.hc.util - package org.apache.sling.hc.util
 

P

PROP_ATTRIBUTE_NAME - Static variable in class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
PROP_CONSTRAINT - Static variable in class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
PROP_EXPRESSION - Static variable in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
PROP_LANGUAGE_EXTENSION - Static variable in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
PROP_LONGRUNNING_FUTURE_THRESHOLD_CRITICAL_MS - Static variable in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
PROP_OBJECT_NAME - Static variable in class org.apache.sling.hc.core.impl.JmxAttributeHealthCheck
 
PROP_RESULT_CACHE_TTL_MS - Static variable in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
PROP_TIMEOUT_MS - Static variable in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 

R

removeCachedResult(Long) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
Remove entry from cache
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
 
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
ResultLog.Entry(Result.Status, String) - Constructor for class org.apache.sling.hc.api.ResultLog.Entry
 
ResultLog.Entry(Result.Status, String, Exception) - Constructor for class org.apache.sling.hc.api.ResultLog.Entry
 

S

ScriptableHealthCheck - Class in org.apache.sling.hc.core.impl
HealthCheck that checks a scriptable expression
ScriptableHealthCheck() - Constructor for class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
serviceChanged(ServiceEvent) - Method in class org.apache.sling.hc.core.impl.executor.AsyncHealthCheckExecutor
 
serviceChanged(ServiceEvent) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
setAttribute(Attribute) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
setAttributes(AttributeList) - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
setLongRunningFutureThresholdForRedMs(long) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
setTimeoutInMs(long) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl
 
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 - 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.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.core.impl.executor.ExecutionResult
 
toString() - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
 
toString() - Method in class org.apache.sling.hc.jmx.impl.HealthCheckMBean
 
toString() - Method in class org.apache.sling.hc.util.HealthCheckMetadata
 

U

unbindBindingsValuesProvider(BindingsValuesProvider) - Method in class org.apache.sling.hc.core.impl.ScriptableHealthCheck
 
updateWith(HealthCheckExecutionResult) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
Update the cache with the result
useValidCacheResults(List<HealthCheckMetadata>, Collection<HealthCheckExecutionResult>, long) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
Get the valid cache results
useValidCacheResults(HealthCheckMetadata, long) - Method in class org.apache.sling.hc.core.impl.executor.HealthCheckResultCache
Return the cached result if it's still valid.

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
 
A B C D E F G H I J M N O P R S T U V W 

Copyright © 2013–2014 The Apache Software Foundation. All rights reserved.