Package org.graylog2.rest.resources.streams

Class StreamResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.streams.StreamResource

@RequiresAuthentication
@Path("/streams")
public class StreamResource
extends RestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

Constructor	Description
StreamResource(StreamService streamService, PaginatedStreamService paginatedStreamService, StreamRuleService streamRuleService, StreamRouterEngine.Factory streamRouterEngineFactory, IndexSetRegistry indexSetRegistry, RecentActivityService recentActivityService, AuditEventSender auditEventSender)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	assignToIndexSet(String indexSetId, @Valid @NotNull List<String> streamIds)
javax.ws.rs.core.Response	bulkDelete(BulkOperationRequest bulkOperationRequest, UserContext userContext)
javax.ws.rs.core.Response	bulkPause(BulkOperationRequest bulkOperationRequest, UserContext userContext)
javax.ws.rs.core.Response	bulkResume(BulkOperationRequest bulkOperationRequest, UserContext userContext)
javax.ws.rs.core.Response	cloneStream(String streamId, @Valid @NotNull CloneStreamRequest cr, UserContext userContext)
javax.ws.rs.core.Response	create(CreateStreamRequest cr, UserContext userContext)
void	delete(String streamId, UserContext userContext)
StreamListResponse	get()	Deprecated.
StreamResponse	get(@NotEmpty String streamId)
StreamListResponse	getEnabled()
PageListResponse<StreamDTO>	getPage(int page, int perPage, String query, List<String> filters, String sort, String order)
void	pause(@NotEmpty String streamId)
void	resume(@NotEmpty String streamId, UserContext userContext)
TestMatchResponse	testMatch(String streamId, @NotNull Map<String,Map<String,Object>> serialisedMessage)
StreamResponse	update(String streamId, @Valid @NotNull UpdateStreamRequest cr, UserContext userContext)

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

StreamResource

@Inject
public StreamResource(StreamService streamService,
 PaginatedStreamService paginatedStreamService,
 StreamRuleService streamRuleService,
 StreamRouterEngine.Factory streamRouterEngineFactory,
 IndexSetRegistry indexSetRegistry,
 RecentActivityService recentActivityService,
 AuditEventSender auditEventSender)

Method Details

create

@POST
@Timed
@RequiresPermissions("streams:create")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response create(CreateStreamRequest cr,
 @Context
 UserContext userContext)
                                 throws ValidationException

Throws:

ValidationException

getPage

@GET
@Timed
@Path("/paginated")
@Produces("application/json")
public PageListResponse<StreamDTO> getPage(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @QueryParam("filters")
 List<String> filters,
 @DefaultValue("title") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order)

get

@GET
@Timed
@Deprecated
@Produces("application/json")
public StreamListResponse get()

Deprecated.

getEnabled

@GET
@Path("/enabled")
@Timed
@Produces("application/json")
public StreamListResponse getEnabled()

get

@GET
@Path("/{streamId}")
@Timed
@Produces("application/json")
public StreamResponse get(@PathParam("streamId") @NotEmpty
 @NotEmpty String streamId)
                   throws NotFoundException

Throws:

NotFoundException

update

@PUT
@Timed
@Path("/{streamId}")
@Consumes("application/json")
@Produces("application/json")
public StreamResponse update(@PathParam("streamId")
 String streamId,
 @Valid @NotNull
 @Valid @NotNull UpdateStreamRequest cr,
 @Context
 UserContext userContext)
                      throws NotFoundException,
ValidationException

Throws:

NotFoundException

ValidationException

delete

@DELETE
@Path("/{streamId}")
@Timed
public void delete(@PathParam("streamId")
 String streamId,
 @Context
 UserContext userContext)
            throws NotFoundException

Throws:

NotFoundException

bulkDelete

@POST
@Path("/bulk_delete")
@Consumes("application/json")
@Timed
public javax.ws.rs.core.Response bulkDelete(BulkOperationRequest bulkOperationRequest,
 @Context
 UserContext userContext)

bulkPause

@POST
@Path("/bulk_pause")
@Consumes("application/json")
@Timed
public javax.ws.rs.core.Response bulkPause(BulkOperationRequest bulkOperationRequest,
 @Context
 UserContext userContext)

bulkResume

@POST
@Path("/bulk_resume")
@Consumes("application/json")
@Timed
public javax.ws.rs.core.Response bulkResume(BulkOperationRequest bulkOperationRequest,
 @Context
 UserContext userContext)

pause

@POST
@Path("/{streamId}/pause")
@Timed
public void pause(@PathParam("streamId") @NotEmpty
 @NotEmpty String streamId)
           throws NotFoundException,
ValidationException

Throws:

NotFoundException

ValidationException

resume

@POST
@Path("/{streamId}/resume")
@Timed
public void resume(@PathParam("streamId") @NotEmpty
 @NotEmpty String streamId,
 @Context
 UserContext userContext)
            throws NotFoundException,
ValidationException

Throws:

NotFoundException

ValidationException

testMatch

@POST
@Path("/{streamId}/testMatch")
@Timed
public TestMatchResponse testMatch(@PathParam("streamId")
 String streamId,
 @NotNull
 @NotNull Map<String,Map<String,Object>> serialisedMessage)
                            throws NotFoundException

Throws:

NotFoundException

cloneStream

@POST
@Path("/{streamId}/clone")
@Timed
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response cloneStream(@PathParam("streamId")
 String streamId,
 @Valid @NotNull
 @Valid @NotNull CloneStreamRequest cr,
 @Context
 UserContext userContext)
                                      throws ValidationException,
NotFoundException

Throws:

ValidationException

NotFoundException

assignToIndexSet

@PUT
@Path("/indexSet/{indexSetId}")
@Timed
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response assignToIndexSet(@PathParam("indexSetId")
 String indexSetId,
 @Valid @NotNull
 @Valid @NotNull List<String> streamIds)