org.wso2.carbon.dashboards.api

Class DashboardMetadataAPI

java.lang.Object

org.wso2.carbon.dashboards.api.DashboardMetadataAPI

All Implemented Interfaces:

org.wso2.msf4j.Microservice

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

This is the API implementation for the meta data backend service.

Constructor Summary

Constructors

Constructor and Description
DashboardMetadataAPI()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.framework.BundleContext bundleContext)
javax.ws.rs.core.Response	create(org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata) Create a new dashboard
protected void	deactivate(org.osgi.framework.BundleContext bundleContext)
javax.ws.rs.core.Response	delete(String id) Delete a particular dashboard.
javax.ws.rs.core.Response	get(String id) Get a particular dashboard selected by the ID.
javax.ws.rs.core.Response	list() Get list of dashboards available.
javax.ws.rs.core.Response	update(String id, org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata) Update a particular dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardMetadataAPI

public DashboardMetadataAPI()

Method Detail

activate

protected void activate(org.osgi.framework.BundleContext bundleContext)

deactivate

protected void deactivate(org.osgi.framework.BundleContext bundleContext)

list

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/")
public javax.ws.rs.core.Response list()
                                                                                                                                throws org.wso2.carbon.dashboards.core.exception.DashboardException

Get list of dashboards available.

Returns:

List of dashboards

Throws:

org.wso2.carbon.dashboards.core.exception.DashboardException

get

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{id}")
public javax.ws.rs.core.Response get(@PathParam(value="id")
                                                                                                                                          String id)
                                                                                                                                   throws org.wso2.carbon.dashboards.core.exception.DashboardException

Get a particular dashboard selected by the ID.

Parameters:

id - Dashboard ID

Returns:

Dashboard metadata

Throws:

org.wso2.carbon.dashboards.core.exception.DashboardException

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.DashboardMetadata dashboardMetadata)
                                                                                                                                   throws org.wso2.carbon.dashboards.core.exception.DashboardException

Create a new dashboard

Parameters:

dashboardMetadata - Dashboard metadata

Returns:

Status

Throws:

org.wso2.carbon.dashboards.core.exception.DashboardException

update

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{id}")
public javax.ws.rs.core.Response update(@PathParam(value="id")
                                                                                                                                             String id,
                                                                                                                                             org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata)
                                                                                                                                      throws org.wso2.carbon.dashboards.core.exception.DashboardException

Update a particular dashboard.

Parameters:

id - Dashboard ID

dashboardMetadata - Dashboard metadata

Returns:

Status

Throws:

org.wso2.carbon.dashboards.core.exception.DashboardException

delete

@DELETE
 @Path(value="/{id}")
public javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                                      String id)
                                                               throws org.wso2.carbon.dashboards.core.exception.DashboardException

Delete a particular dashboard.

Parameters:

id - Dashboard ID

Returns:

Status

Throws:

org.wso2.carbon.dashboards.core.exception.DashboardException