org.wso2.carbon.dashboards.api

Class WidgetInfoProviderAPI

java.lang.Object

org.wso2.carbon.dashboards.api.WidgetInfoProviderAPI

All Implemented Interfaces:

org.wso2.msf4j.Microservice

@Path(value="/apis/widgets")
public class WidgetInfoProviderAPI
extends Object
implements org.wso2.msf4j.Microservice

This is the back-end api to get the widget related information.

Constructor Summary

Constructors

Constructor and Description
WidgetInfoProviderAPI()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getThumbnail(String widgetId) This method provides thumbnail of given widget.
javax.ws.rs.core.Response	getWidgetConf(String widgetId) This method return the configuration of given widget.
javax.ws.rs.core.Response	getWidgetsMetaInfo() This method returns a list of meta information of widgets.

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetInfoProviderAPI

public WidgetInfoProviderAPI()

Method Detail

getWidgetsMetaInfo

@GET
 @Path(value="/")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWidgetsMetaInfo()

This method returns a list of meta information of widgets.

Returns:

List of widget related meta information

getWidgetConf

@GET
 @Path(value="/{id}/conf")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWidgetConf(@PathParam(value="id")
                                                                                                                    String widgetId)

This method return the configuration of given widget.

Parameters:

widgetId - widget id

Returns:

widget configuration

getThumbnail

@GET
 @Path(value="/{id}/thumbnail")
public javax.ws.rs.core.Response getThumbnail(@PathParam(value="id")
                                                                                   String widgetId)

This method provides thumbnail of given widget.

Parameters:

widgetId - widget id

Returns:

thumbnail of given widget