AbstractMemoryHealthIndicator (Cumulocity Microservice SDK)

java.lang.Object
- org.springframework.boot.actuate.health.AbstractHealthIndicator
- - com.cumulocity.microservice.monitoring.health.indicator.memory.AbstractMemoryHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator

Direct Known Subclasses:

HeapMemoryHealthIndicator, NonHeapMemoryHealthIndicator
```
public abstract class AbstractMemoryHealthIndicator
extends org.springframework.boot.actuate.health.AbstractHealthIndicator
```

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractMemoryHealthIndicator(AbstractMemoryHealthIndicatorProperties properties)
Create a new AbstractMemoryHealthIndicator.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)`
`protected abstract MemoryUsage`	`getMemoryUsage(MemoryMXBean memoryMXBean)`	Returns the `MemoryUsage` to perform the health check on.

Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator
health

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator
getHealth

- Constructor Detail
  - AbstractMemoryHealthIndicator
```
protected AbstractMemoryHealthIndicator(AbstractMemoryHealthIndicatorProperties properties)
```
    Create a new AbstractMemoryHealthIndicator.
    
    Parameters:
    
    properties - the memory properties
- Method Detail
  - doHealthCheck
```
protected final void doHealthCheck(org.springframework.boot.actuate.health.Health.Builder builder)
                            throws Exception
```
    Specified by:
    
    doHealthCheck in class org.springframework.boot.actuate.health.AbstractHealthIndicator
    
    Throws:
    
    Exception
  - getMemoryUsage
```
protected abstract MemoryUsage getMemoryUsage(MemoryMXBean memoryMXBean)
```
    Returns the MemoryUsage to perform the health check on.
    
    Parameters:
    
    memoryMXBean - the configured MemoryMXBean to extract the MemoryUsage from
    
    Returns:
    
    the MemoryUsage to perform the health check on