org.apache.hadoop.chukwa.hicc.rest

Class ChartController

java.lang.Object

org.apache.hadoop.chukwa.hicc.rest.ChartController

Direct Known Subclasses:

PieChartController, TileController

public class ChartController
extends Object

Constructor Summary

Constructors

Constructor and Description
ChartController()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(String buffer) Create a new chart meta data
String	describe(String id) Describe chart meta data
String	draw(String id) Render chart using flot.js
String	preview(String buffer) Display a chart base on chart configuration from REST API input
String	previewSeries(javax.servlet.http.HttpServletRequest request, String buffer) Display metrics series in JSON
javax.ws.rs.core.Response	save(String id, String buffer) Save chart meta data

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartController

public ChartController()

Method Detail

draw

public String draw(String id)

Render chart using flot.js

Parameters:

id - Reference ID of Chart stored in HBase chukwa_meta table.

Returns:

chart widget

describe

public String describe(String id)

Describe chart meta data

Parameters:

id - Chart ID

Returns:

chart meta data

response.representation.200.doc

Display chart configuration options

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.CPU_UTILIZATION

create

public javax.ws.rs.core.Response create(String buffer)

Create a new chart meta data

Parameters:

buffer - holds incoming JSON of Chart object

Returns:

Web response code

request.representation.example

Examples.MEMORY_UTILIZATION

save

public javax.ws.rs.core.Response save(String id,
                                      String buffer)

Save chart meta data

Parameters:

id - is unique identifier of Chart object

buffer - holds incoming JSON of Chart object

Returns:

Web response code

request.representation.example

Examples.DISK_UTILIZATION

preview

public String preview(String buffer)

Display a chart base on chart configuration from REST API input

Parameters:

buffer - holds incoming JSON of Chart object

Returns:

segment of chart HTML output

request.representation.example

Examples.NETWORK_UTILIZATION

previewSeries

public String previewSeries(@Context
                            javax.servlet.http.HttpServletRequest request,
                            String buffer)

Display metrics series in JSON

Parameters:

request - HTTP request object

buffer - list of SeriesMetaData

Returns:

metrics JSON

response.representation.200.doc

Display series data in JSON

response.representation.200.mediaType

application/json

request.representation.example

Examples.CPU_SERIES_METADATA