Skip to content

Commit

Permalink
#30367 Applying code review feedback.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jgambarios
jgambarios committed Dec 4, 2024
1 parent 432e64d commit a185478
Showing 1 changed file with 41 additions and 30 deletions.
71 changes: 41 additions & 30 deletions dotCMS/src/main/java/com/dotcms/rest/api/v1/job/JobQueueResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import java.util.Set;
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.BeanParam;
import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue;
Expand Down Expand Up @@ -54,14 +55,14 @@ public JobQueueResource(WebResource webResource, JobQueueHelper helper,
@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.APPLICATION_JSON)
public Response createJob(
@Context HttpServletRequest request,
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("queueName") String queueName,
@BeanParam JobParams form) throws JsonProcessingException, DotDataException {

final var initDataObject = new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();

Expand All @@ -79,14 +80,14 @@ public Response createJob(
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response createJob(
@Context HttpServletRequest request,
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("queueName") String queueName,
Map<String, Object> parameters) throws DotDataException {

final var initDataObject = new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();

Expand All @@ -102,11 +103,12 @@ public Response createJob(
@GET
@Path("/queues")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<Set<String>> getQueues(@Context HttpServletRequest request) {
public ResponseEntityView<Set<String>> getQueues(
@Context HttpServletRequest request, @Context final HttpServletResponse response) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
return new ResponseEntityView<>(helper.getQueueNames());
Expand All @@ -115,14 +117,14 @@ public ResponseEntityView<Set<String>> getQueues(@Context HttpServletRequest req
@GET
@Path("/{jobId}/status")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<Job> getJobStatus(@Context HttpServletRequest request,
@PathParam("jobId") String jobId)
throws DotDataException {
public ResponseEntityView<Job> getJobStatus(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("jobId") String jobId) throws DotDataException {

new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();

Expand All @@ -134,12 +136,13 @@ public ResponseEntityView<Job> getJobStatus(@Context HttpServletRequest request,
@Path("/{jobId}/cancel")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.WILDCARD)
public ResponseEntityView<String> cancelJob(@Context HttpServletRequest request,
public ResponseEntityView<String> cancelJob(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("jobId") String jobId) throws DotDataException {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
helper.cancelJob(jobId);
Expand All @@ -149,14 +152,15 @@ public ResponseEntityView<String> cancelJob(@Context HttpServletRequest request,
@GET
@Path("/{queueName}/active")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> activeJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> activeJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("queueName") String queueName,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getActiveJobs(queueName, page, pageSize);
Expand All @@ -165,13 +169,14 @@ public ResponseEntityView<JobPaginatedResult> activeJobs(@Context HttpServletReq

@GET
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> listJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> listJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getJobs(page, pageSize);
Expand All @@ -181,13 +186,14 @@ public ResponseEntityView<JobPaginatedResult> listJobs(@Context HttpServletReque
@GET
@Path("/active")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> activeJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> activeJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getActiveJobs(page, pageSize);
Expand All @@ -197,13 +203,14 @@ public ResponseEntityView<JobPaginatedResult> activeJobs(@Context HttpServletReq
@GET
@Path("/completed")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> completedJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> completedJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getCompletedJobs(page, pageSize);
Expand All @@ -214,13 +221,13 @@ public ResponseEntityView<JobPaginatedResult> completedJobs(@Context HttpServlet
@Path("/successful")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> successfulJobs(
@Context HttpServletRequest request,
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getSuccessfulJobs(page, pageSize);
Expand All @@ -230,13 +237,14 @@ public ResponseEntityView<JobPaginatedResult> successfulJobs(
@GET
@Path("/canceled")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> canceledJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> canceledJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getCanceledJobs(page, pageSize);
Expand All @@ -246,13 +254,14 @@ public ResponseEntityView<JobPaginatedResult> canceledJobs(@Context HttpServletR
@GET
@Path("/failed")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> failedJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> failedJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getFailedJobs(page, pageSize);
Expand All @@ -262,13 +271,14 @@ public ResponseEntityView<JobPaginatedResult> failedJobs(@Context HttpServletReq
@GET
@Path("/abandoned")
@Produces(MediaType.APPLICATION_JSON)
public ResponseEntityView<JobPaginatedResult> abandonedJobs(@Context HttpServletRequest request,
public ResponseEntityView<JobPaginatedResult> abandonedJobs(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@QueryParam("page") @DefaultValue("1") int page,
@QueryParam("pageSize") @DefaultValue("20") int pageSize) {
new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();
final JobPaginatedResult result = helper.getAbandonedJobs(page, pageSize);
Expand All @@ -279,13 +289,14 @@ public ResponseEntityView<JobPaginatedResult> abandonedJobs(@Context HttpServlet
@Path("/{jobId}/monitor")
@Produces(SseFeature.SERVER_SENT_EVENTS)
@SuppressWarnings("java:S1854") // jobWatcher assignment is needed for cleanup in catch blocks
public EventOutput monitorJob(@Context HttpServletRequest request,
public EventOutput monitorJob(
@Context HttpServletRequest request, @Context final HttpServletResponse response,
@PathParam("jobId") String jobId) {

new InitBuilder(webResource)
.requiredBackendUser(true)
.requiredFrontendUser(false)
.requestAndResponse(request, null)
.requestAndResponse(request, response)
.rejectWhenNoUser(true)
.init();

Expand Down

0 comments on commit a185478

Please sign in to comment.