Package org.graylog.events.rest
Class EventDefinitionsResource
java.lang.Object
org.graylog2.shared.rest.resources.RestResource
org.graylog.events.rest.EventDefinitionsResource
- All Implemented Interfaces:
PluginRestResource
@Path("/events/definitions")
@Produces("application/json")
@Consumes("application/json")
@RequiresAuthentication
public class EventDefinitionsResource
extends RestResource
implements PluginRestResource
-
Field Summary
Fields inherited from class org.graylog2.shared.rest.resources.RestResource
configuration, userService
-
Constructor Summary
ConstructorDescriptionEventDefinitionsResource
(DBEventDefinitionService dbService, EventDefinitionHandler eventDefinitionHandler, EventDefinitionContextService contextService, EventProcessorEngine engine, RecentActivityService recentActivityService, AuditEventSender auditEventSender, com.fasterxml.jackson.databind.ObjectMapper objectMapper, EventResolver eventResolver) -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
bulkDelete
(BulkOperationRequest bulkOperationRequest, UserContext userContext) javax.ws.rs.core.Response
bulkSchedule
(BulkOperationRequest bulkOperationRequest, UserContext userContext) javax.ws.rs.core.Response
bulkUnschedule
(BulkOperationRequest bulkOperationRequest, UserContext userContext) void
clearNotificationQueue
(@NotBlank String definitionId) javax.ws.rs.core.Response
create
(boolean schedule, EventDefinitionDto dto, UserContext userContext) delete
(@NotBlank String definitionId, UserContext userContext) void
execute
(@NotBlank String definitionId, @NotNull EventProcessorParameters parameters) getWithContext
(@NotBlank String definitionId) Deprecated.schedule
(@NotBlank String definitionId, UserContext userContext) unschedule
(@NotBlank String definitionId, UserContext userContext) javax.ws.rs.core.Response
update
(@NotBlank String definitionId, boolean schedule, EventDefinitionDto dto, UserContext userContext) validate
(@Valid @NotNull EventDefinitionDto toValidate) Methods inherited from class org.graylog2.shared.rest.resources.RestResource
checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint
-
Constructor Details
-
EventDefinitionsResource
@Inject public EventDefinitionsResource(DBEventDefinitionService dbService, EventDefinitionHandler eventDefinitionHandler, EventDefinitionContextService contextService, EventProcessorEngine engine, RecentActivityService recentActivityService, AuditEventSender auditEventSender, com.fasterxml.jackson.databind.ObjectMapper objectMapper, EventResolver eventResolver)
-
-
Method Details
-
getPage
@GET @Timed @Path("/paginated") @Produces("application/json") public PageListResponse<EventDefinitionDto> getPage(@QueryParam("page") @DefaultValue("1") int page, @QueryParam("per_page") @DefaultValue("50") int perPage, @QueryParam("query") @DefaultValue("") String query, @DefaultValue("title") @QueryParam("sort") String sort, @DefaultValue("asc") @QueryParam("order") String order) -
list
@GET @Deprecated public PaginatedResponse<EventDefinitionDto> list(@QueryParam("page") @DefaultValue("1") int page, @QueryParam("per_page") @DefaultValue("50") int perPage, @QueryParam("query") @DefaultValue("") String query) Deprecated. -
get
@GET @Path("{definitionId}") public EventDefinitionDto get(@PathParam("definitionId") @NotBlank @NotBlank String definitionId) -
getWithContext
-
create
@POST @Produces("application/json") @RequiresPermissions("eventdefinitions:create") public javax.ws.rs.core.Response create(@QueryParam("schedule") @DefaultValue("true") boolean schedule, EventDefinitionDto dto, @Context UserContext userContext) -
update
@PUT @Path("{definitionId}") public javax.ws.rs.core.Response update(@PathParam("definitionId") @NotBlank @NotBlank String definitionId, @QueryParam("schedule") @DefaultValue("true") boolean schedule, EventDefinitionDto dto, @Context UserContext userContext) -
delete
@DELETE @Path("{definitionId}") public EventDefinitionDto delete(@PathParam("definitionId") @NotBlank @NotBlank String definitionId, @Context UserContext userContext) -
bulkDelete
@POST @Path("/bulk_delete") @Consumes("application/json") @Timed public javax.ws.rs.core.Response bulkDelete(BulkOperationRequest bulkOperationRequest, @Context UserContext userContext) -
schedule
@PUT @Path("{definitionId}/schedule") @Consumes("*/*") public EventDefinitionDto schedule(@PathParam("definitionId") @NotBlank @NotBlank String definitionId, @Context UserContext userContext) -
bulkSchedule
@POST @Path("/bulk_schedule") @Consumes("application/json") @Timed public javax.ws.rs.core.Response bulkSchedule(BulkOperationRequest bulkOperationRequest, @Context UserContext userContext) -
unschedule
@PUT @Path("{definitionId}/unschedule") @Consumes("*/*") public EventDefinitionDto unschedule(@PathParam("definitionId") @NotBlank @NotBlank String definitionId, @Context UserContext userContext) -
bulkUnschedule
@POST @Path("/bulk_unschedule") @Consumes("application/json") @Timed public javax.ws.rs.core.Response bulkUnschedule(BulkOperationRequest bulkOperationRequest, @Context UserContext userContext) -
clearNotificationQueue
@PUT @Path("{definitionId}/clear-notification-queue") @Consumes("*/*") public void clearNotificationQueue(@PathParam("definitionId") @NotBlank @NotBlank String definitionId) -
execute
@POST @Path("{definitionId}/execute") public void execute(@PathParam("definitionId") @NotBlank @NotBlank String definitionId, @NotNull @NotNull EventProcessorParameters parameters) -
validate
@POST @Path("/validate") @RequiresPermissions("eventdefinitions:create") public ValidationResult validate(@Valid @NotNull @Valid @NotNull EventDefinitionDto toValidate)
-