org.apache.hadoop.chukwa.hicc.rest

Class WidgetController

java.lang.Object

org.apache.hadoop.chukwa.hicc.rest.WidgetController

public class WidgetController
extends Object

Constructor Summary

Constructors

Constructor and Description
WidgetController()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createWidget(String buffer) Create a widget
javax.ws.rs.core.Response	deleteWidget(String title) Delete a widget
void	init()
String	listWidget(int limit, int offset) List widgets
String	searchWidget(String query) Search for widget base on widget title
javax.ws.rs.core.Response	updateWidget(String title, String buffer) Update a widget
String	viewWidget(String title) View widget details

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetController

public WidgetController()

Method Detail

init

@PostConstruct
 @Singleton
public void init()

listWidget

public String listWidget(int limit,
                         int offset)

List widgets

Parameters:

limit - is number of widgets to return

offset - is position in the widget list

Returns:

list of widgets in HBase database

response.representation.200.doc

Display list of HICC supported widgets

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.WIDGET_LIST

searchWidget

public String searchWidget(String query)

Search for widget base on widget title

Parameters:

query - is search critieria

Returns:

list of widgets matched search critieria

response.representation.200.doc

Display list of HICC widget that matches query

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.WIDGET_LIST

viewWidget

public String viewWidget(String title)

View widget details

Parameters:

title - is title of the widget

Returns:

widget configuration

response.representation.200.doc

View widget details

response.representation.200.mediaType

application/json

response.representation.200.example

Examples.SYSTEM_LOAD_AVERAGE_WIDGET

createWidget

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

Create a widget

Parameters:

buffer - is widget configuration

Returns:

Creation status code

response.representation.200.doc

Widget creation successful

response.representation.200.mediaType

text/plain

response.representation.200.example

200 OK

response.representation.400.doc

Widget creation unsuccessful

response.representation.400.mediaType

text/plain

response.representation.400.example

400 Bad Request

request.representation.example

Examples.WELCOME_PAGE_WIDGET

updateWidget

public javax.ws.rs.core.Response updateWidget(String title,
                                              String buffer)

Update a widget

Parameters:

title - is widget title

buffer - is widget object in JSON

Returns:

Update status code

response.representation.200.doc

Widget update is successful

response.representation.200.mediaType

text/plain

response.representation.200.example

200 OK

response.representation.400.doc

Widget update unsuccessful

response.representation.400.mediaType

text/plain

response.representation.400.example

400 Bad Request

request.representation.example

Examples.WELCOME_PAGE_WIDGET

deleteWidget

public javax.ws.rs.core.Response deleteWidget(String title)

Delete a widget

Parameters:

title - is widget title

Returns:

Widget delete status code

response.representation.200.doc

Widget deletion successful

response.representation.200.mediaType

text/plain

response.representation.200.example

200 OK

response.representation.400.doc

Widget deletion unsuccessful

response.representation.400.mediaType

text/plain

response.representation.400.example

400 Bad Request