Package org.graylog.plugins.views.search.rest

Class MessagesResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.views.search.rest.MessagesResource

All Implemented Interfaces:

PluginRestResource

@Path("/views/search/messages")
@RequiresAuthentication
public class MessagesResource
extends RestResource
implements PluginRestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
MessagesResource(MessagesExporter exporter, CommandFactory commandFactory, SearchDomain searchDomain, SearchExecutionGuard executionGuard, com.google.common.eventbus.EventBus eventBus, ExportJobService exportJobService, QueryValidationService queryValidationService)

Method Summary

Modifier and Type	Method	Description
org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk>	retrieve(@Valid MessagesRequest rawrequest, SearchUser searchUser)
org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk>	retrieveForExportJob(String exportJobId, String filename, SearchUser searchUser)
org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk>	retrieveForSearch(String searchId, @Valid ResultFormat formatFromClient, SearchUser searchUser)
org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk>	retrieveForSearchType(String searchId, String searchTypeId, @Valid ResultFormat formatFromClient, 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 Details

MessagesResource

@Inject
public MessagesResource(MessagesExporter exporter,
 CommandFactory commandFactory,
 SearchDomain searchDomain,
 SearchExecutionGuard executionGuard,
 com.google.common.eventbus.EventBus eventBus,
 ExportJobService exportJobService,
 QueryValidationService queryValidationService)

Method Details

retrieve

@POST
@Produces("text/csv")
public org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk> retrieve(@Valid
 @Valid MessagesRequest rawrequest,
 @Context
 SearchUser searchUser)

retrieveForSearch

@POST
@Path("{searchId}")
@Produces("text/csv")
public org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk> retrieveForSearch(@PathParam("searchId")
 String searchId,
 @Valid
 @Valid ResultFormat formatFromClient,
 @Context
 SearchUser searchUser)

retrieveForSearchType

@POST
@Path("{searchId}/{searchTypeId}")
public org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk> retrieveForSearchType(@PathParam("searchId")
 String searchId,
 @PathParam("searchTypeId")
 String searchTypeId,
 @Valid
 @Valid ResultFormat formatFromClient,
 @Context
 SearchUser searchUser)

retrieveForExportJob

@GET
@Path("job/{exportJobId}/{filename}")
public org.glassfish.jersey.server.ChunkedOutput<SimpleMessageChunk> retrieveForExportJob(@PathParam("exportJobId")
 String exportJobId,
 @PathParam("filename")
 String filename,
 @Context
 SearchUser searchUser)