Package org.opends.server.backends.pluggable.spi

Class StorageStatus

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StorageStatus.Code	Enumeration of the possible states.

Method Summary

Modifier and Type	Method	Description
static StorageStatus	available()	Returns available status.
StorageStatus.Code	getCode()	Returns the code of this status.
LocalizableMessage	getReason()	Returns the error message for non available statuses.
static StorageStatus	internalError(LocalizableMessage reason)	Returns internal error status.
static StorageStatus	lockedDown(LocalizableMessage reason)	Returns state for resources getting scarce.
static StorageStatus	unavailable(LocalizableMessage reason)	Returns unavailable status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

available

public static StorageStatus available()

Returns available status.

Returns:

available status

lockedDown

public static StorageStatus lockedDown(LocalizableMessage reason)

Returns state for resources getting scarce.

Parameters:

reason - the message to forward

Returns:

state for resources getting scarce

unavailable

public static StorageStatus unavailable(LocalizableMessage reason)

Returns unavailable status.

Parameters:

reason - the message to forward

Returns:

state for server being unavailable

internalError

public static StorageStatus internalError(LocalizableMessage reason)

Returns internal error status.

Parameters:

reason - the message to forward

Returns:

state for server having an internal error

getCode

public StorageStatus.Code getCode()

Returns the code of this status.

Returns:

the code of this status

getReason

public LocalizableMessage getReason()

Returns the error message for non available statuses.

Returns:

the error message for non available statuses