org.finra.herd.service.impl

Class BusinessObjectDataServiceImpl

java.lang.Object

org.finra.herd.service.impl.BusinessObjectDataServiceImpl

All Implemented Interfaces:

BusinessObjectDataService

@Service
 @Transactional(value="herdTransactionManager")
public class BusinessObjectDataServiceImpl
extends Object
implements BusinessObjectDataService

The business object data service implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_PARTITIONING_PARTITION_KEY The partition key value for business object data without partitioning.
static String	NO_PARTITIONING_PARTITION_VALUE The partition value for business object data without partitioning.
static String	REASON_NOT_REGISTERED A status reason of "not registered".

Fields inherited from interface org.finra.herd.service.BusinessObjectDataService

MAX_PARTITION_VALUE_TOKEN, MIN_PARTITION_VALUE_TOKEN

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDataServiceImpl()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataAvailability	checkBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest request) Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.
BusinessObjectDataAvailabilityCollectionResponse	checkBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest request) Performs an availability check for a collection of business object data.
BusinessObjectData	createBusinessObjectData(BusinessObjectDataCreateRequest request) Creates a new business object data from the request information.
BusinessObjectData	deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Boolean deleteFiles) Deletes an existing business object data.
BusinessObjectData	destroyBusinessObjectData(BusinessObjectDataKey businessObjectDataKey) Initiates destruction process for an existing business object data by using S3 tagging to mark the relative S3 files for deletion and updating statuses of the business object data and its storage unit.
BusinessObjectDataDdl	generateBusinessObjectDataDdl(BusinessObjectDataDdlRequest request) Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage.
BusinessObjectDataDdlCollectionResponse	generateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest request) Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storages.
BusinessObjectDataPartitions	generateBusinessObjectDataPartitions(BusinessObjectDataPartitionsRequest request) Generates the partitions information for a range of requested business object data in the specified storage.
BusinessObjectDataKeys	getAllBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object definition.
BusinessObjectDataKeys	getAllBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey) Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object format.
BusinessObjectData	getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory, Boolean includeStorageUnitStatusHistory, Boolean excludeBusinessObjectDataStorageFiles) Retrieves existing business object data entry information.
BusinessObjectDataVersions	getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey) Retrieves a list of existing business object data versions, if any.
BusinessObjectDataInvalidateUnregisteredResponse	invalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest) Creates business object data registrations in INVALID status if the S3 object exists, but no registration exists.
BusinessObjectData	restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, Integer expirationInDays, String archiveRetrievalOption) Initiates a restore request for a currently archived business object data.
BusinessObjectData	retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetryStoragePolicyTransitionRequest request) Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation.
BusinessObjectDataSearchResultPagingInfoDto	searchBusinessObjectData(Integer pageNum, Integer pageSize, BusinessObjectDataSearchRequest businessObjectDataSearchRequest) Search business object data based on the request
BusinessObjectData	updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest) Updates attributes for business object data.
BusinessObjectData	updateBusinessObjectDataParents(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataParentsUpdateRequest businessObjectDataParentsUpdateRequest) Updates parents for business object data.
BusinessObjectData	updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey, BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest) Updates retention information for an existing business object data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_PARTITIONING_PARTITION_KEY

public static final String NO_PARTITIONING_PARTITION_KEY

The partition key value for business object data without partitioning.

See Also:

Constant Field Values

NO_PARTITIONING_PARTITION_VALUE

public static final String NO_PARTITIONING_PARTITION_VALUE

The partition value for business object data without partitioning.

See Also:

Constant Field Values

REASON_NOT_REGISTERED

public static final String REASON_NOT_REGISTERED

A status reason of "not registered".

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDataServiceImpl

public BusinessObjectDataServiceImpl()

Method Detail

checkBusinessObjectDataAvailability

@NamespacePermission(fields="#request.namespace",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataAvailability checkBusinessObjectDataAvailability(BusinessObjectDataAvailabilityRequest request)

Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data. Creates its own transaction.

This implementation starts a new transaction.

Specified by:

checkBusinessObjectDataAvailability in interface BusinessObjectDataService

Parameters:

request - the business object data availability request

Returns:

the business object data availability information

checkBusinessObjectDataAvailabilityCollection

@NamespacePermission(fields="#request?.businessObjectDataAvailabilityRequests?.![namespace]",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataAvailabilityCollectionResponse checkBusinessObjectDataAvailabilityCollection(BusinessObjectDataAvailabilityCollectionRequest request)

Performs an availability check for a collection of business object data.

This implementation starts a new transaction.

Specified by:

checkBusinessObjectDataAvailabilityCollection in interface BusinessObjectDataService

Parameters:

request - the business object data availability collection request

Returns:

the business object data availability information

createBusinessObjectData

@PublishNotificationMessages
 @NamespacePermission(fields="#request.namespace",
                     permissions=WRITE)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectData createBusinessObjectData(BusinessObjectDataCreateRequest request)

Creates a new business object data from the request information. Creates its own transaction.

This implementation starts a new transaction.

Specified by:

createBusinessObjectData in interface BusinessObjectDataService

Parameters:

request - the business object data create request

Returns:

the newly created and persisted business object data.

deleteBusinessObjectData

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
public BusinessObjectData deleteBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                           Boolean deleteFiles)

Deletes an existing business object data.

This implementation keeps the current transaction context.

Specified by:

deleteBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

deleteFiles - specifies if data files should be deleted or not

Returns:

the deleted business object data information

destroyBusinessObjectData

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
 @Transactional(propagation=NOT_SUPPORTED)
public BusinessObjectData destroyBusinessObjectData(BusinessObjectDataKey businessObjectDataKey)

Initiates destruction process for an existing business object data by using S3 tagging to mark the relative S3 files for deletion and updating statuses of the business object data and its storage unit. The S3 data then gets deleted by S3 bucket lifecycle policy that is based on S3 tagging.

This implementation executes non-transactionally, suspends the current transaction if one exists.

Specified by:

destroyBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object data information

generateBusinessObjectDataDdl

@NamespacePermission(fields="#request.namespace",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataDdl generateBusinessObjectDataDdl(BusinessObjectDataDdlRequest request)

Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage. This method starts a new transaction.

This implementation starts a new transaction.

Specified by:

generateBusinessObjectDataDdl in interface BusinessObjectDataService

Parameters:

request - the business object data DDL request

Returns:

the business object data DDL information

generateBusinessObjectDataDdlCollection

@NamespacePermission(fields="#request?.businessObjectDataDdlRequests?.![namespace]",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataDdlCollectionResponse generateBusinessObjectDataDdlCollection(BusinessObjectDataDdlCollectionRequest request)

Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storages. This method starts a new transaction.

This implementation starts a new transaction.

Specified by:

generateBusinessObjectDataDdlCollection in interface BusinessObjectDataService

Parameters:

request - the business object data DDL collection request

Returns:

the business object data DDL information

getAllBusinessObjectDataByBusinessObjectDefinition

@NamespacePermission(fields="#businessObjectDefinitionKey.namespace",
                     permissions=READ)
public BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object definition.

This implementation keeps the current transaction context.

Specified by:

getAllBusinessObjectDataByBusinessObjectDefinition in interface BusinessObjectDataService

Parameters:

businessObjectDefinitionKey - the business object definition key (case-insensitive)

Returns:

the list of business object data keys

getAllBusinessObjectDataByBusinessObjectFormat

@NamespacePermission(fields="#businessObjectFormatKey.namespace",
                     permissions=READ)
public BusinessObjectDataKeys getAllBusinessObjectDataByBusinessObjectFormat(BusinessObjectFormatKey businessObjectFormatKey)

Retrieves a list of keys for all existing business object data up to the limit configured in the system per specified business object format.

This implementation keeps the current transaction context.

Specified by:

getAllBusinessObjectDataByBusinessObjectFormat in interface BusinessObjectDataService

Parameters:

businessObjectFormatKey - the business object format key (case-insensitive)

Returns:

the list of business object data keys

getBusinessObjectData

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectData getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                                                                 String businessObjectFormatPartitionKey,
                                                                                                                                                                                                 String businessObjectDataStatus,
                                                                                                                                                                                                 Boolean includeBusinessObjectDataStatusHistory,
                                                                                                                                                                                                 Boolean includeStorageUnitStatusHistory,
                                                                                                                                                                                                 Boolean excludeBusinessObjectDataStorageFiles)

Retrieves existing business object data entry information. This method starts a new transaction.

This implementation starts a new transaction.

Specified by:

getBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

businessObjectFormatPartitionKey - the business object format partition key

businessObjectDataStatus - the business object data status, may be null

includeBusinessObjectDataStatusHistory - specifies to include business object data status history in the response

includeStorageUnitStatusHistory - specifies to include storage unit status history for each storage unit in the response

excludeBusinessObjectDataStorageFiles - specifies to exclude storage files in the response

Returns:

the retrieved business object data information

getBusinessObjectDataVersions

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=READ)
public BusinessObjectDataVersions getBusinessObjectDataVersions(BusinessObjectDataKey businessObjectDataKey)

Retrieves a list of existing business object data versions, if any.

This implementation keeps the current transaction context.

Specified by:

getBusinessObjectDataVersions in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key with possibly missing business object format and/or data version values

Returns:

the retrieved business object data versions

invalidateUnregisteredBusinessObjectData

@PublishNotificationMessages
 @NamespacePermission(fields="#businessObjectDataInvalidateUnregisteredRequest.namespace",
                     permissions=WRITE)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataInvalidateUnregisteredResponse invalidateUnregisteredBusinessObjectData(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)

Creates business object data registrations in INVALID status if the S3 object exists, but no registration exists.

This implementation starts a new transaction.

Specified by:

invalidateUnregisteredBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataInvalidateUnregisteredRequest - BusinessObjectDataInvalidateUnregisteredRequest

Returns:

BusinessObjectDataInvalidateUnregisteredResponse

restoreBusinessObjectData

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
 @Transactional(propagation=NOT_SUPPORTED)
public BusinessObjectData restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                                                                       Integer expirationInDays,
                                                                                                                                                                                                       String archiveRetrievalOption)

Initiates a restore request for a currently archived business object data.

This implementation executes non-transactionally, suspends the current transaction if one exists.

Specified by:

restoreBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

expirationInDays - the the time, in days, between when the business object data is restored to the S3 bucket and when it expires

archiveRetrievalOption - the archive retrieval option when restoring an archived object. Currently three options are supported: Expedited, Standard, and Bulk

Returns:

the business object data information

generateBusinessObjectDataPartitions

@NamespacePermission(fields="#request.namespace",
                     permissions=READ)
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDataPartitions generateBusinessObjectDataPartitions(BusinessObjectDataPartitionsRequest request)

Generates the partitions information for a range of requested business object data in the specified storage. This method starts a new transaction.

This implementation starts a new transaction.

Specified by:

generateBusinessObjectDataPartitions in interface BusinessObjectDataService

Parameters:

request - the business object data partitions request

Returns:

the business object data partitions information

retryStoragePolicyTransition

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
public BusinessObjectData retryStoragePolicyTransition(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                               BusinessObjectDataRetryStoragePolicyTransitionRequest request)

Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation.

This implementation keeps the current transaction context.

Specified by:

retryStoragePolicyTransition in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

request - the information needed to retry a storage policy transition

Returns:

the business object data information

searchBusinessObjectData

@NamespacePermission(fields="#businessObjectDataSearchRequest.businessObjectDataSearchFilters[0].BusinessObjectDataSearchKeys[0].namespace",
                     permissions=READ)
public BusinessObjectDataSearchResultPagingInfoDto searchBusinessObjectData(Integer pageNum,
                                                                                                                                                                                                                                                                Integer pageSize,
                                                                                                                                                                                                                                                                BusinessObjectDataSearchRequest businessObjectDataSearchRequest)

Search business object data based on the request

This implementation keeps the current transaction context.

Specified by:

searchBusinessObjectData in interface BusinessObjectDataService

Parameters:

pageNum - if pageNum parameter is specified, results contain the appropriate page specified. Page numbers are one-based - that is the first page number is one.

pageSize - if pageSize parameter is specified, results contain that number of business object data (unless it is the end of the result set).

businessObjectDataSearchRequest - search request

Returns:

business data search result with the paging information

updateBusinessObjectDataAttributes

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions={WRITE,WRITE_ATTRIBUTE})
public BusinessObjectData updateBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                                                       BusinessObjectDataAttributesUpdateRequest businessObjectDataAttributesUpdateRequest)

Updates attributes for business object data.

This implementation keeps the current transaction context.

Specified by:

updateBusinessObjectDataAttributes in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataAttributesUpdateRequest - the information needed to update the business object data attributes

Returns:

the updated business object data information

updateBusinessObjectDataParents

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
public BusinessObjectData updateBusinessObjectDataParents(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                                  BusinessObjectDataParentsUpdateRequest businessObjectDataParentsUpdateRequest)

Updates parents for business object data.

This implementation keeps the current transaction context.

Specified by:

updateBusinessObjectDataParents in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataParentsUpdateRequest - the information needed to update the business object data parents

Returns:

the updated business object data information

updateBusinessObjectDataRetentionInformation

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
public BusinessObjectData updateBusinessObjectDataRetentionInformation(BusinessObjectDataKey businessObjectDataKey,
                                                                                                                                                                               BusinessObjectDataRetentionInformationUpdateRequest businessObjectDataRetentionInformationUpdateRequest)

Updates retention information for an existing business object data.

This implementation keeps the current transaction context.

Specified by:

updateBusinessObjectDataRetentionInformation in interface BusinessObjectDataService

Parameters:

businessObjectDataKey - the business object data key

businessObjectDataRetentionInformationUpdateRequest - the business object data retention information update request

Returns:

the business object data information