org.finra.herd.service.impl

Class RelationalTableRegistrationHelperServiceImpl

java.lang.Object

org.finra.herd.service.impl.RelationalTableRegistrationHelperServiceImpl

All Implemented Interfaces:

RelationalTableRegistrationHelperService

@Service
 @Transactional(value="herdTransactionManager")
public class RelationalTableRegistrationHelperServiceImpl
extends Object
implements RelationalTableRegistrationHelperService

An implementation of the helper service class for the relational table registration service.

Constructor Summary

Constructors

Constructor and Description
RelationalTableRegistrationHelperServiceImpl()

Method Summary

Modifier and Type	Method and Description
RelationalStorageAttributesDto	prepareForRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Prepares for relational table registration by validating database entities per specified relational table registration create request.
RelationalTableRegistrationDto	prepareForRelationalTableSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey) Prepares for relational table schema update by validating database entities per specified storage unit key.
BusinessObjectData	registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, List<SchemaColumn> schemaColumns, Boolean appendToExistingBusinessObjectDefinition) Creates a new relational table registration.
List<SchemaColumn>	retrieveRelationalTableColumns(RelationalStorageAttributesDto relationalStorageAttributesDto, String relationalSchemaName, String relationalTableName) Retrieves a list of actual schema columns for the specified relational table.
BusinessObjectData	updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto, List<SchemaColumn> schemaColumns) Updates relational table schema for an already existing relational table registration.
void	validateAndTrimRelationalTableRegistrationCreateRequest(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest) Validates a relational table registration create request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationalTableRegistrationHelperServiceImpl

public RelationalTableRegistrationHelperServiceImpl()

Method Detail

prepareForRelationalTableRegistration

@Transactional(propagation=REQUIRES_NEW)
public RelationalStorageAttributesDto prepareForRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                                                                                                     Boolean appendToExistingBusinessObjectDefinition)

Description copied from interface: RelationalTableRegistrationHelperService

Prepares for relational table registration by validating database entities per specified relational table registration create request. This method returns storage attributes required to perform relation table registration.

Specified by:

prepareForRelationalTableRegistration in interface RelationalTableRegistrationHelperService

Parameters:

relationalTableRegistrationCreateRequest - the relational table registration create request

appendToExistingBusinessObjectDefinition - boolean flag that determines if the format should be appended to an existing business object definition

Returns:

the relational storage attributes DTO

prepareForRelationalTableSchemaUpdate

@Transactional(propagation=REQUIRES_NEW)
public RelationalTableRegistrationDto prepareForRelationalTableSchemaUpdate(BusinessObjectDataStorageUnitKey storageUnitKey)

Description copied from interface: RelationalTableRegistrationHelperService

Prepares for relational table schema update by validating database entities per specified storage unit key. This method returns a relational table registration DTO which contains attributes required to retrieve the current relation table schema.

Specified by:

prepareForRelationalTableSchemaUpdate in interface RelationalTableRegistrationHelperService

Parameters:

storageUnitKey - the storage unit key for the relational table registration

Returns:

the relational table registration DTO

registerRelationalTable

@PublishNotificationMessages
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectData registerRelationalTable(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                                                                                                         List<SchemaColumn> schemaColumns,
                                                                                                                         Boolean appendToExistingBusinessObjectDefinition)

Description copied from interface: RelationalTableRegistrationHelperService

Creates a new relational table registration. The relation table registration includes creation of the following entities:

• a business object definition
• a business object format with the specified schema columns
• a business object data
• a storage unit that links together the business object data with the storage specified in the create request

Specified by:

registerRelationalTable in interface RelationalTableRegistrationHelperService

Parameters:

relationalTableRegistrationCreateRequest - the relational table registration create request

appendToExistingBusinessObjectDefinition - boolean flag that determines if the format should be appended to an existing business object definition

Returns:

the information for the newly created business object data

retrieveRelationalTableColumns

@Transactional(propagation=NOT_SUPPORTED)
public List<SchemaColumn> retrieveRelationalTableColumns(RelationalStorageAttributesDto relationalStorageAttributesDto,
                                                                                                   String relationalSchemaName,
                                                                                                   String relationalTableName)

Description copied from interface: RelationalTableRegistrationHelperService

Retrieves a list of actual schema columns for the specified relational table. This method uses actual JDBC connection to retrieve a description of table columns.

Specified by:

retrieveRelationalTableColumns in interface RelationalTableRegistrationHelperService

Parameters:

relationalStorageAttributesDto - the relational storage attributes DTO

relationalSchemaName - the name of the relational database schema

relationalTableName - the name of the relational table

Returns:

the list of schema columns for the specified relational table

updateRelationalTableSchema

@PublishNotificationMessages
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectData updateRelationalTableSchema(RelationalTableRegistrationDto relationalTableRegistrationDto,
                                                                                                                             List<SchemaColumn> schemaColumns)

Description copied from interface: RelationalTableRegistrationHelperService

Updates relational table schema for an already existing relational table registration. The relation table schema update includes creation of the following entities:

• a new version of the business object format with updated schema as extracted from the specified relational table in the specified storage of RELATIONAL storage platform type
• a business object data that is associated with the new business object format version
• a storage unit that links together the newly created business object data with the storage

Specified by:

updateRelationalTableSchema in interface RelationalTableRegistrationHelperService

Parameters:

relationalTableRegistrationDto - the relational table registration DTO

schemaColumns - the new relational table schema

Returns:

the information for the business object data created for the updated relational table registration

validateAndTrimRelationalTableRegistrationCreateRequest

@Transactional(propagation=NOT_SUPPORTED)
public void validateAndTrimRelationalTableRegistrationCreateRequest(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest)

Description copied from interface: RelationalTableRegistrationHelperService

Validates a relational table registration create request. This method also trims the request parameters.

Specified by:

validateAndTrimRelationalTableRegistrationCreateRequest in interface RelationalTableRegistrationHelperService

Parameters:

relationalTableRegistrationCreateRequest - the relational table registration create request