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, SearchDomain searchDomain, Map<String,ViewResolver> viewResolvers)

Method Summary

Modifier and Type	Method and Description
ViewDTO	create(@Valid @NotNull(message="View is mandatory") ViewDTO dto, UserContext userContext, SearchUser searchUser)
ViewDTO	delete(@NotEmpty String id, SearchUser searchUser)
ViewDTO	get(@NotEmpty String id, SearchUser searchUser)
void	setDefault(@NotEmpty String id)
ViewDTO	update(@NotEmpty String id, @Valid ViewDTO dto, SearchUser searchUser)
protected void	validateSearchProperties(ViewDTO dto, Search search)
PaginatedResponse<ViewDTO>	views(int page, int perPage, String sortField, String order, String query, SearchUser searchUser)

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,
                             SearchDomain searchDomain,
                             Map<String,ViewResolver> viewResolvers)

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,
                                             @Context
                                             SearchUser searchUser)

get

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

create

@POST
public ViewDTO create(@Valid @NotNull(message="View is mandatory")
                            @Valid @NotNull(message="View is mandatory") ViewDTO dto,
                            @Context
                            UserContext userContext,
                            @Context
                            SearchUser searchUser)
                     throws ValidationException

Throws:

ValidationException

validateSearchProperties

protected void validateSearchProperties(ViewDTO dto,
                                        Search search)

update

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

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,
                                                   @Context
                                                   SearchUser searchUser)