org.graylog2.rest.resources.dashboards

Class DashboardsResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.dashboards.DashboardsResource

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

Field Summary

Fields inherited from class org.graylog2.shared.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

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addWidget(String dashboardId, AddWidgetRequest awr)
javax.ws.rs.core.Response	create(CreateDashboardRequest cr)
void	delete(String dashboardId)
Map<String,Object>	get(String dashboardId)
DashboardList	list()
void	remove(String dashboardId, String widgetId)
void	setPositions(String dashboardId, WidgetPositions uwpr)
void	update(String dashboardId, UpdateDashboardRequest cr)
void	updateCacheTime(String dashboardId, String widgetId, UpdateWidgetRequest uwr)
void	updateDescription(String dashboardId, String widgetId, UpdateWidgetRequest uwr)
Map<String,Object>	widgetValue(String dashboardId, String widgetId)

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

bytesToValueMap, checkPermission, checkPermission, getCurrentUser, getSubject, guessContentType, isPermitted, isPermitted, 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(CreateDashboardRequest cr)
                                 throws ValidationException

Throws:

ValidationException

list

@GET
@Timed
@Produces(value="application/json")
public DashboardList list()

get

@GET
@Timed
@Path(value="/{dashboardId}")
@Produces(value="application/json")
public Map<String,Object> get(@PathParam(value="dashboardId")
                                             String dashboardId)
                       throws NotFoundException

Throws:

NotFoundException

delete

@DELETE
@Timed
@Produces(value="application/json")
@Path(value="/{dashboardId}")
public void delete(@PathParam(value="dashboardId")
                                     String dashboardId)
            throws NotFoundException

Throws:

NotFoundException

update

@PUT
@Timed
@Produces(value="application/json")
@Path(value="/{dashboardId}")
public void update(@PathParam(value="dashboardId")
                                  String dashboardId,
                                  UpdateDashboardRequest cr)
            throws ValidationException,
                   NotFoundException

Throws:

ValidationException

NotFoundException

setPositions

@PUT
@Timed
@Produces(value="application/json")
@Path(value="/{dashboardId}/positions")
public void setPositions(@PathParam(value="dashboardId")
                                        String dashboardId,
                                        WidgetPositions uwpr)
                  throws NotFoundException,
                         ValidationException

Throws:

NotFoundException

ValidationException

addWidget

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

Throws:

ValidationException

remove

@DELETE
@Timed
@Path(value="/{dashboardId}/widgets/{widgetId}")
@Produces(value="application/json")
public void remove(@PathParam(value="dashboardId")
                                     String dashboardId,
                                     @PathParam(value="widgetId")
                                     String widgetId)

widgetValue

@GET
@Timed
@Path(value="/{dashboardId}/widgets/{widgetId}/value")
@Produces(value="application/json")
public Map<String,Object> widgetValue(@PathParam(value="dashboardId")
                                                     String dashboardId,
                                                     @PathParam(value="widgetId")
                                                     String widgetId)

updateDescription

@PUT
@Timed
@Path(value="/{dashboardId}/widgets/{widgetId}/description")
@Produces(value="application/json")
public void updateDescription(@PathParam(value="dashboardId")
                                             String dashboardId,
                                             @PathParam(value="widgetId")
                                             String widgetId,
                                             UpdateWidgetRequest uwr)
                       throws ValidationException

Throws:

ValidationException

updateCacheTime

@PUT
@Timed
@Path(value="/{dashboardId}/widgets/{widgetId}/cachetime")
@Produces(value="application/json")
public void updateCacheTime(@PathParam(value="dashboardId")
                                           String dashboardId,
                                           @PathParam(value="widgetId")
                                           String widgetId,
                                           UpdateWidgetRequest uwr)
                     throws ValidationException

Throws:

ValidationException