org.graylog2.rest.resources.dashboards

Class DashboardsResource

java.lang.Object

org.graylog2.rest.resources.RestResource

org.graylog2.rest.resources.dashboards.DashboardsResource

@Path(value="/dashboards")
public class DashboardsResource
extends RestResource

Author:

Lennart Koopmann

Field Summary

Fields inherited from class org.graylog2.rest.resources.RestResource

objectMapper, serverStatus, userService

Constructor Summary

Constructors

Constructor and Description
DashboardsResource(DashboardService dashboardService, DashboardRegistry dashboardRegistry, ActivityWriter activityWriter, com.codahale.metrics.MetricRegistry metricRegistry, Searches searches)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addWidget(java.lang.String body, java.lang.String dashboardId)
javax.ws.rs.core.Response	create(java.lang.String body)
javax.ws.rs.core.Response	delete(java.lang.String dashboardId)
java.lang.String	get(java.lang.String dashboardId)
java.lang.String	list()
javax.ws.rs.core.Response	remove(java.lang.String dashboardId, java.lang.String widgetId)
javax.ws.rs.core.Response	setPositions(java.lang.String body, java.lang.String dashboardId)
javax.ws.rs.core.Response	update(java.lang.String body, java.lang.String dashboardId)
javax.ws.rs.core.Response	updateCacheTime(java.lang.String body, java.lang.String dashboardId, java.lang.String widgetId)
javax.ws.rs.core.Response	updateDescription(java.lang.String body, java.lang.String dashboardId, java.lang.String widgetId)
javax.ws.rs.core.Response	widgetValue(java.lang.String dashboardId, java.lang.String widgetId)

Methods inherited from class org.graylog2.rest.resources.RestResource

bytesToValueMap, checkPermission, checkPermission, getCurrentUser, getSubject, guessContentType, isPermitted, isPermitted, json, loadObjectId, page, restrictToMaster, setPrettyPrint

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardsResource

@Inject
public DashboardsResource(DashboardService dashboardService,
                                  DashboardRegistry dashboardRegistry,
                                  ActivityWriter activityWriter,
                                  com.codahale.metrics.MetricRegistry metricRegistry,
                                  Searches searches)

Method Detail

create

@POST
 @Timed
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response create(java.lang.String body)

list

@GET
 @Timed
 @Produces(value="application/json")
public java.lang.String list()

get

@GET
 @Timed
 @Path(value="/{dashboardId}")
 @Produces(value="application/json")
public java.lang.String get(@PathParam(value="dashboardId")
                                                                                                             java.lang.String dashboardId)

delete

@DELETE
 @Timed
 @Produces(value="application/json")
 @Path(value="/{dashboardId}")
public javax.ws.rs.core.Response delete(@PathParam(value="dashboardId")
                                                                                                                            java.lang.String dashboardId)

update

@PUT
 @Timed
 @Produces(value="application/json")
 @Path(value="/{dashboardId}")
public javax.ws.rs.core.Response update(java.lang.String body,
                                                                                                                         @PathParam(value="dashboardId")
                                                                                                                         java.lang.String dashboardId)

setPositions

@PUT
 @Timed
 @Produces(value="application/json")
 @Path(value="/{dashboardId}/positions")
public javax.ws.rs.core.Response setPositions(java.lang.String body,
                                                                                                                                         @PathParam(value="dashboardId")
                                                                                                                                         java.lang.String dashboardId)

addWidget

@POST
 @Timed
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{dashboardId}/widgets")
public javax.ws.rs.core.Response addWidget(java.lang.String body,
                                                                                                                                                                          @PathParam(value="dashboardId")
                                                                                                                                                                          java.lang.String dashboardId)

remove

@DELETE
 @Timed
 @Path(value="/{dashboardId}/widgets/{widgetId}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response remove(@PathParam(value="dashboardId")
                                                                                                                                               java.lang.String dashboardId,
                                                                                                                                               @PathParam(value="widgetId")
                                                                                                                                               java.lang.String widgetId)

widgetValue

@GET
 @Timed
 @Path(value="/{dashboardId}/widgets/{widgetId}/value")
 @Produces(value="application/json")
public javax.ws.rs.core.Response widgetValue(@PathParam(value="dashboardId")
                                                                                                                                                       java.lang.String dashboardId,
                                                                                                                                                       @PathParam(value="widgetId")
                                                                                                                                                       java.lang.String widgetId)

updateDescription

@PUT
 @Timed
 @Path(value="/{dashboardId}/widgets/{widgetId}/description")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateDescription(java.lang.String body,
                                                                                                                                                                   @PathParam(value="dashboardId")
                                                                                                                                                                   java.lang.String dashboardId,
                                                                                                                                                                   @PathParam(value="widgetId")
                                                                                                                                                                   java.lang.String widgetId)

updateCacheTime

@PUT
 @Timed
 @Path(value="/{dashboardId}/widgets/{widgetId}/cachetime")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateCacheTime(java.lang.String body,
                                                                                                                                                               @PathParam(value="dashboardId")
                                                                                                                                                               java.lang.String dashboardId,
                                                                                                                                                               @PathParam(value="widgetId")
                                                                                                                                                               java.lang.String widgetId)