Class ConfigurationResource
java.lang.Object
org.graylog2.shared.rest.resources.RestResource
org.graylog.plugins.sidecar.rest.resources.ConfigurationResource
- All Implemented Interfaces:
PluginRestResource
@Path("/sidecar/configurations")
@Consumes("application/json")
@Produces("application/json")
@RequiresAuthentication
public class ConfigurationResource
extends RestResource
implements PluginRestResource
-
Field Summary
Fields inherited from class org.graylog2.shared.rest.resources.RestResource
configuration, userService
-
Constructor Summary
ConstructorDescriptionConfigurationResource
(ConfigurationService configurationService, SidecarService sidecarService, EtagService etagService, ImportService importService, CollectorService collectorService) -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
copyConfiguration
(String id, String name) javax.ws.rs.core.Response
createConfiguration
(@Valid @NotNull Configuration request) javax.ws.rs.core.Response
listConfigurations
(int page, int perPage, String query, String sort, String order) listImports
(int page) renderConfiguration
(@Valid @NotNull ConfigurationPreviewRequest request) javax.ws.rs.core.Response
renderConfiguration
(javax.ws.rs.core.HttpHeaders httpHeaders, String sidecarId, String configurationId) javax.ws.rs.core.Response
updateConfiguration
(String id, @Valid @NotNull Configuration request) validateConfiguration
(@Valid Configuration 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
-
ConfigurationResource
@Inject public ConfigurationResource(ConfigurationService configurationService, SidecarService sidecarService, EtagService etagService, ImportService importService, CollectorService collectorService)
-
-
Method Details
-
listConfigurations
@GET @RequiresPermissions("sidecar_collector_configurations:read") @Produces("application/json") public ConfigurationListResponse listConfigurations(@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) -
listImports
@GET @Path("/uploads") @RequiresPermissions("sidecar_collector_configurations:read") @Produces("application/json") public CollectorUploadListResponse listImports(@QueryParam("page") @DefaultValue("1") int page) -
getConfigurations
@GET @Path("/{id}") @RequiresPermissions("sidecar_collector_configurations:read") @Produces("application/json") public Configuration getConfigurations(@PathParam("id") String id) -
getConfigurationSidecars
@GET @Path("/{id}/sidecars") @RequiresPermissions({"sidecar_collector_configurations:read","sidecars:read"}) @Produces("application/json") public ConfigurationSidecarsResponse getConfigurationSidecars(@PathParam("id") String id) -
validateConfiguration
@POST @Path("/validate") @RequiresPermissions("sidecar_collector_configurations:read") @Produces("application/json") public ValidationResult validateConfiguration(@Valid @Valid Configuration toValidate) -
renderConfiguration
@GET @Timed @Path("/render/{sidecarId}/{configurationId}") @Produces("application/json") @RequiresPermissions("sidecar_collector_configurations:read") public javax.ws.rs.core.Response renderConfiguration(@Context javax.ws.rs.core.HttpHeaders httpHeaders, @PathParam("sidecarId") String sidecarId, @PathParam("configurationId") String configurationId) throws RenderTemplateException, com.fasterxml.jackson.core.JsonProcessingException - Throws:
RenderTemplateException
com.fasterxml.jackson.core.JsonProcessingException
-
renderConfiguration
@POST @Path("/render/preview") @Produces("application/json") @RequiresPermissions("sidecar_collector_configurations:read") public ConfigurationPreviewRenderResponse renderConfiguration(@Valid @NotNull @Valid @NotNull ConfigurationPreviewRequest request) -
createConfiguration
@POST @RequiresPermissions("sidecar_collector_configurations:create") @Produces("application/json") public javax.ws.rs.core.Response createConfiguration(@Valid @NotNull @Valid @NotNull Configuration request) -
copyConfiguration
@POST @Path("/{id}/{name}") @RequiresPermissions({"sidecar_collector_configurations:read","sidecar_collector_configurations:create"}) public javax.ws.rs.core.Response copyConfiguration(@PathParam("id") String id, @PathParam("name") String name) throws javax.ws.rs.NotFoundException - Throws:
javax.ws.rs.NotFoundException
-
updateConfiguration
@PUT @Path("/{id}") @RequiresPermissions("sidecar_collector_configurations:update") @Produces("application/json") public javax.ws.rs.core.Response updateConfiguration(@PathParam("id") String id, @Valid @NotNull @Valid @NotNull Configuration request) -
deleteConfiguration
@DELETE @Path("/{id}") @RequiresPermissions("sidecar_collector_configurations:delete") @Produces("application/json") public javax.ws.rs.core.Response deleteConfiguration(@PathParam("id") String id)
-