Package org.apache.jackrabbit.oak.commons.jmx

Class ManagementOperation.Status

java.lang.Object

org.apache.jackrabbit.oak.commons.jmx.ManagementOperation.Status

Enclosing class:

ManagementOperation<R>

public static final class ManagementOperation.Status
extends Object

Status of a ManagementOperation. One of unavailable(String), none(String), initiated(String), running(String), succeeded(String) and failed(String), the semantics of which correspond to the respective status codes in RepositoryManagementMBean.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ITEM_CODE
static String	ITEM_ID
static String	ITEM_MESSAGE
static String[]	ITEM_NAMES
static CompositeType	ITEM_TYPES

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object that)
static ManagementOperation.Status	failed(String message)
static ManagementOperation.Status	failed(ManagementOperation<?> op, String message)
static String	formatTime(long nanos)	Utility method for formatting a duration in nano seconds into a human readable string.
static ManagementOperation.Status	fromCompositeData(CompositeData status)	Utility method for converting a CompositeData encoding of a status to a Status instance.
RepositoryManagementMBean.StatusCode	getCode()
int	getId()
String	getMessage()
String	getName()
int	hashCode()
static ManagementOperation.Status	initiated(String message)
static ManagementOperation.Status	initiated(ManagementOperation<?> op, String message)
boolean	isFailure()
boolean	isSuccess()
static ManagementOperation.Status	none(String message)
static ManagementOperation.Status	none(ManagementOperation<?> op, String message)
static ManagementOperation.Status	running(String message)
static ManagementOperation.Status	running(ManagementOperation<?> op, String message)
static ManagementOperation.Status	succeeded(String message)
static ManagementOperation.Status	succeeded(ManagementOperation<?> op, String message)
CompositeData	toCompositeData()	Utility method for converting this instance to a CompositeData encoding of the respective status.
String	toString()
static TabularData	toTabularData(Iterable<ManagementOperation.Status> statuses)
static ManagementOperation.Status	unavailable(String message)
static ManagementOperation.Status	unavailable(ManagementOperation<?> op, String message)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ITEM_CODE

public static final String ITEM_CODE

See Also:

Constant Field Values

ITEM_ID

public static final String ITEM_ID

See Also:

Constant Field Values

ITEM_MESSAGE

public static final String ITEM_MESSAGE

See Also:

Constant Field Values

ITEM_NAMES

public static final String[] ITEM_NAMES

ITEM_TYPES

public static final CompositeType ITEM_TYPES

Method Detail

unavailable

public static ManagementOperation.Status unavailable(String message)

none

public static ManagementOperation.Status none(String message)

initiated

public static ManagementOperation.Status initiated(String message)

running

public static ManagementOperation.Status running(String message)

succeeded

public static ManagementOperation.Status succeeded(String message)

failed

public static ManagementOperation.Status failed(String message)

unavailable

public static ManagementOperation.Status unavailable(ManagementOperation<?> op,
                                                     String message)

none

public static ManagementOperation.Status none(ManagementOperation<?> op,
                                              String message)

initiated

public static ManagementOperation.Status initiated(ManagementOperation<?> op,
                                                   String message)

running

public static ManagementOperation.Status running(ManagementOperation<?> op,
                                                 String message)

succeeded

public static ManagementOperation.Status succeeded(ManagementOperation<?> op,
                                                   String message)

failed

public static ManagementOperation.Status failed(ManagementOperation<?> op,
                                                String message)

formatTime

public static String formatTime(long nanos)

Utility method for formatting a duration in nano seconds into a human readable string.

Parameters:

nanos - number of nano seconds

Returns:

human readable string

fromCompositeData

public static ManagementOperation.Status fromCompositeData(CompositeData status)

Utility method for converting a CompositeData encoding of a status to a Status instance.

Parameters:

status - CompositeData encoding of a status

Returns:

Status for status

Throws:

IllegalArgumentException - if status is not a valid encoding of a Status.

toCompositeData

public CompositeData toCompositeData()

Utility method for converting this instance to a CompositeData encoding of the respective status.

Returns:

CompositeData of this Status

toTabularData

public static TabularData toTabularData(Iterable<ManagementOperation.Status> statuses)

getCode

public RepositoryManagementMBean.StatusCode getCode()

getId

public int getId()

getName

public String getName()

getMessage

public String getMessage()

isSuccess

public boolean isSuccess()

isFailure

public boolean isFailure()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object