org.wso2.carbon.dashboards.api.internal

Class DashboardRestApi

java.lang.Object

org.wso2.carbon.dashboards.api.internal.DashboardRestApi

All Implemented Interfaces:

org.wso2.msf4j.Microservice

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

REST API for dashboard 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
DashboardRestApi(org.wso2.carbon.dashboards.core.DashboardMetadataProvider dashboardDataProvider) Creates a new dashboard REST API.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(org.wso2.msf4j.Request request, org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata) Creates a new dashboard.
javax.ws.rs.core.Response	delete(String id, org.wso2.msf4j.Request request) Deletes the dashboard corresponding to the supplied ID.
javax.ws.rs.core.Response	get(org.wso2.msf4j.Request request) Returns a list of available dashboards.
javax.ws.rs.core.Response	get(String id, org.wso2.msf4j.Request request) Returns the dashboard for the given ID.
javax.ws.rs.core.Response	getDashboardRoles(String url)
javax.ws.rs.core.Response	getRoles()
javax.ws.rs.core.Response	getRolesByUsername(String username)
javax.ws.rs.core.Response	update(String id, org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata, org.wso2.msf4j.Request request) Updates the dashboard corresponding to the supplied ID with the supplied data.
javax.ws.rs.core.Response	updateDashboardRoles(String url, org.wso2.msf4j.Request request, Map<String,List<String>> roles)

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

DashboardRestApi

public DashboardRestApi(org.wso2.carbon.dashboards.core.DashboardMetadataProvider dashboardDataProvider)

Creates a new dashboard REST API.

Parameters:

dashboardDataProvider - metadata provider for dhashboards

Method Detail

get

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/")
public javax.ws.rs.core.Response get(@Context
                                                                                                                                      org.wso2.msf4j.Request request)

Returns a list of available dashboards.

Returns:

response that carries list of available dashboards

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,
                                                                                                                                          @Context
                                                                                                                                          org.wso2.msf4j.Request request)

Returns the dashboard for the given ID.

Parameters:

id - dashboard ID

Returns:

response that carries dashboard data

create

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/")
public javax.ws.rs.core.Response create(@Context
                                                                                                                                          org.wso2.msf4j.Request request,
                                                                                                                                          org.wso2.carbon.dashboards.core.bean.DashboardMetadata dashboardMetadata)

Creates a new dashboard.

Parameters:

dashboardMetadata - data for the creating dashboard

Returns:

response

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,
                                                                                                                                             @Context
                                                                                                                                             org.wso2.msf4j.Request request)

Updates the dashboard corresponding to the supplied ID with the supplied data.

Parameters:

id - ID of the dashboard to update

dashboardMetadata - updating data

Returns:

response

delete

@DELETE
 @Path(value="/{id}")
public javax.ws.rs.core.Response delete(@PathParam(value="id")
                                                                      String id,
                                                                      @Context
                                                                      org.wso2.msf4j.Request request)

Deletes the dashboard corresponding to the supplied ID.

Parameters:

id - ID of the dashboard to delete

Returns:

response

getRoles

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

getRolesByUsername

@GET
 @Path(value="/roles/{username}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getRolesByUsername(@PathParam(value="username")
                                                                                                                                String username)

getDashboardRoles

@GET
 @Path(value="/{url}/roles")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getDashboardRoles(@PathParam(value="url")
                                                                                                                          String url)

updateDashboardRoles

@POST
 @Path(value="/{url}/roles")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateDashboardRoles(@PathParam(value="url")
                                                                                                                              String url,
                                                                                                                              @Context
                                                                                                                              org.wso2.msf4j.Request request,
                                                                                                                              Map<String,List<String>> roles)