Package org.graylog.plugins.sidecar.rest.resources

Class SidecarResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.plugins.sidecar.rest.resources.SidecarResource

All Implemented Interfaces:

PluginRestResource

@Path("/sidecars")
@Consumes("application/json")
@Produces("application/json")
public class SidecarResource
extends RestResource
implements PluginRestResource

Field Summary

Fields

Modifier and Type	Field	Description
protected static final 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	Description
SidecarResource(SidecarService sidecarService, ActionService actionService, ClusterConfigService clusterConfigService, SidecarStatusMapper sidecarStatusMapper, EtagService etagService)

Method Summary

Modifier and Type	Method	Description
SidecarListResponse	all()
javax.ws.rs.core.Response	assignConfiguration(@Valid @NotNull NodeConfigurationRequest request)
SidecarSummary	get(@NotEmpty String sidecarId)
javax.ws.rs.core.Response	register(@NotEmpty String nodeId, @Valid @NotNull RegistrationRequest request, String ifNoneMatch, @NotEmpty String sidecarVersion)
SidecarListResponse	sidecars(int page, int perPage, String query, String sort, String order, boolean onlyActive)

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 Details

SEARCH_FIELD_MAPPING

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

Constructor Details

SidecarResource

@Inject
public SidecarResource(SidecarService sidecarService,
 ActionService actionService,
 ClusterConfigService clusterConfigService,
 SidecarStatusMapper sidecarStatusMapper,
 EtagService etagService)

Method Details

all

@GET
@Timed
@Path("/all")
public SidecarListResponse all()

sidecars

@GET
@Timed
public SidecarListResponse sidecars(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("node_name") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order,
 @QueryParam("only_active") @DefaultValue("false")
 boolean onlyActive)

get

@GET
@Timed
@Path("/{sidecarId}")
public SidecarSummary get(@PathParam("sidecarId") @NotEmpty
 @NotEmpty String sidecarId)

register

@PUT
@Timed
@Path("/{sidecarId}")
public javax.ws.rs.core.Response register(@PathParam("sidecarId") @NotEmpty
 @NotEmpty String nodeId,
 @Valid @NotNull
 @Valid @NotNull RegistrationRequest request,
 @HeaderParam("If-None-Match")
 String ifNoneMatch,
 @HeaderParam("X-Graylog-Sidecar-Version") @NotEmpty
 @NotEmpty String sidecarVersion)
                                   throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

assignConfiguration

@PUT
@Timed
@Path("/configurations")
public javax.ws.rs.core.Response assignConfiguration(@Valid @NotNull
 @Valid @NotNull NodeConfigurationRequest request)
                                              throws javax.ws.rs.NotFoundException

Throws:

javax.ws.rs.NotFoundException