Package org.nuxeo.ecm.core.management.api

Interface ProbeManager

All Superinterfaces:

ProbeRunnerMBean

All Known Implementing Classes:

ProbeManagerImpl

public interface ProbeManager
extends ProbeRunnerMBean

Since:

5.4

Method Summary

Modifier and Type	Method	Description
Collection<ProbeInfo>	getAllProbeInfos()
Collection<ProbeInfo>	getHealthCheckProbes()	List of probes evaluated for a health check
Collection<ProbeInfo>	getInFailureProbeInfos()
Collection<ProbeInfo>	getInSuccessProbeInfos()
HealthCheckResult	getOrRunHealthCheck(String probe)	Return the status of the given probe.
HealthCheckResult	getOrRunHealthChecks()	Return the status of all the probes evaluated for a healthCheck.
ProbeInfo	getProbeInfo(Class<? extends Probe> probeClass)
ProbeInfo	getProbeInfo(String name)
void	registerProbeForHealthCheck(HealthCheckProbesDescriptor descriptor)	This probe is taken into account for the healthCheck
ProbeInfo	runProbe(String name)
ProbeInfo	runProbe(ProbeInfo probe)

Methods inherited from interface org.nuxeo.ecm.core.management.api.ProbeRunnerMBean

getProbeNames, getProbesCount, getProbesInError, getProbesInErrorCount, getProbesInSuccess, getProbesInSuccessCount, runAllProbes

Method Details

getAllProbeInfos

Collection<ProbeInfo> getAllProbeInfos()

getInSuccessProbeInfos

Collection<ProbeInfo> getInSuccessProbeInfos()

getInFailureProbeInfos

Collection<ProbeInfo> getInFailureProbeInfos()

runProbe

ProbeInfo runProbe(ProbeInfo probe)

runProbe

ProbeInfo runProbe(String name)

getProbeInfo

ProbeInfo getProbeInfo(String name)

getProbeInfo

ProbeInfo getProbeInfo(Class<? extends Probe> probeClass)

getHealthCheckProbes

Collection<ProbeInfo> getHealthCheckProbes()

List of probes evaluated for a health check

Since:

9.3

getOrRunHealthChecks

HealthCheckResult getOrRunHealthChecks()

Return the status of all the probes evaluated for a healthCheck. The probes are run if the last run was more than a short while ago

Since:

9.3

registerProbeForHealthCheck

void registerProbeForHealthCheck(HealthCheckProbesDescriptor descriptor)

This probe is taken into account for the healthCheck

Since:

9.3

getOrRunHealthCheck

HealthCheckResult getOrRunHealthCheck(String probe)

Return the status of the given probe. The probe is run only if the last run was more than a short while ago

Since:

9.3