org.graylog2.rest.resources.streams

Class StreamResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.streams.StreamResource

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.common.collect.ImmutableMap<String,SearchQueryField>	SEARCH_FIELD_MAPPING

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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
StreamResource(StreamService streamService, PaginatedStreamService paginatedStreamService, StreamRuleService streamRuleService, StreamRouterEngine.Factory streamRouterEngineFactory, IndexSetRegistry indexSetRegistry, AlarmCallbackConfigurationService alarmCallbackConfigurationService, AlertService alertService)

Method Summary

Modifier and Type	Method and Description
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)
StreamListResponse	get() Deprecated.
StreamResponse	get(@NotEmpty String streamId)
StreamListResponse	getEnabled()
StreamPageListResponse	getPage(int page, int perPage, String query, String sort, String order)
void	pause(@NotEmpty String streamId)
void	resume(@NotEmpty String streamId)
TestMatchResponse	testMatch(String streamId, @NotNull Map<String,Map<String,Object>> serialisedMessage)
StreamResponse	update(String streamId, @Valid @NotNull UpdateStreamRequest cr)

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 Detail

SEARCH_FIELD_MAPPING

protected static final com.google.common.collect.ImmutableMap<String,SearchQueryField> SEARCH_FIELD_MAPPING

Constructor Detail

StreamResource

@Inject
public StreamResource(StreamService streamService,
                              PaginatedStreamService paginatedStreamService,
                              StreamRuleService streamRuleService,
                              StreamRouterEngine.Factory streamRouterEngineFactory,
                              IndexSetRegistry indexSetRegistry,
                              AlarmCallbackConfigurationService alarmCallbackConfigurationService,
                              AlertService alertService)

Method Detail

create

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

Throws:

ValidationException

getPage

@GET
 @Timed
 @Path(value="/paginated")
 @Produces(value="application/json")
public StreamPageListResponse getPage(@QueryParam(value="page") @DefaultValue(value="1")
                                                                                                                   int page,
                                                                                                                   @QueryParam(value="per_page") @DefaultValue(value="50")
                                                                                                                   int perPage,
                                                                                                                   @QueryParam(value="query") @DefaultValue(value="")
                                                                                                                   String query,
                                                                                                                   @DefaultValue(value="title") @QueryParam(value="sort")
                                                                                                                   String sort,
                                                                                                                   @DefaultValue(value="asc") @QueryParam(value="order")
                                                                                                                   String order)

get

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

Deprecated.

getEnabled

@GET
 @Path(value="/enabled")
 @Timed
 @Produces(value="application/json")
public StreamListResponse getEnabled()
                                                                                                         throws NotFoundException

Throws:

NotFoundException

get

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

Throws:

NotFoundException

update

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

Throws:

NotFoundException

ValidationException

delete

@DELETE
 @Path(value="/{streamId}")
 @Timed
public void delete(@PathParam(value="streamId")
                                                               String streamId)
                                                        throws NotFoundException

Throws:

NotFoundException

pause

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

Throws:

NotFoundException

ValidationException

resume

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

Throws:

NotFoundException

ValidationException

testMatch

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

Throws:

NotFoundException

cloneStream

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

Throws:

ValidationException

NotFoundException