Change query parameter to 'acquired' to 'executing'

Author: prajwolbhandari1

engine-rest/engine-rest-openapi/src/main/templates/lib/commons/job-query-params.ftl

@@ -164,9 +164,9 @@
     "desc": "Include jobs which belong to no tenant. Can be used in combination with `tenantIdIn`.
              Value may only be `true`, as `false` is the default behavior."
     },
-  "executing": {
+  "acquired": {
     "type": "boolean",
-    "desc": "Only select jobs which are executing, i.e.,  lock expiration date is not null, lock expiration
+    "desc": "Only select jobs which are acquired, i.e.,  lock expiration date is not null, lock expiration
              date is in future and suspension state is 1. Value may only be `true`, as `false` is the default
              behavior."
   }

engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/runtime/JobQueryDto.java

@@ -94,7 +94,7 @@ public class JobQueryDto extends AbstractQueryDto<JobQuery> {
   protected List<String> tenantIds;
   protected Boolean withoutTenantId;
   protected Boolean includeJobsWithoutTenantId;
-  protected Boolean executing;
+  protected Boolean acquired;
 
   protected List<ConditionQueryParameterDto> dueDates;
   protected List<ConditionQueryParameterDto> createTimes;
@@ -235,9 +235,9 @@ public void setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId) {
     this.includeJobsWithoutTenantId = includeJobsWithoutTenantId;
   }
 
-  @CamundaQueryParam(value="executing", converter = BooleanConverter.class)
-  public void setExecuting(Boolean executing) {
-    this.executing = executing;
+  @CamundaQueryParam(value="acquired", converter = BooleanConverter.class)
+  public void setAcquired(Boolean acquired) {
+    this.acquired = acquired;
   }
 
   @Override
@@ -424,8 +424,8 @@ String fieldName() {
     if (TRUE.equals(includeJobsWithoutTenantId)) {
       query.includeJobsWithoutTenantId();
     }
-    if (TRUE.equals(executing)) {
-      query.executing();
+    if (TRUE.equals(acquired)) {
+      query.acquired();
     }
   }
 

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/JobRestServiceQueryTest.java

@@ -360,13 +360,13 @@ public void testMessagesParameter() {
   }
 
   @Test
-  public void testExecutingParameter() {
+  public void testAcquiredParameter() {
     Map<String, Object> parameters = new HashMap<>();
-    parameters.put("executing", MockProvider.EXAMPLE_EXECUTING);
+    parameters.put("acquired", MockProvider.EXAMPLE_ACQUIRED);
 
     given().queryParams(parameters).then().expect().statusCode(Status.OK.getStatusCode()).when().get(JOBS_RESOURCE_URL);
 
-    verify(mockQuery).executing();
+    verify(mockQuery).acquired();
     verify(mockQuery).list();
   }
 
@@ -432,7 +432,7 @@ private Map<String, Object> getCompleteParameters() {
     parameters.put("priorityLowerThanOrEquals", JOB_QUERY_MAX_PRIORITY);
     parameters.put("priorityHigherThanOrEquals", JOB_QUERY_MIN_PRIORITY);
     parameters.put("jobDefinitionId", MockProvider.EXAMPLE_JOB_DEFINITION_ID);
-    parameters.put("executing", MockProvider.EXAMPLE_EXECUTING);
+    parameters.put("acquired", MockProvider.EXAMPLE_ACQUIRED);
     return parameters;
   }
 
@@ -470,7 +470,7 @@ private void verifyParameterQueryInvocations() {
     verify(mockQuery).priorityLowerThanOrEquals(JOB_QUERY_MAX_PRIORITY);
     verify(mockQuery).priorityHigherThanOrEquals(JOB_QUERY_MIN_PRIORITY);
     verify(mockQuery).jobDefinitionId(MockProvider.EXAMPLE_JOB_DEFINITION_ID);
-    verify(mockQuery).executing();
+    verify(mockQuery).acquired();
   }
 
   private void testDateParameters(DateParameters parameters) {

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java

@@ -530,7 +530,7 @@ public abstract class MockProvider {
   public static final String EXAMPLE_AUTHORIZATION_ID = "someAuthorizationId";
   public static final int EXAMPLE_AUTHORIZATION_TYPE = 0;
   public static final String EXAMPLE_AUTHORIZATION_TYPE_STRING = "0";
-  public static final Boolean EXAMPLE_EXECUTING = true;
+  public static final Boolean EXAMPLE_ACQUIRED = true;
 
 
   // process applications

engine/src/main/java/org/camunda/bpm/engine/impl/JobQueryImpl.java

@@ -71,7 +71,7 @@ public class JobQueryImpl extends AbstractQuery<JobQuery, Job> implements JobQue
   protected String failedActivityId;
   protected boolean noRetriesLeft;
   protected SuspensionState suspensionState;
-  protected boolean executing;
+  protected boolean acquired;
 
   protected boolean isTenantIdSet = false;
   protected String[] tenantIds;
@@ -258,8 +258,8 @@ public JobQuery suspended() {
     return this;
   }
 
-  public JobQuery executing() {
-    executing = true;
+  public JobQuery acquired() {
+    acquired = true;
     return this;
   }
 
@@ -408,8 +408,8 @@ public boolean isWithException() {
   public String getExceptionMessage() {
     return exceptionMessage;
   }
-  public boolean getExecuting() {
-    return executing;
+  public boolean getAcquired() {
+    return acquired;
   }
 
 }

engine/src/main/java/org/camunda/bpm/engine/runtime/JobQuery.java

@@ -192,9 +192,9 @@ public interface JobQuery extends Query<JobQuery, Job> {
   JobQuery orderByTenantId();
 
   /**
-   * Only select jobs that are executing,
+   * Only select jobs that are currently being acquired,
    * ie. lock expiration time is not null, lock expiration is in future and suspension state is 1
    */
-  JobQuery executing();
+  JobQuery acquired();
 
 }

engine/src/main/resources/org/camunda/bpm/engine/impl/mapping/entity/Job.xml

@@ -420,7 +420,7 @@
       <if test="suspensionState != null">
         and RES.SUSPENSION_STATE_ = #{suspensionState.stateCode}
       </if>
-      <if test="executing">
+      <if test="acquired">
         AND
         RES.SUSPENSION_STATE_ = 1
         AND

engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/JobQueryTest.java

@@ -872,7 +872,7 @@ public void testQueryInvalidSortingUsage() {
   }
 
   @Test
-  public void testQueryByExecuting() {
+  public void testQueryByAcquired() {
     Calendar lockExpDate = Calendar.getInstance();
     //given - lock expiration date in future
     lockExpDate.add(Calendar.MILLISECOND, 30000000);
@@ -882,15 +882,15 @@ public void testQueryByExecuting() {
     Job job = managementService.createJobQuery().jobId(timerEntity.getId()).singleResult();
     assertNotNull(job);
 
-    List<Job> list = managementService.createJobQuery().executing().list();
+    List<Job> list = managementService.createJobQuery().acquired().list();
     assertEquals(list.size(), 1);
     deleteJobInDatabase();
 
     //given - lock expiration date in the past
     lockExpDate.add(Calendar.MILLISECOND, -60000000);
     createJobWithLockExpiration(lockExpDate.getTime());
 
-    list = managementService.createJobQuery().executing().list();
+    list = managementService.createJobQuery().acquired().list();
     assertEquals(list.size(), 0);
 
     deleteJobInDatabase();
@@ -913,22 +913,20 @@ public Void execute(CommandContext commandContext) {
 
   private void createJobWithLockExpiration(Date lockDate) {
     CommandExecutor commandExecutor = processEngineConfiguration.getCommandExecutorTxRequired();
-    commandExecutor.execute(new Command<Void>() {
-      public Void execute(CommandContext commandContext) {
-        JobManager jobManager = commandContext.getJobManager();
-        timerEntity = new TimerEntity();
-        timerEntity.setLockOwner(UUID.randomUUID().toString());
-        timerEntity.setDuedate(new Date());
-        timerEntity.setRetries(0);
-        timerEntity.setLockExpirationTime(lockDate);
+    commandExecutor.execute((Command<Void>) commandContext -> {
+      JobManager jobManager = commandContext.getJobManager();
+      timerEntity = new TimerEntity();
+      timerEntity.setLockOwner(UUID.randomUUID().toString());
+      timerEntity.setDuedate(new Date());
+      timerEntity.setRetries(0);
+      timerEntity.setLockExpirationTime(lockDate);
 
-        jobManager.insert(timerEntity);
+      jobManager.insert(timerEntity);
 
-        assertNotNull(timerEntity.getId());
+      assertNotNull(timerEntity.getId());
 
-        return null;
+      return null;
 
-      }
     });
   }
 

webapps/frontend/camunda-bpm-sdk-js/lib/api-client/resources/job.js

@@ -66,7 +66,8 @@ Job.get = function(id, done) {
  * @param  {String}   params.sorting.sortOrder      Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
  * @param  {String}   [params.firstResult]          Pagination of results. Specifies the index of the first result to return.
  * @param  {String}   [params.maxResults]           Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.
- * @param  {Bool}     [params.executing]            Only select jobs which are executing, ie. lock expiration time is not null, lock expiration is in future and suspension state is 1
+ * @param  {Bool}     [params.acquired]             Select jobs which are acquired, ie. lock expiration time is not
+ *                                                  null,lock expiration is in future and suspension state is 1
  * @param  {Function} done
  */
 Job.list = function(params, done) {