alluxio.master.meta

Class AlluxioMasterRestServiceHandler

java.lang.Object

alluxio.master.meta.AlluxioMasterRestServiceHandler

@NotThreadSafe
 @Path(value="master")
 @Produces(value="application/json")
public final class AlluxioMasterRestServiceHandler
extends Object

This class is a REST handler for requesting general master information.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GET_INFO
static String	LOG_ARGUMENT_LEVEL
static String	LOG_ARGUMENT_NAME
static String	LOG_LEVEL
static String	QUERY_RAW_CONFIGURATION
static String	SERVICE_PREFIX
static String	WEBUI_BROWSE
static String	WEBUI_CONFIG
static String	WEBUI_DATA
static String	WEBUI_INIT
static String	WEBUI_LOGS
static String	WEBUI_METRICS
static String	WEBUI_OVERVIEW
static String	WEBUI_WORKERS

Constructor Summary

Constructors

Constructor and Description
AlluxioMasterRestServiceHandler(javax.servlet.ServletContext context) Constructs a new AlluxioMasterRestServiceHandler.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getInfo(Boolean rawConfiguration)
javax.ws.rs.core.Response	getWebUIBrowse(String requestPath, String requestOffset, String requestEnd, String requestLimit) Gets Web UI browse page data.
javax.ws.rs.core.Response	getWebUIConfiguration() Gets Web UI ServerConfiguration page data.
javax.ws.rs.core.Response	getWebUIData(String requestOffset, String requestLimit) Gets Web UI data page data.
javax.ws.rs.core.Response	getWebUIInit() Gets Web UI initialization data.
javax.ws.rs.core.Response	getWebUILogs(String requestPath, String requestOffset, String requestEnd, String requestLimit) Gets Web UI logs page data.
javax.ws.rs.core.Response	getWebUIMetrics() Gets Web UI metrics page data.
javax.ws.rs.core.Response	getWebUIOverview() Gets Web UI overview page data.
javax.ws.rs.core.Response	getWebUIWorkers() Gets Web UI workers page data.
javax.ws.rs.core.Response	logLevel(String logName, String level)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PREFIX

public static final String SERVICE_PREFIX

See Also:

Constant Field Values

GET_INFO

public static final String GET_INFO

See Also:

Constant Field Values

WEBUI_INIT

public static final String WEBUI_INIT

See Also:

Constant Field Values

WEBUI_OVERVIEW

public static final String WEBUI_OVERVIEW

See Also:

Constant Field Values

WEBUI_BROWSE

public static final String WEBUI_BROWSE

See Also:

Constant Field Values

WEBUI_DATA

public static final String WEBUI_DATA

See Also:

Constant Field Values

WEBUI_LOGS

public static final String WEBUI_LOGS

See Also:

Constant Field Values

WEBUI_CONFIG

public static final String WEBUI_CONFIG

See Also:

Constant Field Values

WEBUI_WORKERS

public static final String WEBUI_WORKERS

See Also:

Constant Field Values

WEBUI_METRICS

public static final String WEBUI_METRICS

See Also:

Constant Field Values

QUERY_RAW_CONFIGURATION

public static final String QUERY_RAW_CONFIGURATION

See Also:

Constant Field Values

LOG_LEVEL

public static final String LOG_LEVEL

See Also:

Constant Field Values

LOG_ARGUMENT_NAME

public static final String LOG_ARGUMENT_NAME

See Also:

Constant Field Values

LOG_ARGUMENT_LEVEL

public static final String LOG_ARGUMENT_LEVEL

See Also:

Constant Field Values

Constructor Detail

AlluxioMasterRestServiceHandler

public AlluxioMasterRestServiceHandler(@Context
                                       javax.servlet.ServletContext context)

Constructs a new AlluxioMasterRestServiceHandler.

Parameters:

context - context for the servlet

Method Detail

getInfo

@GET
 @Path(value="info")
public javax.ws.rs.core.Response getInfo(@QueryParam(value="raw_configuration")
                                                                   Boolean rawConfiguration)

Parameters:

rawConfiguration - if it's true, raw configuration values are returned, otherwise, they are looked up; if it's not provided in URL queries, then it is null, which means false.

Returns:

the response object

getWebUIInit

@GET
 @Path(value="webui_init")
public javax.ws.rs.core.Response getWebUIInit()

Gets Web UI initialization data.

Returns:

the response object

getWebUIOverview

@GET
 @Path(value="webui_overview")
public javax.ws.rs.core.Response getWebUIOverview()

Gets Web UI overview page data.

Returns:

the response object

getWebUIBrowse

@GET
 @Path(value="webui_browse")
public javax.ws.rs.core.Response getWebUIBrowse(@DefaultValue(value="/") @QueryParam(value="path")
                                                                                  String requestPath,
                                                                                  @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                  String requestOffset,
                                                                                  @DefaultValue(value="") @QueryParam(value="end")
                                                                                  String requestEnd,
                                                                                  @DefaultValue(value="20") @QueryParam(value="limit")
                                                                                  String requestLimit)

Gets Web UI browse page data.

Parameters:

requestPath - the request path

requestOffset - the request offset

requestEnd - the request end

requestLimit - the request limit

Returns:

the response object

getWebUIData

@GET
 @Path(value="webui_data")
public javax.ws.rs.core.Response getWebUIData(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                              String requestOffset,
                                                                              @DefaultValue(value="20") @QueryParam(value="limit")
                                                                              String requestLimit)

Gets Web UI data page data.

Parameters:

requestOffset - the request offset

requestLimit - the request limit

Returns:

the response object

getWebUILogs

@GET
 @Path(value="webui_logs")
public javax.ws.rs.core.Response getWebUILogs(@DefaultValue(value="") @QueryParam(value="path")
                                                                              String requestPath,
                                                                              @DefaultValue(value="0") @QueryParam(value="offset")
                                                                              String requestOffset,
                                                                              @DefaultValue(value="") @QueryParam(value="end")
                                                                              String requestEnd,
                                                                              @DefaultValue(value="20") @QueryParam(value="limit")
                                                                              String requestLimit)

Gets Web UI logs page data.

Parameters:

requestPath - the request path

requestOffset - the request offset

requestEnd - the request end

requestLimit - the request limit

Returns:

the response object

getWebUIConfiguration

@GET
 @Path(value="webui_config")
public javax.ws.rs.core.Response getWebUIConfiguration()

Gets Web UI ServerConfiguration page data.

Returns:

the response object

getWebUIWorkers

@GET
 @Path(value="webui_workers")
public javax.ws.rs.core.Response getWebUIWorkers()

Gets Web UI workers page data.

Returns:

the response object

getWebUIMetrics

@GET
 @Path(value="webui_metrics")
public javax.ws.rs.core.Response getWebUIMetrics()

Gets Web UI metrics page data.

Returns:

the response object

logLevel

@POST
 @Path(value="logLevel")
public javax.ws.rs.core.Response logLevel(@QueryParam(value="logName")
                                                                         String logName,
                                                                         @QueryParam(value="level")
                                                                         String level)

Parameters:

logName - the log's name

level - the log level

Returns:

the response object