AbstractBasicReadinessProbe (JCMS API)

java.lang.Object
- com.jalios.jcms.readiness.AbstractBasicReadinessProbe

All Implemented Interfaces:: ReadinessProbeInterface

Direct Known Subclasses:: FileReadinessProbe

public abstract class AbstractBasicReadinessProbe
extends java.lang.Object
implements ReadinessProbeInterface

Constructor Summary

Constructors
Constructor Description

AbstractBasicReadinessProbe()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`removeReadinessProbe()`	Remove the readiness probe (call at application init)
`void`	`setErrorProbe(java.lang.String message)`	Set the error probe when the application is not correctly started
`void`	`setReadinessProbe()`	Set the readiness probe when the application is correctly started

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

- Constructor Detail
  - AbstractBasicReadinessProbe
```
public AbstractBasicReadinessProbe()
```
- Method Detail
  - removeReadinessProbe
```
public void removeReadinessProbe()
                          throws java.lang.Exception
```
    Description copied from interface: ReadinessProbeInterface
    
    Remove the readiness probe (call at application init)
    
    Specified by:
    
    removeReadinessProbe in interface ReadinessProbeInterface
    
    Throws:
    
    java.lang.Exception - if the probe cannot be executed correctly
  - setReadinessProbe
```
public void setReadinessProbe()
                       throws java.lang.Exception
```
    Description copied from interface: ReadinessProbeInterface
    
    Set the readiness probe when the application is correctly started
    
    Specified by:
    
    setReadinessProbe in interface ReadinessProbeInterface
    
    Throws:
    
    java.lang.Exception - if the probe cannot be executed correctly
  - setErrorProbe
```
public void setErrorProbe(java.lang.String message)
                   throws java.lang.Exception
```
    Description copied from interface: ReadinessProbeInterface
    
    Set the error probe when the application is not correctly started
    
    Specified by:
    
    setErrorProbe in interface ReadinessProbeInterface
    
    Parameters:
    
    message - an error message
    
    Throws:
    
    java.lang.Exception - if the probe cannot be executed correctly