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	REASON_ARCHIVED A status reason of "archived".
static String	REASON_NO_ENABLED_STORAGE_UNIT A status reason of "no enabled storage unit".
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
protected void	addNotAvailableBusinessObjectDataStatuses(List<BusinessObjectDataStatus> notAvailableStatuses, BusinessObjectFormatKey businessObjectFormatKey, List<List<String>> matchedAvailablePartitionFilters, List<List<String>> availablePartitions, List<String> storageNames) Updates the list of not-available statuses by adding business object data status instances created from discovered "non-available" registered sub-partitions as per list of "matched" partition filters to the specified list of not-available statuses.
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.
protected BusinessObjectDataAvailabilityCollectionResponse	checkBusinessObjectDataAvailabilityCollectionImpl(BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest) Performs an availability check for a collection of business object data.
protected BusinessObjectDataAvailability	checkBusinessObjectDataAvailabilityImpl(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.
protected BusinessObjectDataAvailability	checkBusinessObjectDataAvailabilityImpl(BusinessObjectDataAvailabilityRequest request, boolean skipRequestValidation) Performs a search and returns a list of business object data key values and relative statuses for a range of requested 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.
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.
protected BusinessObjectDataDdlCollectionResponse	generateBusinessObjectDataDdlCollectionImpl(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest) 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.
protected BusinessObjectDataDdl	generateBusinessObjectDataDdlImpl(BusinessObjectDataDdlRequest request, boolean skipRequestValidation) 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.
BusinessObjectData	getBusinessObjectData(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory) Retrieves existing business object data entry information.
protected BusinessObjectData	getBusinessObjectDataImpl(BusinessObjectDataKey businessObjectDataKey, String businessObjectFormatPartitionKey, String businessObjectDataStatus, Boolean includeBusinessObjectDataStatusHistory) 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.
protected BusinessObjectDataInvalidateUnregisteredResponse	invalidateUnregisteredBusinessObjectDataImpl(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest) Delegates implementation to BusinessObjectDataInvalidateUnregisteredHelper.
BusinessObjectData	restoreBusinessObjectData(BusinessObjectDataKey businessObjectDataKey) Initiates a restore request for a currently archived business object data.
protected BusinessObjectData	restoreBusinessObjectDataImpl(BusinessObjectDataKey businessObjectDataKey) 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.
protected BusinessObjectData	retryStoragePolicyTransitionImpl(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.
BusinessObjectDataSearchResult	searchBusinessObjectData(BusinessObjectDataSearchRequest request) Search business object data based on the request

Methods inherited from class java.lang.Object

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

Field Detail

REASON_NOT_REGISTERED

public static final String REASON_NOT_REGISTERED

A status reason of "not registered".

See Also:

Constant Field Values

REASON_NO_ENABLED_STORAGE_UNIT

public static final String REASON_NO_ENABLED_STORAGE_UNIT

A status reason of "no enabled storage unit".

See Also:

Constant Field Values

REASON_ARCHIVED

public static final String REASON_ARCHIVED

A status reason of "archived".

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDataServiceImpl

public BusinessObjectDataServiceImpl()

Method Detail

createBusinessObjectData

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

Description copied from interface: BusinessObjectDataService

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

Specified by:

createBusinessObjectData in interface BusinessObjectDataService

Parameters:

request - the business object data create request

Returns:

the newly created and persisted business object data.

getBusinessObjectData

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

Description copied from interface: BusinessObjectDataService

Retrieves existing business object data entry information. This method 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

Returns:

the retrieved business object data information

getBusinessObjectDataImpl

protected BusinessObjectData getBusinessObjectDataImpl(BusinessObjectDataKey businessObjectDataKey,
                                                       String businessObjectFormatPartitionKey,
                                                       String businessObjectDataStatus,
                                                       Boolean includeBusinessObjectDataStatusHistory)

Retrieves existing business object data entry information. This method does not start a new transaction and instead continues with existing transaction, if any.

Parameters:

businessObjectDataKey - the business object data key

businessObjectFormatPartitionKey - the business object format partition key, may be null

businessObjectDataStatus - the business object data status, may be null

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

Returns:

the retrieved business object data information

getBusinessObjectDataVersions

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

Description copied from interface: BusinessObjectDataService

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

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

deleteBusinessObjectData

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

Description copied from interface: BusinessObjectDataService

Deletes an existing business object data.

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

checkBusinessObjectDataAvailability

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

Description copied from interface: BusinessObjectDataService

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.

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)

Description copied from interface: BusinessObjectDataService

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

Specified by:

checkBusinessObjectDataAvailabilityCollection in interface BusinessObjectDataService

Parameters:

request - the business object data availability collection request

Returns:

the business object data availability information

checkBusinessObjectDataAvailabilityImpl

protected BusinessObjectDataAvailability checkBusinessObjectDataAvailabilityImpl(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.

Parameters:

request - the business object data availability request

Returns:

the business object data availability information

checkBusinessObjectDataAvailabilityImpl

protected BusinessObjectDataAvailability checkBusinessObjectDataAvailabilityImpl(BusinessObjectDataAvailabilityRequest request,
                                                                                 boolean skipRequestValidation)

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

Parameters:

request - the business object data availability request

skipRequestValidation - specifies whether to skip the request validation and trimming

Returns:

the business object data availability information

checkBusinessObjectDataAvailabilityCollectionImpl

protected BusinessObjectDataAvailabilityCollectionResponse checkBusinessObjectDataAvailabilityCollectionImpl(BusinessObjectDataAvailabilityCollectionRequest businessObjectDataAvailabilityCollectionRequest)

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

Parameters:

businessObjectDataAvailabilityCollectionRequest - the business object data availability collection requests

Returns:

the business object data availability information

generateBusinessObjectDataDdl

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

Description copied from interface: BusinessObjectDataService

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.

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)

Description copied from interface: BusinessObjectDataService

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.

Specified by:

generateBusinessObjectDataDdlCollection in interface BusinessObjectDataService

Parameters:

request - the business object data DDL collection request

Returns:

the business object data DDL information

generateBusinessObjectDataDdlImpl

protected BusinessObjectDataDdl generateBusinessObjectDataDdlImpl(BusinessObjectDataDdlRequest request,
                                                                  boolean skipRequestValidation)

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.

Parameters:

request - the business object data DDL request

skipRequestValidation - specifies whether to skip the request validation and trimming

Returns:

the business object data DDL information

generateBusinessObjectDataDdlCollectionImpl

protected BusinessObjectDataDdlCollectionResponse generateBusinessObjectDataDdlCollectionImpl(BusinessObjectDataDdlCollectionRequest businessObjectDataDdlCollectionRequest)

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.

Parameters:

businessObjectDataDdlCollectionRequest - the business object data DDL collection request

Returns:

the business object data DDL information

addNotAvailableBusinessObjectDataStatuses

protected void addNotAvailableBusinessObjectDataStatuses(List<BusinessObjectDataStatus> notAvailableStatuses,
                                                         BusinessObjectFormatKey businessObjectFormatKey,
                                                         List<List<String>> matchedAvailablePartitionFilters,
                                                         List<List<String>> availablePartitions,
                                                         List<String> storageNames)

Updates the list of not-available statuses by adding business object data status instances created from discovered "non-available" registered sub-partitions as per list of "matched" partition filters to the specified list of not-available statuses.

Parameters:

notAvailableStatuses - the list of not-available statuses to be updated

businessObjectFormatKey - the business object format key

matchedAvailablePartitionFilters - the list of "matched" partition filters

availablePartitions - the list of already discovered "available" partitions, where each partition consists of primary and optional sub-partition values

storageNames - the list of storage names

invalidateUnregisteredBusinessObjectData

@PublishJmsMessages
 @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.

Delegates implementation to BusinessObjectDataInvalidateUnregisteredHelper. Starts a new transaction. Meant for Activiti wrapper usage.

Specified by:

invalidateUnregisteredBusinessObjectData in interface BusinessObjectDataService

Parameters:

businessObjectDataInvalidateUnregisteredRequest - BusinessObjectDataInvalidateUnregisteredRequest

Returns:

BusinessObjectDataInvalidateUnregisteredResponse

invalidateUnregisteredBusinessObjectDataImpl

protected BusinessObjectDataInvalidateUnregisteredResponse invalidateUnregisteredBusinessObjectDataImpl(BusinessObjectDataInvalidateUnregisteredRequest businessObjectDataInvalidateUnregisteredRequest)

Delegates implementation to BusinessObjectDataInvalidateUnregisteredHelper. Keeps current transaction context.

Parameters:

businessObjectDataInvalidateUnregisteredRequest - BusinessObjectDataInvalidateUnregisteredRequest

Returns:

BusinessObjectDataInvalidateUnregisteredResponse

retryStoragePolicyTransition

@NamespacePermission(fields="#businessObjectDataKey.namespace",
                     permissions=WRITE)
 @Transactional(propagation=NOT_SUPPORTED)
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 executes non-transactionally, suspends the current transaction if one exists.

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

retryStoragePolicyTransitionImpl

protected BusinessObjectData retryStoragePolicyTransitionImpl(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.

Parameters:

businessObjectDataKey - the business object data key

request - the information needed to retry a storage policy transition

Returns:

the business object data information

restoreBusinessObjectData

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

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

Returns:

the business object data information

restoreBusinessObjectDataImpl

protected BusinessObjectData restoreBusinessObjectDataImpl(BusinessObjectDataKey businessObjectDataKey)

Initiates a restore request for a currently archived business object data. Keeps current transaction context.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the business object data information

searchBusinessObjectData

@NamespacePermission(fields="#request.businessObjectDataSearchFilters[0].BusinessObjectDataSearchKeys[0].namespace",
                     permissions=READ)
public BusinessObjectDataSearchResult searchBusinessObjectData(BusinessObjectDataSearchRequest request)

Search business object data based on the request

Specified by:

searchBusinessObjectData in interface BusinessObjectDataService

Parameters:

request - search request

Returns:

business data search result