Package org.graylog2.rest.resources.search

Class SearchResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.search.SearchResource

Direct Known Subclasses:

AbsoluteSearchResource, KeywordSearchResource, RelativeSearchResource

public abstract class SearchResource
extends RestResource

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_SCROLL_BATCH_SIZE
protected final Searches	searches

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

configuration, userService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected org.glassfish.jersey.server.ChunkedOutput<ResultChunk>	buildChunkedOutput(ChunkedResult scroll)
protected SearchResponse	buildSearchResponse(String query, MessageList.Result results, List<String> fieldList, long tookMs, TimeRange timeRange, boolean decorate, Optional<String> streamId)
protected SearchResponse	buildSearchResponse(SearchResult sr, TimeRange timeRange, boolean decorate, Optional<String> streamId)
protected Sorting	buildSorting(String sort)
protected Sort	buildSortOrder(String sort)
void	checkSearchPermission(String filter, String searchPermission)
protected Runnable	createScrollChunkProducer(ChunkedResult scroll, org.glassfish.jersey.server.ChunkedOutput<ResultChunk> output)
protected Search	createSearch(String queryString, int limit, int offset, String filter, List<String> fieldList, Sort sorting, TimeRange timeRange)
protected SearchResponse	extractSearchResponse(SearchJob searchJob, String query, boolean decorate, List<String> fieldList, TimeRange timeRange, Optional<String> streamId)
protected Set<IndexRangeSummary>	indexRangeListToValueList(Set<IndexRange> indexRanges)
protected List<String>	parseFields(String fields)
protected List<String>	parseOptionalFields(String fields)
protected TimeRange	restrictTimeRange(TimeRange timeRange)
protected List<ResultMessageSummary>	resultMessageListtoValueList(List<ResultMessage> resultMessages)
protected SearchResponse	search(String query, int limit, int offset, String filter, boolean decorate, SearchUser searchUser, List<String> fieldList, Sort sorting, TimeRange timeRange)

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

Field Details

DEFAULT_SCROLL_BATCH_SIZE

protected static final String DEFAULT_SCROLL_BATCH_SIZE

See Also:

• Constant Field Values

searches

protected final Searches searches

Constructor Details

SearchResource

public SearchResource(Searches searches,
 ClusterConfigService clusterConfigService,
 DecoratorProcessor decoratorProcessor,
 SearchExecutor searchExecutor)

Method Details

search

protected SearchResponse search(String query,
 int limit,
 int offset,
 String filter,
 boolean decorate,
 SearchUser searchUser,
 List<String> fieldList,
 Sort sorting,
 TimeRange timeRange)

parseFields

protected List<String> parseFields(String fields)

parseOptionalFields

protected List<String> parseOptionalFields(String fields)

buildSearchResponse

protected SearchResponse buildSearchResponse(SearchResult sr,
 TimeRange timeRange,
 boolean decorate,
 Optional<String> streamId)

buildSearchResponse

protected SearchResponse buildSearchResponse(String query,
 MessageList.Result results,
 List<String> fieldList,
 long tookMs,
 TimeRange timeRange,
 boolean decorate,
 Optional<String> streamId)

indexRangeListToValueList

protected Set<IndexRangeSummary> indexRangeListToValueList(Set<IndexRange> indexRanges)

resultMessageListtoValueList

protected List<ResultMessageSummary> resultMessageListtoValueList(List<ResultMessage> resultMessages)

buildSorting

protected Sorting buildSorting(String sort)

buildSortOrder

protected Sort buildSortOrder(String sort)

createSearch

protected Search createSearch(String queryString,
 int limit,
 int offset,
 String filter,
 List<String> fieldList,
 Sort sorting,
 TimeRange timeRange)

extractSearchResponse

protected SearchResponse extractSearchResponse(SearchJob searchJob,
 String query,
 boolean decorate,
 List<String> fieldList,
 TimeRange timeRange,
 Optional<String> streamId)

buildChunkedOutput

protected org.glassfish.jersey.server.ChunkedOutput<ResultChunk> buildChunkedOutput(ChunkedResult scroll)

checkSearchPermission

public void checkSearchPermission(String filter,
 String searchPermission)

createScrollChunkProducer

protected Runnable createScrollChunkProducer(ChunkedResult scroll,
 org.glassfish.jersey.server.ChunkedOutput<ResultChunk> output)

restrictTimeRange

protected TimeRange restrictTimeRange(TimeRange timeRange)