alluxio.worker

Class AlluxioWorkerRestServiceHandler

java.lang.Object

alluxio.worker.AlluxioWorkerRestServiceHandler

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	GET_CAPACITY_BYTES
static String	GET_CAPACITY_BYTES_ON_TIERS
static String	GET_CONFIGURATION
static String	GET_DIRECTORY_PATHS_ON_TIERS
static String	GET_INFO
static String	GET_METRICS
static String	GET_RPC_ADDRESS
static String	GET_START_TIME_MS
static String	GET_UPTIME_MS
static String	GET_USED_BYTES
static String	GET_USED_BYTES_ON_TIERS
static String	GET_VERSION
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_BLOCKINFO
static String	WEBUI_INIT
static String	WEBUI_LOGS
static String	WEBUI_METRICS
static String	WEBUI_OVERVIEW

Constructor Summary

Constructors

Constructor and Description
AlluxioWorkerRestServiceHandler(javax.servlet.ServletContext context)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getCapacityBytes() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getCapacityBytesOnTiers() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getConfiguration() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getDirectoryPathsOnTiers() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getInfo(Boolean rawConfiguration)
javax.ws.rs.core.Response	getMetrics() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getRpcAddress() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getStartTimeMs() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getUptimeMs() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getUsedBytes() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getUsedBytesOnTiers() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getVersion() Deprecated. since version 1.4 and will be removed in version 2.0
javax.ws.rs.core.Response	getWebUIBlockInfo(String requestPath, String requestOffset, String requestLimit) Gets web ui block info 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	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_LOGS

public static final String WEBUI_LOGS

See Also:

Constant Field Values

WEBUI_BLOCKINFO

public static final String WEBUI_BLOCKINFO

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

GET_RPC_ADDRESS

public static final String GET_RPC_ADDRESS

See Also:

Constant Field Values

GET_CAPACITY_BYTES

public static final String GET_CAPACITY_BYTES

See Also:

Constant Field Values

GET_CONFIGURATION

public static final String GET_CONFIGURATION

See Also:

Constant Field Values

GET_USED_BYTES

public static final String GET_USED_BYTES

See Also:

Constant Field Values

GET_CAPACITY_BYTES_ON_TIERS

public static final String GET_CAPACITY_BYTES_ON_TIERS

See Also:

Constant Field Values

GET_USED_BYTES_ON_TIERS

public static final String GET_USED_BYTES_ON_TIERS

See Also:

Constant Field Values

GET_DIRECTORY_PATHS_ON_TIERS

public static final String GET_DIRECTORY_PATHS_ON_TIERS

See Also:

Constant Field Values

GET_START_TIME_MS

public static final String GET_START_TIME_MS

See Also:

Constant Field Values

GET_UPTIME_MS

public static final String GET_UPTIME_MS

See Also:

Constant Field Values

GET_VERSION

public static final String GET_VERSION

See Also:

Constant Field Values

GET_METRICS

public static final String GET_METRICS

See Also:

Constant Field Values

Constructor Detail

AlluxioWorkerRestServiceHandler

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

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

getWebUIBlockInfo

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

Gets web ui block info page data.

Parameters:

requestPath - the request path

requestOffset - the request offset

requestLimit - the request limit

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

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,
                                                                              @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

getConfiguration

@GET
 @Path(value="configuration")
 @Deprecated
public javax.ws.rs.core.Response getConfiguration()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getRpcAddress

@GET
 @Path(value="rpc_address")
 @Deprecated
public javax.ws.rs.core.Response getRpcAddress()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getCapacityBytes

@GET
 @Path(value="capacity_bytes")
 @Deprecated
public javax.ws.rs.core.Response getCapacityBytes()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getUsedBytes

@GET
 @Path(value="used_bytes")
 @Deprecated
public javax.ws.rs.core.Response getUsedBytes()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getCapacityBytesOnTiers

@GET
 @Path(value="capacity_bytes_on_tiers")
 @Deprecated
public javax.ws.rs.core.Response getCapacityBytesOnTiers()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getUsedBytesOnTiers

@GET
 @Path(value="used_bytes_on_tiers")
 @Deprecated
public javax.ws.rs.core.Response getUsedBytesOnTiers()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getDirectoryPathsOnTiers

@GET
 @Path(value="directory_paths_on_tiers")
 @Deprecated
public javax.ws.rs.core.Response getDirectoryPathsOnTiers()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getVersion

@GET
 @Path(value="version")
 @Deprecated
public javax.ws.rs.core.Response getVersion()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getStartTimeMs

@GET
 @Path(value="start_time_ms")
 @Deprecated
public javax.ws.rs.core.Response getStartTimeMs()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getUptimeMs

@GET
 @Path(value="uptime_ms")
 @Deprecated
public javax.ws.rs.core.Response getUptimeMs()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

getMetrics

@GET
 @Path(value="metrics")
 @Deprecated
public javax.ws.rs.core.Response getMetrics()

Deprecated. since version 1.4 and will be removed in version 2.0

Returns:

the response object

See Also:

getInfo(Boolean)

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