org.wso2.carbon.dashboards.api.internal

Class WidgetRestApi

java.lang.Object

org.wso2.carbon.dashboards.api.internal.WidgetRestApi

All Implemented Interfaces:

org.wso2.msf4j.Microservice

public class WidgetRestApi
extends Object
implements org.wso2.msf4j.Microservice

REST API for widget related operations.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_CONTEXT_PATH

Constructor Summary

Constructors

Constructor and Description
WidgetRestApi(org.wso2.carbon.dashboards.core.WidgetMetadataProvider widgetMetadataProvider) Creates a new widget REST API.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(org.wso2.carbon.dashboards.core.bean.widget.GeneratedWidgetConfigs generatedWidgetConfigs) Create a generated widget.
javax.ws.rs.core.Response	deleteWidget(String widgetId) Deletes the widget corresponding to the provided ID.
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() Returns a list of widget configurations.
javax.ws.rs.core.Response	validateWidgetName(String widgetName) Validate widget name.

Methods inherited from class java.lang.Object

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

Field Detail

API_CONTEXT_PATH

public static final String API_CONTEXT_PATH

See Also:

Constant Field Values

Constructor Detail

WidgetRestApi

public WidgetRestApi(org.wso2.carbon.dashboards.core.WidgetMetadataProvider widgetMetadataProvider)

Creates a new widget REST API.

Parameters:

widgetMetadataProvider - metadata provider for widgets

Method Detail

getWidgetsMetaInfo

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

Returns a list of widget configurations.

Returns:

response that carries list of widget configurations

getWidgetConf

@GET
 @Path(value="/{id}")
 @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

validateWidgetName

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="{widgetName}/validate")
public javax.ws.rs.core.Response validateWidgetName(@PathParam(value="widgetName")
                                                                                                                                                                          String widgetName)

Validate widget name.

Parameters:

widgetName - data for the validate widget name.

Returns:

response

deleteWidget

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

Deletes the widget corresponding to the provided ID.

Parameters:

widgetId - ID of the dashboard to delete

Returns:

response

create

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/")
public javax.ws.rs.core.Response create(org.wso2.carbon.dashboards.core.bean.widget.GeneratedWidgetConfigs generatedWidgetConfigs)

Create a generated widget.

Parameters:

generatedWidgetConfigs - data for the creating widget.

Returns:

response