org.graylog2.rest.resources.streams.alerts

Class StreamAlertResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.streams.alerts.StreamAlertResource

@Path(value="/streams/{streamId}/alerts")
public class StreamAlertResource
extends RestResource

Field Summary

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

userService

Constructor Summary

Constructors

Constructor and Description
StreamAlertResource(StreamService streamService, AlertService alertService, AlarmCallbackConfigurationService alarmCallbackConfigurationService, AlarmCallbackFactory alarmCallbackFactory)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addReceiver(String streamId, String entity, String type) Deprecated.
Map<String,Object>	checkConditions(String streamId)
AlertListSummary	list(String streamId, @Min(value=0L) int sinceTs, @Min(value=1L) int limit)
AlertListSummary	listPaginated(String streamId, int skip, int limit, String state)
void	removeReceiver(String streamId, String entity, String type) Deprecated.
void	sendDummyAlert(String streamId)

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 Detail

StreamAlertResource

@Inject
public StreamAlertResource(StreamService streamService,
                                   AlertService alertService,
                                   AlarmCallbackConfigurationService alarmCallbackConfigurationService,
                                   AlarmCallbackFactory alarmCallbackFactory)

Method Detail

list

@GET
 @Timed
 @Produces(value="application/json")
public AlertListSummary list(@PathParam(value="streamId")
                                                                               String streamId,
                                                                               @QueryParam(value="since") @DefaultValue(value="0") @Min(value=0L)
                                                                               @Min(value=0L) int sinceTs,
                                                                               @QueryParam(value="limit") @DefaultValue(value="300") @Min(value=1L)
                                                                               @Min(value=1L) int limit)
                                                                        throws NotFoundException

Throws:

NotFoundException

listPaginated

@GET
 @Timed
 @Path(value="paginated")
 @Produces(value="application/json")
public AlertListSummary listPaginated(@PathParam(value="streamId")
                                                                                                                  String streamId,
                                                                                                                  @QueryParam(value="skip") @DefaultValue(value="0")
                                                                                                                  int skip,
                                                                                                                  @QueryParam(value="limit") @DefaultValue(value="300")
                                                                                                                  int limit,
                                                                                                                  @QueryParam(value="state")
                                                                                                                  String state)
                                                                                                           throws NotFoundException

Throws:

NotFoundException

checkConditions

@GET
 @Timed
 @Path(value="check")
 @Produces(value="application/json")
public Map<String,Object> checkConditions(@PathParam(value="streamId")
                                                                                                                  String streamId)
                                                                                                           throws NotFoundException

Throws:

NotFoundException

addReceiver

@POST
 @Timed
 @Path(value="receivers")
 @Deprecated
public javax.ws.rs.core.Response addReceiver(@PathParam(value="streamId")
                                                                                                  String streamId,
                                                                                                  @QueryParam(value="entity")
                                                                                                  String entity,
                                                                                                  @QueryParam(value="type")
                                                                                                  String type)
                                                                                           throws NotFoundException

Deprecated.

Throws:

NotFoundException

removeReceiver

@DELETE
 @Timed
 @Path(value="receivers")
 @Deprecated
public void removeReceiver(@PathParam(value="streamId")
                                                                                  String streamId,
                                                                                  @QueryParam(value="entity")
                                                                                  String entity,
                                                                                  @QueryParam(value="type")
                                                                                  String type)
                                                                           throws NotFoundException

Deprecated.

Throws:

NotFoundException

sendDummyAlert

@POST
 @Timed
 @Path(value="sendDummyAlert")
public void sendDummyAlert(@PathParam(value="streamId")
                                                                        String streamId)
                                                                 throws TransportConfigurationException,
                                                                        org.apache.commons.mail.EmailException,
                                                                        NotFoundException

Throws:

TransportConfigurationException

org.apache.commons.mail.EmailException

NotFoundException