org.graylog.plugins.views.search.rest

Class SearchResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.views.search.rest.SearchResource

All Implemented Interfaces:

PluginRestResource

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

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
SearchResource(QueryEngine queryEngine, SearchDbService searchDbService, SearchJobService searchJobService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, PermittedStreams permittedStreams, SearchExecutionGuard executionGuard, SearchDomain searchDomain, com.google.common.eventbus.EventBus serverEventBus)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createSearch(Search search)
javax.ws.rs.core.Response	executeQuery(String id, Map<String,Object> executionState)
javax.ws.rs.core.Response	executeSyncJob(@NotNull(message="Search body is mandatory") Search search, long timeout)
List<Search>	getAllSearches()
Search	getSearch(String searchId)
SearchJob	jobStatus(String jobId)
SearchMetadata	metadata(String searchId)
SearchMetadata	metadataForObject(@NotNull Search search)

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

SearchResource

@Inject
public SearchResource(QueryEngine queryEngine,
                              SearchDbService searchDbService,
                              SearchJobService searchJobService,
                              com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                              PermittedStreams permittedStreams,
                              SearchExecutionGuard executionGuard,
                              SearchDomain searchDomain,
                              com.google.common.eventbus.EventBus serverEventBus)

Method Detail

createSearch

@POST
public javax.ws.rs.core.Response createSearch(Search search)

getSearch

@GET
 @Path(value="{id}")
public Search getSearch(@PathParam(value="id")
                                                  String searchId)

getAllSearches

@GET
public List<Search> getAllSearches()

executeQuery

@POST
 @Path(value="{id}/execute")
public javax.ws.rs.core.Response executeQuery(@PathParam(value="id")
                                                                                 String id,
                                                                                 Map<String,Object> executionState)

executeSyncJob

@POST
 @Path(value="sync")
public javax.ws.rs.core.Response executeSyncJob(@NotNull(message="Search body is mandatory")
                                                                           @NotNull(message="Search body is mandatory") Search search,
                                                                           @QueryParam(value="timeout") @DefaultValue(value="60000")
                                                                           long timeout)

jobStatus

@GET
 @Path(value="status/{jobId}")
public SearchJob jobStatus(@PathParam(value="jobId")
                                                               String jobId)

metadata

@GET
 @Path(value="metadata/{searchId}")
public SearchMetadata metadata(@PathParam(value="searchId")
                                                                        String searchId)

metadataForObject

@POST
 @Path(value="metadata")
public SearchMetadata metadataForObject(@NotNull
                                                                       @NotNull Search search)