Class CollectorResource
java.lang.Object
org.graylog2.shared.rest.resources.RestResource
org.graylog.plugins.sidecar.rest.resources.CollectorResource
- All Implemented Interfaces:
PluginRestResource
@Path("/sidecar/collectors")
@Consumes("application/json")
@Produces("application/json")
@RequiresAuthentication
public class CollectorResource
extends RestResource
implements PluginRestResource
-
Field Summary
Fields inherited from class org.graylog2.shared.rest.resources.RestResource
configuration, userService
-
Constructor Summary
ConstructorDescriptionCollectorResource
(CollectorService collectorService, ConfigurationService configurationService, EtagService etagService) -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
copyCollector
(String id, String name) javax.ws.rs.core.Response
createCollector
(@Valid @NotNull Collector request) javax.ws.rs.core.Response
getCollector
(String id) javax.ws.rs.core.Response
listCollectors
(javax.ws.rs.core.HttpHeaders httpHeaders) listSummary
(int page, int perPage, String query, String sort, String order) javax.ws.rs.core.Response
updateCollector
(String id, @Valid @NotNull Collector request) validateCollector
(@Valid Collector 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
-
CollectorResource
@Inject public CollectorResource(CollectorService collectorService, ConfigurationService configurationService, EtagService etagService)
-
-
Method Details
-
getCollector
-
listCollectors
@GET @Timed @RequiresPermissions("sidecar_collectors:read") @Produces("application/json") public javax.ws.rs.core.Response listCollectors(@Context javax.ws.rs.core.HttpHeaders httpHeaders) throws com.fasterxml.jackson.core.JsonProcessingException - Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
listSummary
@GET @Path("/summary") @RequiresPermissions("sidecar_collectors:read") @Produces("application/json") public CollectorSummaryResponse listSummary(@QueryParam("page") @DefaultValue("1") int page, @QueryParam("per_page") @DefaultValue("50") int perPage, @QueryParam("query") @DefaultValue("") String query, @DefaultValue("name") @QueryParam("sort") String sort, @DefaultValue("asc") @QueryParam("order") String order) -
createCollector
@POST @RequiresPermissions("sidecar_collectors:create") @Produces("application/json") public javax.ws.rs.core.Response createCollector(@Valid @NotNull @Valid @NotNull Collector request) throws javax.ws.rs.BadRequestException - Throws:
javax.ws.rs.BadRequestException
-
updateCollector
@PUT @Path("/{id}") @RequiresPermissions("sidecar_collectors:update") @Produces("application/json") public javax.ws.rs.core.Response updateCollector(@PathParam("id") String id, @Valid @NotNull @Valid @NotNull Collector request) throws javax.ws.rs.BadRequestException - Throws:
javax.ws.rs.BadRequestException
-
copyCollector
@POST @Path("/{id}/{name}") @RequiresPermissions({"sidecar_collectors:read","sidecar_collectors:create"}) public javax.ws.rs.core.Response copyCollector(@PathParam("id") String id, @PathParam("name") String name) throws javax.ws.rs.NotFoundException, javax.ws.rs.BadRequestException - Throws:
javax.ws.rs.NotFoundException
javax.ws.rs.BadRequestException
-
deleteCollector
@DELETE @Path("/{id}") @RequiresPermissions("sidecar_collectors:delete") @Produces("application/json") public javax.ws.rs.core.Response deleteCollector(@PathParam("id") String id) -
validateCollector
@POST @Path("/validate") @RequiresPermissions("sidecar_collectors:read") @Produces("application/json") public ValidationResult validateCollector(@Valid @Valid Collector toValidate)
-