org.apache.hadoop.chukwa.hicc.rest

Class DashboardController

java.lang.Object

org.apache.hadoop.chukwa.hicc.rest.DashboardController

public class DashboardController
extends Object

Constructor Summary

Constructors

Constructor and Description
DashboardController()

Method Summary

Modifier and Type	Method and Description
String	load(javax.servlet.http.HttpServletRequest request, String id) Load a dashboard view
String	quicklinks() Render Quick links to various services web portals
javax.ws.rs.core.Response	save(javax.servlet.http.HttpServletRequest request, String id, String buffer) Save a dashboard view
String	whoami(javax.servlet.http.HttpServletRequest request) Return HTTP request connection user name

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardController

public DashboardController()

Method Detail

load

public String load(@Context
                   javax.servlet.http.HttpServletRequest request,
                   String id)

Load a dashboard view

Parameters:

request - HTTP request object

id - is dashboard unique identifier

Returns:

Dashboard view in JSON structure

response.representation.200.doc

Display dashboard JSON structure

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.SYSTEM_DASHBOARD

save

public javax.ws.rs.core.Response save(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      String id,
                                      String buffer)

Save a dashboard view

Parameters:

request - HTTP request object

id - is dashboard unique identifier

buffer - is JSON structure of dashboard view

Returns:

Status of the dashboard save

response.representation.200.doc

Display save status code

response.representation.200.mediaType

text/plain

request.representation.example

Examples.USER_DASHBOARD

whoami

public String whoami(@Context
                     javax.servlet.http.HttpServletRequest request)

Return HTTP request connection user name

Parameters:

request - HTTP request object

Returns:

username

response.representation.200.doc

Username

response.representation.200.mediaType

text/plain

response.representation.200.example

admin

quicklinks

public String quicklinks()

Render Quick links to various services web portals

Returns:

HTML page of quick links

response.representation.200.doc

Display quick link widget

response.representation.200.mediaType

text/html

response.representation.200.example

Example is availabe on HICC UI