org.apache.hadoop.hbase.monitoring
Interface MonitoredTask

All Superinterfaces:

Cloneable

All Known Subinterfaces:

MonitoredRPCHandler

All Known Implementing Classes:

MonitoredRPCHandlerImpl

@InterfaceAudience.Private
public interface MonitoredTask
extends Cloneable

Nested Class Summary

static class

MonitoredTask.State

Method Summary

void	abort(String msg)
void	cleanup() Explicitly mark this status as able to be cleaned up, even though it might not be complete.
MonitoredTask	clone() Public exposure of Object.clone() in order to allow clients to easily capture current state.
void	expireNow()
long	getCompletionTimestamp()
String	getDescription()
long	getStartTime()
MonitoredTask.State	getState()
long	getStateTime()
String	getStatus()
long	getStatusTime()
void	markComplete(String msg)
void	pause(String msg)
void	resume(String msg)
void	setDescription(String description)
void	setStatus(String status)
String	toJSON() Creates a JSON object for parseable exposure of monitored tasks.
Map<String,Object>	toMap() Creates a string map of internal details for extensible exposure of monitored tasks.

Method Detail

getStartTime

long getStartTime()

getDescription

String getDescription()

getStatus

String getStatus()

getStatusTime

long getStatusTime()

getState

MonitoredTask.State getState()

getStateTime

long getStateTime()

getCompletionTimestamp

long getCompletionTimestamp()

markComplete

void markComplete(String msg)

pause

void pause(String msg)

resume

void resume(String msg)

abort

void abort(String msg)

expireNow

void expireNow()

setStatus

void setStatus(String status)

setDescription

void setDescription(String description)

cleanup

void cleanup()

Explicitly mark this status as able to be cleaned up, even though it might not be complete.

clone

MonitoredTask clone()

Public exposure of Object.clone() in order to allow clients to easily capture current state.

Returns:

a copy of the object whose references will not change

toMap

Map<String,Object> toMap()
                         throws IOException

Creates a string map of internal details for extensible exposure of monitored tasks.

Returns:

A Map containing information for this task.

Throws:

IOException

toJSON

String toJSON()
              throws IOException

Creates a JSON object for parseable exposure of monitored tasks.

Returns:

An encoded JSON object containing information for this task.

Throws:

IOException