org.graylog2.rest.resources.dashboards

Class DashboardWidgetsResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.dashboards.DashboardWidgetsResource

@Path(value="/dashboards/{dashboardId}/widgets")
public class DashboardWidgetsResource
extends RestResource

Field Summary

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

objectMapper, userService

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetsResource(DashboardWidgetCreator dashboardWidgetCreator, ActivityWriter activityWriter, WidgetResultCache widgetResultCache, DashboardService dashboardService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addWidget(String dashboardId, AddWidgetRequest awr)
WidgetSummary	getWidget(String dashboardId, String widgetId)
void	remove(String dashboardId, String widgetId)
void	updateCacheTime(String dashboardId, String widgetId, UpdateWidgetRequest uwr) Deprecated.
void	updateDescription(String dashboardId, String widgetId, UpdateWidgetRequest uwr) Deprecated.
void	updateWidget(String dashboardId, String widgetId, AddWidgetRequest awr)
Map<String,Object>	widgetValue(String dashboardId, String widgetId)

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

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardWidgetsResource

@Inject
public DashboardWidgetsResource(DashboardWidgetCreator dashboardWidgetCreator,
                                        ActivityWriter activityWriter,
                                        WidgetResultCache widgetResultCache,
                                        DashboardService dashboardService)

Method Detail

addWidget

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

Throws:

ValidationException

NotFoundException

getWidget

@GET
 @Timed
 @Path(value="/{widgetId}")
 @Produces(value="application/json")
public WidgetSummary getWidget(@PathParam(value="dashboardId")
                                                                                                             String dashboardId,
                                                                                                             @PathParam(value="widgetId")
                                                                                                             String widgetId)
                                                                                                      throws NotFoundException

Throws:

NotFoundException

remove

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

Throws:

NotFoundException

widgetValue

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

Throws:

NotFoundException

InvalidWidgetConfigurationException

updateWidget

@PUT
 @Timed
 @Path(value="/{widgetId}")
 @Produces(value="application/json")
public void updateWidget(@PathParam(value="dashboardId")
                                                                                                       String dashboardId,
                                                                                                       @PathParam(value="widgetId")
                                                                                                       String widgetId,
                                                                                                       @NotNull
                                                                                                       AddWidgetRequest awr)
                                                                                                throws ValidationException,
                                                                                                       NotFoundException

Throws:

ValidationException

NotFoundException

updateDescription

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

Deprecated.

Throws:

ValidationException

NotFoundException

updateCacheTime

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

Deprecated.

Throws:

ValidationException

NotFoundException