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

userService

Constructor Summary

Constructors

Constructor and Description
DashboardsResource(DashboardService dashboardService, ActivityWriter activityWriter, ClusterEventBus clusterEventBus, com.google.common.eventbus.EventBus serverEventBus)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(CreateDashboardRequest cr)
void	delete(String dashboardId)
Map<String,Object>	get(String dashboardId)
DashboardList	list()
void	setPositions(String dashboardId, @Valid WidgetPositionsRequest uwpr)
void	update(String dashboardId, UpdateDashboardRequest cr)

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

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, 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

DashboardsResource

@Inject
public DashboardsResource(DashboardService dashboardService,
                                  ActivityWriter activityWriter,
                                  ClusterEventBus clusterEventBus,
                                  com.google.common.eventbus.EventBus serverEventBus)

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,
                                                                                                       ValidationException

Throws:

NotFoundException

ValidationException

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,
                                                                                                                    @Valid
                                                                                                                    @Valid WidgetPositionsRequest uwpr)
                                                                                                             throws NotFoundException,
                                                                                                                    ValidationException

Throws:

NotFoundException

ValidationException