org.graylog.plugins.views.search.rest

Class ViewsResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.views.search.rest.ViewsResource

All Implemented Interfaces:

PluginRestResource

@Path(value="/views")
 @Produces(value="application/json")
public class ViewsResource
extends RestResource
implements PluginRestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
ViewsResource(ViewService dbService, ClusterEventBus clusterEventBus)

Method Summary

Modifier and Type	Method and Description
ViewDTO	create(@Valid ViewDTO dto, UserContext userContext)
ViewDTO	delete(@NotEmpty String id)
ViewDTO	get(@NotEmpty String id)
void	setDefault(@NotEmpty String id)
ViewDTO	update(@NotEmpty String id, @Valid ViewDTO dto)
PaginatedResponse<ViewDTO>	views(int page, int perPage, String sortField, String order, String query)

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

ViewsResource

@Inject
public ViewsResource(ViewService dbService,
                             ClusterEventBus clusterEventBus)

Method Detail

views

@GET
public PaginatedResponse<ViewDTO> views(@QueryParam(value="page") @DefaultValue(value="1")
                                             int page,
                                             @QueryParam(value="per_page") @DefaultValue(value="50")
                                             int perPage,
                                             @DefaultValue(value="title") @QueryParam(value="sort")
                                             String sortField,
                                             @DefaultValue(value="asc") @QueryParam(value="order")
                                             String order,
                                             @QueryParam(value="query")
                                             String query)

get

@GET
 @Path(value="{id}")
public ViewDTO get(@PathParam(value="id") @NotEmpty
                                             @NotEmpty String id)

create

@POST
public ViewDTO create(@Valid
                            @Valid ViewDTO dto,
                            @Context
                            UserContext userContext)
                     throws ValidationException

Throws:

ValidationException

update

@PUT
 @Path(value="{id}")
public ViewDTO update(@PathParam(value="id") @NotEmpty
                                                @NotEmpty String id,
                                                @Valid
                                                @Valid ViewDTO dto)

setDefault

@PUT
 @Path(value="{id}/default")
public void setDefault(@PathParam(value="id") @NotEmpty
                                                         @NotEmpty String id)

delete

@DELETE
 @Path(value="{id}")
public ViewDTO delete(@PathParam(value="id") @NotEmpty
                                                   @NotEmpty String id)