StorageStatus (OpenDJ Directory Services Project 5.2.0-SNAPSHOT API)

java.lang.Object
- org.opends.server.backends.pluggable.spi.StorageStatus

```
public final class StorageStatus
extends Object
```
Represents the current status of a storage with respect to its resources.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.forgerock.i18n.LocalizableMessage`	`getReason()`	Returns the error message for non working states.
`boolean`	`isLockedDown()`	Returns true if resources are getting scarce.
`boolean`	`isUnusable()`	Returns true if no more resources are available.
`boolean`	`isWorking()`	Returns true if state is normal.
`static StorageStatus`	`lockedDown(org.forgerock.i18n.LocalizableMessage reason)`	Returns state for resources getting scarce.
`static StorageStatus`	`unusable(org.forgerock.i18n.LocalizableMessage reason)`	Returns state for no more resources.
`static StorageStatus`	`working()`	Returns normal state.

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

- Method Detail
  - working
```
public static StorageStatus working()
```
    Returns normal state.
    
    Returns:
    
    normal state
  - lockedDown
```
public static StorageStatus lockedDown(org.forgerock.i18n.LocalizableMessage reason)
```
    Returns state for resources getting scarce.
    
    Parameters:
    
    reason - the message to forward
    
    Returns:
    
    state for resources getting scarce
  - unusable
```
public static StorageStatus unusable(org.forgerock.i18n.LocalizableMessage reason)
```
    Returns state for no more resources.
    
    Parameters:
    
    reason - the message to forward
    
    Returns:
    
    state for no more resources
  - isLockedDown
```
public boolean isLockedDown()
```
    Returns true if resources are getting scarce.
    
    Returns:
    
    true if resources are getting scarce
  - isWorking
```
public boolean isWorking()
```
    Returns true if state is normal.
    
    Returns:
    
    true if state is normal
  - isUnusable
```
public boolean isUnusable()
```
    Returns true if no more resources are available.
    
    Returns:
    
    true if no more resources are available
  - getReason
```
public org.forgerock.i18n.LocalizableMessage getReason()
```
    Returns the error message for non working states.
    
    Returns:
    
    the error message for non working states