Package org.graylog2.rest.resources.search

Class KeywordSearchResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.search.SearchResource

org.graylog2.rest.resources.search.KeywordSearchResource

@RequiresAuthentication
@Path("/search/universal/keyword")
public class KeywordSearchResource
extends SearchResource

Field Summary

Fields inherited from class org.graylog2.rest.resources.search.SearchResource

DEFAULT_SCROLL_BATCH_SIZE, searches

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
KeywordSearchResource(Searches searches, SearchExecutor searchExecutor, ClusterConfigService clusterConfigService, DecoratorProcessor decoratorProcessor)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	exportSearchKeywordChunked(@NotEmpty String query, @NotEmpty String keyword, @NotEmpty String timezone, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)
SearchResponse	searchKeyword(@NotEmpty String query, @NotEmpty String keyword, @NotEmpty String timezone, int limit, int offset, String filter, String fields, String sort, boolean decorate, SearchUser searchUser)
org.glassfish.jersey.server.ChunkedOutput<ResultChunk>	searchKeywordChunked(@NotEmpty String query, @NotEmpty String keyword, @NotEmpty String timezone, int limit, int offset, int batchSize, String filter, @NotEmpty String fields)

Methods inherited from class org.graylog2.rest.resources.search.SearchResource

buildChunkedOutput, buildSearchResponse, buildSearchResponse, buildSorting, buildSortOrder, checkSearchPermission, createScrollChunkProducer, createSearch, extractSearchResponse, indexRangeListToValueList, parseFields, parseOptionalFields, restrictTimeRange, resultMessageListtoValueList, 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 Details

KeywordSearchResource

@Inject
public KeywordSearchResource(Searches searches,
 SearchExecutor searchExecutor,
 ClusterConfigService clusterConfigService,
 DecoratorProcessor decoratorProcessor)

Method Details

searchKeyword

@GET
@Timed
@Produces("application/json")
public SearchResponse searchKeyword(@QueryParam("query") @NotEmpty
 @NotEmpty String query,
 @QueryParam("keyword") @NotEmpty
 @NotEmpty String keyword,
 @QueryParam("timezone") @NotEmpty
 @NotEmpty String timezone,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset,
 @QueryParam("filter")
 String filter,
 @QueryParam("fields")
 String fields,
 @QueryParam("sort")
 String sort,
 @QueryParam("decorate") @DefaultValue("true")
 boolean decorate,
 @Context
 SearchUser searchUser)

searchKeywordChunked

@GET
@Timed
@Produces("text/csv")
public org.glassfish.jersey.server.ChunkedOutput<ResultChunk> searchKeywordChunked(@QueryParam("query") @NotEmpty
 @NotEmpty String query,
 @QueryParam("keyword") @NotEmpty
 @NotEmpty String keyword,
 @QueryParam("timezone") @NotEmpty
 @NotEmpty String timezone,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset,
 @QueryParam("batch_size") @DefaultValue("500")
 int batchSize,
 @QueryParam("filter")
 String filter,
 @QueryParam("fields") @NotEmpty
 @NotEmpty String fields)

exportSearchKeywordChunked

@GET
@Path("/export")
@Timed
@Produces("text/csv")
public javax.ws.rs.core.Response exportSearchKeywordChunked(@QueryParam("query") @NotEmpty
 @NotEmpty String query,
 @QueryParam("keyword") @NotEmpty
 @NotEmpty String keyword,
 @QueryParam("timezone") @NotEmpty
 @NotEmpty String timezone,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset,
 @QueryParam("batch_size") @DefaultValue("500")
 int batchSize,
 @QueryParam("filter")
 String filter,
 @QueryParam("fields") @NotEmpty
 @NotEmpty String fields)