How to use

getParameters

method

in

org.finra.herd.model.api.xml.Job

@Override
public Job signalJob(JobSignalRequest request) throws Exception
{
  // Perform the validation.
  validateJobSignalRequest(request);
  Execution execution = activitiService.getExecutionByProcessInstanceIdAndActivitiId(request.getId(), request.getReceiveTaskId());
  if (execution == null)
  {
    throw new ObjectNotFoundException(
      String.format("No job found for matching job id: \"%s\" and receive task id: \"%s\".", request.getId(), request.getReceiveTaskId()));
  }
  String processDefinitionKey = activitiService.getProcessInstanceById(execution.getProcessInstanceId()).getProcessDefinitionKey();
  checkPermissions(processDefinitionKey, new NamespacePermissionEnum[] {NamespacePermissionEnum.EXECUTE});
  // Retrieve the job before signaling.
  Job job = getJob(request.getId(), false, false);
  // Build the parameters map
  Map<String, Object> signalParameters = getParameters(request);
  // Signal the workflow.
  activitiService.signal(execution.getId(), signalParameters);
  // Build the parameters map merged with job and signal parameters.
  Map<String, Object> mergedParameters = new HashMap<>();
  for (Parameter jobParam : job.getParameters())
  {
    mergedParameters.put(jobParam.getName(), jobParam.getValue());
  }
  mergedParameters.putAll(signalParameters);
  // Update the parameters in job
  populateWorkflowParameters(job, mergedParameters);
  return job;
}

@Override
public Job signalJob(JobSignalRequest request) throws Exception
{
  // Perform the validation.
  validateJobSignalRequest(request);
  Execution execution = activitiService.getExecutionByProcessInstanceIdAndActivitiId(request.getId(), request.getReceiveTaskId());
  if (execution == null)
  {
    throw new ObjectNotFoundException(
      String.format("No job found for matching job id: \"%s\" and receive task id: \"%s\".", request.getId(), request.getReceiveTaskId()));
  }
  String processDefinitionKey = activitiService.getProcessInstanceById(execution.getProcessInstanceId()).getProcessDefinitionKey();
  checkPermissions(processDefinitionKey, new NamespacePermissionEnum[] {NamespacePermissionEnum.EXECUTE});
  // Retrieve the job before signaling.
  Job job = getJob(request.getId(), false, false);
  // Build the parameters map
  Map<String, Object> signalParameters = getParameters(request);
  // Signal the workflow.
  activitiService.signal(execution.getId(), signalParameters);
  // Build the parameters map merged with job and signal parameters.
  Map<String, Object> mergedParameters = new HashMap<>();
  for (Parameter jobParam : job.getParameters())
  {
    mergedParameters.put(jobParam.getName(), jobParam.getValue());
  }
  mergedParameters.putAll(signalParameters);
  // Update the parameters in job
  populateWorkflowParameters(job, mergedParameters);
  return job;
}

/**
 * Creates a job where the definition has S3 properties and parameters and request has no parameters. The job definition parameters should take precedence
 * if there are name clashes.
 *
 * @throws Exception
 */
@Test
public void testCreateJobWithS3PropertiesPrecedenceDefinitionParamsOverridesDefinitionS3() throws Exception
{
  Parameter jobDefinitionS3Parameter = new Parameter("testName", "testValue1");
  Parameter jobDefinitionRequestParameter = new Parameter("testName", "expectedValue");
  String s3BucketName = "s3BucketName";
  S3PropertiesLocation jobDefinitionS3PropertiesLocation = getS3PropertiesLocation(s3BucketName, "jobDefinitionObjectKey", jobDefinitionS3Parameter);
  Job resultJob = createJobWithParameters(jobDefinitionS3PropertiesLocation, Arrays.asList(jobDefinitionRequestParameter), null, null);
  List<Parameter> actualParameters = resultJob.getParameters();
  assertParameterEquals(jobDefinitionRequestParameter, actualParameters);
}

@Test
public void testCreateJob() throws Exception
{
  // Create the namespace entity.
  namespaceDaoTestHelper.createNamespaceEntity(TEST_ACTIVITI_NAMESPACE_CD);
  // Create a job definition create request using hard coded test values.
  JobDefinitionCreateRequest jobDefinitionCreateRequest = jobDefinitionServiceTestHelper.createJobDefinitionCreateRequest();
  // Create the job definition.
  jobDefinitionService.createJobDefinition(jobDefinitionCreateRequest, false);
  // Create a job create request using hard coded test values.
  JobCreateRequest jobCreateRequest = jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME);
  // Create the job.
  Job resultJob = jobService.createAndStartJob(jobCreateRequest);
  // Validate the results.
  assertNotNull(resultJob);
  assertNotNull(resultJob.getId());
  assertTrue(!resultJob.getId().isEmpty());
  assertEquals(TEST_ACTIVITI_NAMESPACE_CD, resultJob.getNamespace());
  assertEquals(TEST_ACTIVITI_JOB_NAME, resultJob.getJobName());
  assertEquals(jobDefinitionCreateRequest.getParameters().size() + jobCreateRequest.getParameters().size() + 1, resultJob.getParameters().size());
  List<String> expectedParameters = new ArrayList<>();
  expectedParameters.addAll(parametersToStringList(jobDefinitionCreateRequest.getParameters()));
  expectedParameters.addAll(parametersToStringList(jobCreateRequest.getParameters()));
  expectedParameters.addAll(parametersToStringList(
    Arrays.asList(new Parameter(HERD_WORKFLOW_ENVIRONMENT, configurationHelper.getProperty(ConfigurationValue.HERD_ENVIRONMENT)))));
  List<String> resultParameters = parametersToStringList(resultJob.getParameters());
  assertTrue(expectedParameters.containsAll(resultParameters));
  assertTrue(resultParameters.containsAll(expectedParameters));
}

/**
 * Creates a job where the definition and request has S3 properties and parameters. The job create request's parameter should take precedence if there are
 * name clashes.
 *
 * @throws Exception
 */
@Test
public void testCreateJobWithS3PropertiesPrecedenceJobRequestParamHighestPrecedence() throws Exception
{
  Parameter jobDefinitionS3Parameter = new Parameter("testName", "testValue1");
  Parameter jobDefinitionRequestParameter = new Parameter("testName", "testValue2");
  Parameter jobCreateRequestS3Parameter = new Parameter("testName", "testValue3");
  Parameter jobCreateRequestParameter = new Parameter("testName", "expectedValue");
  String s3BucketName = "s3BucketName";
  S3PropertiesLocation jobDefinitionS3PropertiesLocation = getS3PropertiesLocation(s3BucketName, "jobDefinitionObjectKey", jobDefinitionS3Parameter);
  S3PropertiesLocation jobCreateRequestS3PropertiesLocation =
    getS3PropertiesLocation(s3BucketName, "jobCreateRequestObjectKey", jobCreateRequestS3Parameter);
  Job resultJob =
    createJobWithParameters(jobDefinitionS3PropertiesLocation, Arrays.asList(jobDefinitionRequestParameter), jobCreateRequestS3PropertiesLocation,
      Arrays.asList(jobCreateRequestParameter));
  List<Parameter> actualParameters = resultJob.getParameters();
  assertParameterEquals(jobCreateRequestParameter, actualParameters);
}

/**
 * Creates a job where the definition has S3 properties and parameters and request has S3 properties. The job create request's S3 properties should take
 * precedence if there are name clashes.
 *
 * @throws Exception
 */
@Test
public void testCreateJobWithS3PropertiesPrecedenceJobRequestS3OverridesDefinitionParams() throws Exception
{
  Parameter jobDefinitionS3Parameter = new Parameter("testName", "testValue1");
  Parameter jobDefinitionRequestParameter = new Parameter("testName", "testValue2");
  Parameter jobCreateRequestS3Parameter = new Parameter("testName", "expectedValue");
  String s3BucketName = "s3BucketName";
  S3PropertiesLocation jobDefinitionS3PropertiesLocation = getS3PropertiesLocation(s3BucketName, "jobDefinitionObjectKey", jobDefinitionS3Parameter);
  S3PropertiesLocation jobCreateRequestS3PropertiesLocation =
    getS3PropertiesLocation(s3BucketName, "jobCreateRequestObjectKey", jobCreateRequestS3Parameter);
  Job resultJob =
    createJobWithParameters(jobDefinitionS3PropertiesLocation, Arrays.asList(jobDefinitionRequestParameter), jobCreateRequestS3PropertiesLocation,
      null);
  List<Parameter> actualParameters = resultJob.getParameters();
  assertParameterEquals(jobCreateRequestS3Parameter, actualParameters);
}

assertTrue(getJobResponse.getParameters().contains(new Parameter("createClusterServiceTask_taskStatus", ActivitiRuntimeHelper.TASK_STATUS_SUCCESS)));
assertTrue(getJobResponse.getParameters().contains(new Parameter("checkClusterServiceTask_taskStatus", ActivitiRuntimeHelper.TASK_STATUS_SUCCESS)));
assertTrue(signalJobResponse.getParameters().contains(signalParameter));
Map<String, Parameter> jobParameters = jobServiceTestHelper.toMap(signalJobResponse.getParameters());
assertTrue(jobParameters.containsKey("checkClusterServiceTask_emrClusterStatus_creationTime"));
assertTrue(jobParameters.containsKey("checkClusterServiceTask_emrClusterStatus_readyTime"));
assertTrue(getJobResponse.getParameters().contains(signalParameter));

@Test
public void testCreateJobNoParams() throws Exception
{
  // Create the namespace entity.
  namespaceDaoTestHelper.createNamespaceEntity(TEST_ACTIVITI_NAMESPACE_CD);
  // Create a job definition create request using hard coded test values.
  JobDefinitionCreateRequest jobDefinitionCreateRequest = jobDefinitionServiceTestHelper.createJobDefinitionCreateRequest();
  jobDefinitionCreateRequest.setParameters(null);
  // Create the job definition.
  jobDefinitionService.createJobDefinition(jobDefinitionCreateRequest, false);
  // Create a job create request using hard coded test values.
  JobCreateRequest jobCreateRequest = jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME);
  jobCreateRequest.setParameters(null);
  // Create the job.
  Job resultJob = jobService.createAndStartJob(jobCreateRequest);
  //expected default parameter
  List<Parameter> expectedParameters =
    Arrays.asList(new Parameter(HERD_WORKFLOW_ENVIRONMENT, configurationHelper.getProperty(ConfigurationValue.HERD_ENVIRONMENT)));
  // Validate the results.
  assertNotNull(resultJob);
  assertNotNull(resultJob.getId());
  assertTrue(!resultJob.getId().isEmpty());
  assertEquals(TEST_ACTIVITI_NAMESPACE_CD, resultJob.getNamespace());
  assertEquals(TEST_ACTIVITI_JOB_NAME, resultJob.getJobName());
  assertTrue(resultJob.getParameters().size() == 1);
  assertTrue(expectedParameters.containsAll(resultJob.getParameters()));
}

@Test
public void testSignalJob() throws Exception
{
  jobDefinitionServiceTestHelper.createJobDefinition(ACTIVITI_XML_TEST_RECEIVE_TASK_WITH_CLASSPATH);
  // Start the job.
  Job job = jobService.createAndStartJob(jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME));
  // Job should be waiting at Receive task.
  Job jobGet = jobService.getJob(job.getId(), false);
  assertEquals(JobStatusEnum.RUNNING, jobGet.getStatus());
  assertEquals("receivetask1", jobGet.getCurrentWorkflowStep().getId());
  // Signal job to continue.
  List<Parameter> signalParameters = new ArrayList<>();
  Parameter signalPameter1 = new Parameter("UT_SIGNAL_PARAM_1", "UT_SIGNAL_VALUE_1");
  signalParameters.add(signalPameter1);
  JobSignalRequest jobSignalRequest = new JobSignalRequest(job.getId(), "receivetask1", signalParameters, null);
  Job signalJob = jobService.signalJob(jobSignalRequest);
  assertEquals(JobStatusEnum.RUNNING, signalJob.getStatus());
  assertEquals("receivetask1", signalJob.getCurrentWorkflowStep().getId());
  assertTrue(signalJob.getParameters().contains(signalPameter1));
  // Job should have been completed.
  jobGet = jobService.getJob(job.getId(), true);
  assertEquals(JobStatusEnum.COMPLETED, jobGet.getStatus());
  assertTrue(jobGet.getParameters().contains(signalPameter1));
}

/**
 * Creates a job where the definition and request has S3 properties. Both parameters should be merged.
 *
 * @throws Exception
 */
@Test
public void testCreateJobWithS3Properties() throws Exception
{
  Parameter jobDefinitionS3Parameter = new Parameter("name1", "value1");
  Parameter jobCreateRequestS3Parameter = new Parameter("name2", "value2");
  String s3BucketName = "s3BucketName";
  S3PropertiesLocation jobDefinitionS3PropertiesLocation = getS3PropertiesLocation(s3BucketName, "jobDefinitionObjectKey", jobDefinitionS3Parameter);
  S3PropertiesLocation jobCreateRequestS3PropertiesLocation = getS3PropertiesLocation(s3BucketName, "jobCreationObjectKey", jobCreateRequestS3Parameter);
  Job resultJob = createJobWithParameters(jobDefinitionS3PropertiesLocation, null, jobCreateRequestS3PropertiesLocation, null);
  List<Parameter> actualParameters = resultJob.getParameters();
  assertParameterEquals(jobDefinitionS3Parameter, actualParameters);
  assertParameterEquals(jobCreateRequestS3Parameter, actualParameters);
}

assertTrue(jobGetResponse.getParameters().contains(new Parameter("service_taskStatus", "SUCCESS")));
expectedJdbcExecutionResponse.setStatements(Arrays.asList(expectedJdbcStatement));
Parameter expectedJdbcExecutionResponseParameter = new Parameter("service_jsonResponse", jsonHelper.objectToJson(expectedJdbcExecutionResponse));
assertTrue(jobGetResponse.getParameters().contains(expectedJdbcExecutionResponseParameter));

/**
 * Signals job with both S3 properties and request parameters set. If there are name clashes, the request parameter should take precedence.
 *
 * @throws Exception
 */
@Test
public void testSignalJobWithS3PropertiesPrecedenceRequestParamsOverridesS3() throws Exception
{
  jobDefinitionServiceTestHelper.createJobDefinition(ACTIVITI_XML_TEST_RECEIVE_TASK_WITH_CLASSPATH);
  Parameter s3Parameter = new Parameter("testName", "testValue");
  Parameter requestParameter = new Parameter("testName", "expectedValue");
  S3PropertiesLocation s3PropertiesLocation = getS3PropertiesLocation("s3BucketName", "s3ObjectKey", s3Parameter);
  // Start the job.
  Job job = jobService.createAndStartJob(jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME));
  JobSignalRequest jobSignalRequest = new JobSignalRequest(job.getId(), "receivetask1", null, null);
  jobSignalRequest.setS3PropertiesLocation(s3PropertiesLocation);
  jobSignalRequest.setParameters(Arrays.asList(requestParameter));
  Job signalJob = jobService.signalJob(jobSignalRequest);
  assertParameterEquals(requestParameter, signalJob.getParameters());
}

for (Parameter param : job.getParameters())

assertEquals(Job.class, notificationActions.get(0).getClass());
Job job = (Job) notificationActions.get(0);
List<Parameter> parameters = job.getParameters();
boolean found = false;
for (Parameter parameter : parameters)

/**
 * Signals job with S3 properties set. Parameters should be populated from the properties.
 *
 * @throws Exception
 */
@Test
public void testSignalJobWithS3Properties() throws Exception
{
  jobDefinitionServiceTestHelper.createJobDefinition(ACTIVITI_XML_TEST_RECEIVE_TASK_WITH_CLASSPATH);
  Parameter parameter = new Parameter("testName", "testValue");
  S3PropertiesLocation s3PropertiesLocation = getS3PropertiesLocation("s3BucketName", "s3ObjectKey", parameter);
  // Start the job.
  Job job = jobService.createAndStartJob(jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME));
  JobSignalRequest jobSignalRequest = new JobSignalRequest(job.getId(), "receivetask1", null, null);
  jobSignalRequest.setS3PropertiesLocation(s3PropertiesLocation);
  Job signalJob = jobService.signalJob(jobSignalRequest);
  assertParameterEquals(parameter, signalJob.getParameters());
}

for (Parameter param : job.getParameters())

theParameters = ((this.parameters!= null)?this.getParameters():null);
strategy.appendField(locator, this, "parameters", buffer, theParameters, (this.parameters!= null));

theParameters = ((this.parameters!= null)?this.getParameters():null);
strategy.appendField(locator, this, "parameters", buffer, theParameters, (this.parameters!= null));

/**
 * Tests an edge case where the job definition was persisted with some S3 properties location, but due to some datafix, the S3 properties location's object
 * key was removed, but not the bucket name. The service should still work, it would simply ignore the definition's S3 properties location.
 *
 * @throws Exception
 */
@Test
public void testCreateJobWithS3PropertiesJobDefinitionWrongDatafixSafety() throws Exception
{
  // Create the namespace entity.
  namespaceDaoTestHelper.createNamespaceEntity(TEST_ACTIVITI_NAMESPACE_CD);
  // Create a job definition create request using hard coded test values.
  JobDefinitionCreateRequest jobDefinitionCreateRequest = jobDefinitionServiceTestHelper.createJobDefinitionCreateRequest();
  jobDefinitionCreateRequest.setS3PropertiesLocation(getS3PropertiesLocation("testBucketName", "testObjectKey", new Parameter("testName", "testValue")));
  jobDefinitionCreateRequest.setParameters(null);
  // Create the job definition.
  JobDefinition jobDefinition = jobDefinitionService.createJobDefinition(jobDefinitionCreateRequest, false);
  Integer jobDefinitionId = jobDefinition.getId();
  JobDefinitionEntity jobDefinitionEntity = herdDao.findById(JobDefinitionEntity.class, jobDefinitionId);
  jobDefinitionEntity.setS3ObjectKey(null);
  // Create a job create request using hard coded test values.
  JobCreateRequest jobCreateRequest = jobServiceTestHelper.createJobCreateRequest(TEST_ACTIVITI_NAMESPACE_CD, TEST_ACTIVITI_JOB_NAME);
  jobCreateRequest.setParameters(null);
  // Create the job.
  Job resultJob = jobService.createAndStartJob(jobCreateRequest);
  Assert.assertNotNull("resultJob parameters", resultJob.getParameters());
}

theParameters = ((this.parameters!= null)?this.getParameters():null);
currentHashCode = strategy.hashCode(LocatorUtils.property(locator, "parameters", theParameters), currentHashCode, theParameters, (this.parameters!= null));