com.hubspot.singularity.resources.RequestGroupResource Maven / Gradle / Ivy

Go to download
package com.hubspot.singularity.resources;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.inject.Inject;
import com.hubspot.singularity.Singularity;
import com.hubspot.singularity.SingularityRequestGroup;
import com.hubspot.singularity.config.ApiPaths;
import com.hubspot.singularity.data.RequestGroupManager;
import com.hubspot.singularity.data.SingularityValidator;
import com.ning.http.client.AsyncHttpClient;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import java.util.List;
import java.util.Optional;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.curator.framework.recipes.leader.LeaderLatch;

@Path(ApiPaths.REQUEST_GROUP_RESOURCE_PATH)
@Produces({ MediaType.APPLICATION_JSON })
@Schema(
  title = "Manages Singularity Request Groups, which are collections of one or more Singularity Requests"
)
@Tags({ @Tag(name = "Request Groups") })
public class RequestGroupResource extends AbstractLeaderAwareResource {
  private final RequestGroupManager requestGroupManager;
  private final SingularityValidator validator;

  @Inject
  public RequestGroupResource(
    AsyncHttpClient httpClient,
    LeaderLatch leaderLatch,
    @Singularity ObjectMapper objectMapper,
    RequestGroupManager requestGroupManager,
    SingularityValidator validator
  ) {
    super(httpClient, leaderLatch, objectMapper);
    this.requestGroupManager = requestGroupManager;
    this.validator = validator;
  }

  @GET
  @Operation(summary = "Get a list of Singularity request groups")
  public List getRequestGroupIds(
    @Parameter(
      description = "Use a cached version of this data to limit expensive api calls"
    ) @QueryParam("useWebCache") Boolean useWebCache
  ) {
    return requestGroupManager.getRequestGroups(useWebCache != null && useWebCache);
  }

  @GET
  @Path("/group/{requestGroupId}")
  @Operation(
    summary = "Get a specific Singularity request group by ID",
    responses = {
      @ApiResponse(
        responseCode = "404",
        description = "The specified request group was not found"
      )
    }
  )
  public Optional getRequestGroup(
    @Parameter(required = true, description = "The id of the request group") @PathParam(
      "requestGroupId"
    ) String requestGroupId
  ) {
    return requestGroupManager.getRequestGroup(requestGroupId);
  }

  @DELETE
  @Path("/group/{requestGroupId}")
  @Operation(summary = "Delete a specific Singularity request group by ID")
  public Response deleteRequestGroup(
    @Parameter(required = true, description = "The id of the request group") @PathParam(
      "requestGroupId"
    ) String requestGroupId,
    @Context HttpServletRequest requestContext
  ) {
    return maybeProxyToLeader(
      requestContext,
      Response.class,
      null,
      () -> {
        requestGroupManager.deleteRequestGroup(requestGroupId);
        return Response.ok().build();
      }
    );
  }

  @POST
  @Operation(summary = "Create a Singularity request group")
  public SingularityRequestGroup saveRequestGroup(
    @RequestBody(
      required = true,
      description = "The new request group to create"
    ) SingularityRequestGroup requestGroup,
    @Context HttpServletRequest requestContext
  ) {
    return maybeProxyToLeader(
      requestContext,
      SingularityRequestGroup.class,
      requestGroup,
      () -> {
        validator.checkRequestGroup(requestGroup);
        requestGroupManager.saveRequestGroup(requestGroup);
        return requestGroup;
      }
    );
  }
}