How to use

getBusinessObjectDataKey

method

in

org.finra.herd.service.helper.BusinessObjectDataHelper

/**
 * Returns a list of primary and sub-partition values per specified business object data.
 *
 * @param businessObjectData the business object data
 *
 * @return the list of primary and sub-partition values
 */
public List<String> getPrimaryAndSubPartitionValues(BusinessObjectData businessObjectData)
{
  return getPrimaryAndSubPartitionValues(getBusinessObjectDataKey(businessObjectData));
}

/**
 * Returns a list of primary and sub-partition values per specified business object data.
 *
 * @param businessObjectData the business object data
 *
 * @return the list of primary and sub-partition values
 */
public List<String> getPrimaryAndSubPartitionValues(BusinessObjectData businessObjectData)
{
  return getPrimaryAndSubPartitionValues(getBusinessObjectDataKey(businessObjectData));
}

/**
 * Returns a list of primary and sub-partition values per specified business object data entity.
 *
 * @param businessObjectDataEntity the business object data entity
 *
 * @return the list of primary and sub-partition values
 */
public List<String> getPrimaryAndSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity)
{
  return getPrimaryAndSubPartitionValues(getBusinessObjectDataKey(businessObjectDataEntity));
}

/**
 * Returns a list of primary and sub-partition values per specified business object data entity.
 *
 * @param businessObjectDataEntity the business object data entity
 *
 * @return the list of primary and sub-partition values
 */
public List<String> getPrimaryAndSubPartitionValues(BusinessObjectDataEntity businessObjectDataEntity)
{
  return getPrimaryAndSubPartitionValues(getBusinessObjectDataKey(businessObjectDataEntity));
}

/**
 * Gets a list of matched partition filters per specified list of storage unit entities and a sample partition filter.
 *
 * @param storageUnitEntities the list of storage unit entities
 * @param samplePartitionFilter the sample partition filter
 *
 * @return the list of partition filters
 */
private List<List<String>> getPartitionFilters(List<StorageUnitEntity> storageUnitEntities, List<String> samplePartitionFilter)
{
  List<List<String>> partitionFilters = new ArrayList<>();
  for (StorageUnitEntity storageUnitEntity : storageUnitEntities)
  {
    BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(storageUnitEntity.getBusinessObjectData());
    partitionFilters.add(businessObjectDataHelper.getPartitionFilter(businessObjectDataKey, samplePartitionFilter));
  }
  return partitionFilters;
}

/**
 * Gets a list of matched partition filters per specified list of storage unit entities and a sample partition filter.
 *
 * @param storageUnitEntities the list of storage unit entities
 * @param samplePartitionFilter the sample partition filter
 *
 * @return the list of partition filters
 */
private List<List<String>> getPartitionFilters(List<StorageUnitEntity> storageUnitEntities, List<String> samplePartitionFilter)
{
  List<List<String>> partitionFilters = new ArrayList<>();
  for (StorageUnitEntity storageUnitEntity : storageUnitEntities)
  {
    BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(storageUnitEntity.getBusinessObjectData());
    partitionFilters.add(businessObjectDataHelper.getPartitionFilter(businessObjectDataKey, samplePartitionFilter));
  }
  return partitionFilters;
}

@Override
public String getIdentifyingInformation(NotificationEventParamsDto notificationEventParams, BusinessObjectDataHelper businessObjectDataHelper)
{
  if (notificationEventParams instanceof StorageUnitNotificationEventParamsDto)
  {
    StorageUnitNotificationEventParamsDto storageUnitNotificationEventParams = (StorageUnitNotificationEventParamsDto) notificationEventParams;
    return String.format("namespace: \"%s\", actionId: \"%s\" with " +
      businessObjectDataHelper.businessObjectDataKeyToString(
        businessObjectDataHelper.getBusinessObjectDataKey(storageUnitNotificationEventParams.getBusinessObjectData())) +
      ", storageName: \"%s\"", storageUnitNotificationEventParams.getStorageUnitNotificationRegistration().getNamespace().getCode(),
      storageUnitNotificationEventParams.getNotificationJobAction().getId(), storageUnitNotificationEventParams.getStorageName());
  }
  else
  {
    throw new IllegalStateException(
      "Notification event parameters DTO passed to the method must be an instance of StorageUnitNotificationEventParamsDto.");
  }
}

@Override
public String getIdentifyingInformation(NotificationEventParamsDto notificationEventParams, BusinessObjectDataHelper businessObjectDataHelper)
{
  if (notificationEventParams instanceof BusinessObjectDataNotificationEventParamsDto)
  {
    BusinessObjectDataNotificationEventParamsDto businessObjectDataNotificationEventParams =
      (BusinessObjectDataNotificationEventParamsDto) notificationEventParams;
    return String.format("namespace: \"%s\", actionId: \"%s\" with " +
      businessObjectDataHelper.businessObjectDataKeyToString(
        businessObjectDataHelper.getBusinessObjectDataKey(businessObjectDataNotificationEventParams.getBusinessObjectData())) +
      ", storageName: \"%s\"", businessObjectDataNotificationEventParams.getBusinessObjectDataNotificationRegistration().getNamespace().getCode(),
      businessObjectDataNotificationEventParams.getNotificationJobAction().getId(), businessObjectDataNotificationEventParams.getStorageName());
  }
  else
  {
    throw new IllegalStateException(
      "Notification event parameters DTO passed to the method must be an instance of BusinessObjectDataNotificationEventParamsDto.");
  }
}

@Override
public String getIdentifyingInformation(NotificationEventParamsDto notificationEventParams, BusinessObjectDataHelper businessObjectDataHelper)
{
  if (notificationEventParams instanceof StorageUnitNotificationEventParamsDto)
  {
    StorageUnitNotificationEventParamsDto storageUnitNotificationEventParams = (StorageUnitNotificationEventParamsDto) notificationEventParams;
    return String.format("namespace: \"%s\", actionId: \"%s\" with " +
      businessObjectDataHelper.businessObjectDataKeyToString(
        businessObjectDataHelper.getBusinessObjectDataKey(storageUnitNotificationEventParams.getBusinessObjectData())) +
      ", storageName: \"%s\"", storageUnitNotificationEventParams.getStorageUnitNotificationRegistration().getNamespace().getCode(),
      storageUnitNotificationEventParams.getNotificationJobAction().getId(), storageUnitNotificationEventParams.getStorageName());
  }
  else
  {
    throw new IllegalStateException(
      "Notification event parameters DTO passed to the method must be an instance of StorageUnitNotificationEventParamsDto.");
  }
}

@Override
public String getIdentifyingInformation(NotificationEventParamsDto notificationEventParams, BusinessObjectDataHelper businessObjectDataHelper)
{
  if (notificationEventParams instanceof BusinessObjectDataNotificationEventParamsDto)
  {
    BusinessObjectDataNotificationEventParamsDto businessObjectDataNotificationEventParams =
      (BusinessObjectDataNotificationEventParamsDto) notificationEventParams;
    return String.format("namespace: \"%s\", actionId: \"%s\" with " +
      businessObjectDataHelper.businessObjectDataKeyToString(
        businessObjectDataHelper.getBusinessObjectDataKey(businessObjectDataNotificationEventParams.getBusinessObjectData())) +
      ", storageName: \"%s\"", businessObjectDataNotificationEventParams.getBusinessObjectDataNotificationRegistration().getNamespace().getCode(),
      businessObjectDataNotificationEventParams.getNotificationJobAction().getId(), businessObjectDataNotificationEventParams.getStorageName());
  }
  else
  {
    throw new IllegalStateException(
      "Notification event parameters DTO passed to the method must be an instance of BusinessObjectDataNotificationEventParamsDto.");
  }
}

/**
 * Trigger business object data and storage unit notification for business object data creation event.
 *
 * @param businessObjectData the business object data
 */
public void triggerNotificationsForCreateBusinessObjectData(BusinessObjectData businessObjectData)
{
  BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectData);
  // Create business object data notifications.
  for (NotificationEventTypeEntity.EventTypesBdata eventType : Arrays
    .asList(NotificationEventTypeEntity.EventTypesBdata.BUS_OBJCT_DATA_RGSTN, NotificationEventTypeEntity.EventTypesBdata.BUS_OBJCT_DATA_STTS_CHG))
  {
    notificationEventService.processBusinessObjectDataNotificationEventAsync(eventType, businessObjectDataKey, businessObjectData.getStatus(), null);
  }
  // Create storage unit notifications.
  for (StorageUnit storageUnit : businessObjectData.getStorageUnits())
  {
    notificationEventService
      .processStorageUnitNotificationEventAsync(NotificationEventTypeEntity.EventTypesStorageUnit.STRGE_UNIT_STTS_CHG, businessObjectDataKey,
        storageUnit.getStorage().getName(), storageUnit.getStorageUnitStatus(), null);
  }
}

  @Override
  public void execute() throws Exception
  {
    BusinessObjectData businessObjectData =
      downloaderWebClient.preRegisterBusinessObjectData(uploaderInputManifestDto, StorageEntity.MANAGED_STORAGE, false);
    BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectData);
    downloaderWebClient
      .addStorageFiles(businessObjectDataKey, uploaderInputManifestDto, getTestS3FileTransferRequestParamsDto(S3_TEST_PATH_V0 + "/"),
        StorageEntity.MANAGED_STORAGE);
    downloaderWebClient.updateBusinessObjectDataStatus(businessObjectDataKey, BusinessObjectDataStatusEntity.VALID);
  }
});

/**
 * Sets storage unit status value for a storage unit. This method also generates a storage unit status change notification event as per system
 * configuration.
 *
 * @param storageUnitEntity the storage unit entity
 * @param storageUnitStatusEntity the storage unit status entity
 */
public void setStorageUnitStatus(StorageUnitEntity storageUnitEntity, StorageUnitStatusEntity storageUnitStatusEntity)
{
  // Set the storage unit status value.
  storageUnitEntity.setStatus(storageUnitStatusEntity);
  // Send a storage unit status change notification as per system configuration.
  messageNotificationEventService
    .processStorageUnitStatusChangeNotificationEvent(businessObjectDataHelper.getBusinessObjectDataKey(storageUnitEntity.getBusinessObjectData()),
      storageUnitEntity.getStorage().getName(), storageUnitStatusEntity.getCode(), null);
}

  @Override
  public void execute() throws Exception
  {
    BusinessObjectData businessObjectData =
      downloaderWebClient.preRegisterBusinessObjectData(uploaderInputManifestDto, StorageEntity.MANAGED_STORAGE, false);
    BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectData);
    downloaderWebClient
      .addStorageFiles(businessObjectDataKey, uploaderInputManifestDto, getTestS3FileTransferRequestParamsDto(S3_TEST_PATH_V0 + "/"),
        StorageEntity.MANAGED_STORAGE);
    downloaderWebClient.updateBusinessObjectDataStatus(businessObjectDataKey, BusinessObjectDataStatusEntity.VALID);
  }
});

/**
 * Sets storage unit status value for a storage unit. This method also generates a storage unit status change notification event as per system
 * configuration.
 *
 * @param storageUnitEntity the storage unit entity
 * @param storageUnitStatusEntity the storage unit status entity
 */
public void setStorageUnitStatus(StorageUnitEntity storageUnitEntity, StorageUnitStatusEntity storageUnitStatusEntity)
{
  // Set the storage unit status value.
  storageUnitEntity.setStatus(storageUnitStatusEntity);
  // Send a storage unit status change notification as per system configuration.
  messageNotificationEventService
    .processStorageUnitStatusChangeNotificationEvent(businessObjectDataHelper.getBusinessObjectDataKey(storageUnitEntity.getBusinessObjectData()),
      storageUnitEntity.getStorage().getName(), storageUnitStatusEntity.getCode(), null);
}

@NamespacePermission(fields = "#businessObjectDataKey.namespace", permissions = NamespacePermissionEnum.READ)
@Override
public BusinessObjectDataVersions getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)
{
  // Validate and trim the business object data key.
  businessObjectDataHelper.validateBusinessObjectDataKey(businessObjectDataKey, false, false);
  // Get the business object data versions based on the specified parameters.
  List<BusinessObjectDataEntity> businessObjectDataEntities = businessObjectDataDao.getBusinessObjectDataEntities(businessObjectDataKey);
  // Create the response.
  BusinessObjectDataVersions businessObjectDataVersions = new BusinessObjectDataVersions();
  for (BusinessObjectDataEntity businessObjectDataEntity : businessObjectDataEntities)
  {
    BusinessObjectDataVersion businessObjectDataVersion = new BusinessObjectDataVersion();
    BusinessObjectDataKey businessObjectDataVersionKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectDataEntity);
    businessObjectDataVersion.setBusinessObjectDataKey(businessObjectDataVersionKey);
    businessObjectDataVersion.setStatus(businessObjectDataEntity.getStatus().getCode());
    businessObjectDataVersions.getBusinessObjectDataVersions().add(businessObjectDataVersion);
  }
  return businessObjectDataVersions;
}

@NamespacePermission(fields = "#businessObjectDataKey.namespace", permissions = NamespacePermissionEnum.READ)
@Override
public BusinessObjectDataVersions getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)
{
  // Validate and trim the business object data key.
  businessObjectDataHelper.validateBusinessObjectDataKey(businessObjectDataKey, false, false);
  // Get the business object data versions based on the specified parameters.
  List<BusinessObjectDataEntity> businessObjectDataEntities = businessObjectDataDao.getBusinessObjectDataEntities(businessObjectDataKey);
  // Create the response.
  BusinessObjectDataVersions businessObjectDataVersions = new BusinessObjectDataVersions();
  for (BusinessObjectDataEntity businessObjectDataEntity : businessObjectDataEntities)
  {
    BusinessObjectDataVersion businessObjectDataVersion = new BusinessObjectDataVersion();
    BusinessObjectDataKey businessObjectDataVersionKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectDataEntity);
    businessObjectDataVersion.setBusinessObjectDataKey(businessObjectDataVersionKey);
    businessObjectDataVersion.setStatus(businessObjectDataEntity.getStatus().getCode());
    businessObjectDataVersions.getBusinessObjectDataVersions().add(businessObjectDataVersion);
  }
  return businessObjectDataVersions;
}

/**
 * Uploads and registers a version if of the test business object data that will be used as a parent.
 *
 * @param s3KeyPrefix the destination S3 key prefix that must comply with the S3 naming conventions including the expected data version value
 * @param dataBridgeWebClient the databridge web client instance
 */
protected void uploadAndRegisterTestDataParent(String s3KeyPrefix, DataBridgeWebClient dataBridgeWebClient) throws Exception
{
  uploadTestDataFilesToS3(s3KeyPrefix, testManifestFiles, new ArrayList<String>());
  UploaderInputManifestDto uploaderInputManifestDto = getTestUploaderInputManifestDto(TEST_PARENT_PARTITION_VALUE, TEST_SUB_PARTITION_VALUES, false);
  S3FileTransferRequestParamsDto s3FileTransferRequestParamsDto = getTestS3FileTransferRequestParamsDto();
  s3FileTransferRequestParamsDto.setS3KeyPrefix(s3KeyPrefix + "/");
  BusinessObjectData businessObjectData =
    dataBridgeWebClient.preRegisterBusinessObjectData(uploaderInputManifestDto, StorageEntity.MANAGED_STORAGE, true);
  BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectData);
  dataBridgeWebClient.addStorageFiles(businessObjectDataKey, uploaderInputManifestDto, s3FileTransferRequestParamsDto, StorageEntity.MANAGED_STORAGE);
  dataBridgeWebClient.updateBusinessObjectDataStatus(businessObjectDataKey, BusinessObjectDataStatusEntity.VALID);
  // Clean up the local input directory used for the test data files upload.
  FileUtils.cleanDirectory(LOCAL_TEMP_PATH_INPUT.toFile());
}

@Test
public void testProcessBusinessObjectDataStatusChangeNotificationEventNoMessageVelocityTemplate() throws Exception
{
  // Create a business object data entity.
  BusinessObjectDataEntity businessObjectDataEntity = businessObjectDataServiceTestHelper.createTestValidBusinessObjectData();
  // Get a business object data key.
  BusinessObjectDataKey businessObjectDataKey = businessObjectDataHelper.getBusinessObjectDataKey(businessObjectDataEntity);
  // Override configuration, so there will be no velocity template specified in the relative notification message definition.
  ConfigurationEntity configurationEntity = new ConfigurationEntity();
  configurationEntity.setKey(ConfigurationValue.HERD_NOTIFICATION_BUSINESS_OBJECT_DATA_STATUS_CHANGE_MESSAGE_DEFINITIONS.getKey());
  configurationEntity.setValueClob(xmlHelper.objectToXml(new NotificationMessageDefinitions(Collections.singletonList(
    new NotificationMessageDefinition(MESSAGE_TYPE, MESSAGE_DESTINATION, NO_MESSAGE_VELOCITY_TEMPLATE,
      Collections.singletonList(new MessageHeaderDefinition(KEY, VALUE)))))));
  configurationDao.saveAndRefresh(configurationEntity);
  // Trigger the notification.
  List<NotificationMessage> result = messageNotificationEventService
    .processBusinessObjectDataStatusChangeNotificationEvent(businessObjectDataKey, BusinessObjectDataStatusEntity.VALID,
      BusinessObjectDataStatusEntity.UPLOADING);
  // Validate the results.
  assertEquals(0, CollectionUtils.size(result));
}

@Test
public void testPerformCompleteUploadSingleMessageTargetBusinessObjectDataStatusNotUploading()
{
  uploadDownloadServiceTestHelper.createDatabaseEntitiesForUploadDownloadTesting();
  UploadSingleInitiationResponse resultUploadSingleInitiationResponse = uploadDownloadService.initiateUploadSingle(uploadDownloadServiceTestHelper
    .createUploadSingleInitiationRequest(NAMESPACE, BDEF_NAME, FORMAT_USAGE_CODE, FORMAT_FILE_TYPE_CODE, FORMAT_VERSION, NAMESPACE, BDEF_NAME_2,
      FORMAT_USAGE_CODE_2, FORMAT_FILE_TYPE_CODE_2, FORMAT_VERSION_2, FILE_NAME));
  String filePath = resultUploadSingleInitiationResponse.getTargetBusinessObjectData().getStorageUnits().get(0).getStorageFiles().get(0).getFilePath();
  // Create a business object data status.
  businessObjectDataStatusDaoTestHelper.createBusinessObjectDataStatusEntity(BDATA_STATUS);
  // Update the status of the target business object data so it would not be "UPLOADING".
  businessObjectDataStatusService.updateBusinessObjectDataStatus(
    businessObjectDataHelper.getBusinessObjectDataKey(resultUploadSingleInitiationResponse.getTargetBusinessObjectData()),
    new BusinessObjectDataStatusUpdateRequest(BDATA_STATUS));
  // Try to complete the upload, when target business object data status is not "UPLOADING".
  UploadDownloadServiceImpl.CompleteUploadSingleMessageResult result = uploadDownloadService.performCompleteUploadSingleMessage(filePath);
  assertEquals(BusinessObjectDataStatusEntity.UPLOADING, result.getSourceOldBusinessObjectDataStatus());
  assertNull(result.getSourceNewBusinessObjectDataStatus());
  assertEquals(BDATA_STATUS, result.getTargetOldBusinessObjectDataStatus());
  assertNull(result.getTargetNewBusinessObjectDataStatus());
}