Guardian (Java API Reference for Oracle® Coherence Community Edition)

```
public interface Guardian
```
A Guardian is responsible for monitoring the registered Guardable objects.

Since:

Coherence 3.5

Author:

rhl

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface Guardian.GuardContext
A GuardContext represents the lifecycle status of a Guardable.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`float`	`getDefaultGuardRecovery()`	Default recovery percentage for Guardables monitored by this Guardian.
`long`	`getDefaultGuardTimeout()`	Default timeout interval (in milliseconds) for Guardables monitored by this Guardian.
`Guardian.GuardContext`	`guard(Guardable guardable)`	Register the specified Guardable based on the Guardian's SLA parameters.
`Guardian.GuardContext`	`guard(Guardable guardable, long cMillis, float flPctRecover)`	Register the specified Guardable with the specified SLA parameters.

- Method Detail
  - guard
```
Guardian.GuardContext guard(Guardable guardable)
```
    Register the specified Guardable based on the Guardian's SLA parameters.
    It's possible that the Guardian's defaults will prevent the Guardable from being registered. In such a case, this method returns null.
    
    Parameters:
    
    guardable - the Guardable to be monitored by this Guardian
    
    Returns:
    
    the GuardContext for the specified Guardable (could be null)
  - guard
```
Guardian.GuardContext guard(Guardable guardable,
                            long cMillis,
                            float flPctRecover)
```
    Register the specified Guardable with the specified SLA parameters.
    
    Parameters:
    
    guardable - the Guardable to be guarded by this Guardian
    
    cMillis - the timeout for the specified Guardable
    
    flPctRecover - the percentage of the timeout after which to attempt recovery of the Guardable; 0 < flPctRecover <= 1.0
    
    Returns:
    
    the GuardContext for the specified Guardable
  - getDefaultGuardTimeout
```
long getDefaultGuardTimeout()
```
    Default timeout interval (in milliseconds) for Guardables monitored by this Guardian.
    
    Returns:
    
    the default timeout interval
  - getDefaultGuardRecovery
```
float getDefaultGuardRecovery()
```
    Default recovery percentage for Guardables monitored by this Guardian.
    
    Returns:
    
    the default recovery percentage