Package org.cyclos.security.banking

Class TransactionServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.TransactionServiceSecurity

All Implemented Interfaces:

TransactionService, Service

@Security
public class TransactionServiceSecurity
extends BaseServiceSecurity
implements TransactionService

Security layer for TransactionService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
TransactionServiceSecurity()

Method Summary

Modifier and Type	Method	Description
void	checkBaseTransactionQuery(BaseTransactionQuery query)
PaymentTransferType	checkPerform(CalculateInstallmentsDTO params)
PaymentTransferType	checkPerform(PerformInternalTransactionDTO params)
void	checkQuery(BaseTransactionQuery query)	Makes sure that if some authorization status is set, the user has permission to view authorized (returning if true), and check and filter accessible accounts
PaymentTransferType	checkReceive(CalculateInstallmentsDTO parameters)
PaymentTransferType	checkReceive(PerformInternalTransactionDTO parameters)
DeviceConfirmationVO	createDeviceConfirmationForReceive(@NotNull PerformInternalTransactionDTO parameters)	Creates a new pending for approval device confirmation for the payer.
SerializableInputStream	deviceConfirmationBarcodeForReceive(InternalAccountOwner payer, DeviceConfirmationBarcodeParams params)	Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected for the given payer.
protected void	doInitialize()
FileInfo	exportInstallments(@NotNull ExportFormatVO format, @NotNull InstallmentQuery query)	Exports a installments search results to file
FileInfo	exportInstallmentsOverview(@NotNull ExportFormatVO format, @NotNull InstallmentOverviewQuery query)	Exports an installments overview search results to file
FileInfo	exportOverview(@NotNull ExportFormatVO format, @NotNull TransactionOverviewQuery query)	Exports a transaction overview search results to file
FileInfo	exportTransaction(@NotNull ExportFormatVO format, @NotNull TransactionVO transaction)	Exports the details of a given transaction to file
FileInfo	exportTransactions(@NotNull ExportFormatVO format, @NotNull TransactionQuery query)	Exports a transactions search results to file
TransactionData	getData(TransactionVO vo)	Returns data for a transaction
InstallmentOverviewSearchData	getInstallmentsOverviewSearchData()	Returns data for searching installments overview
InstallmentSearchData	getInstallmentsSearchData(InternalAccountOwner owner)	Returns data for searching installments from an account owner perspective
Page<MaturityTableItemData>	getMaturityTable(MaturityTableQuery query)	returns the maturity table which the user can view in case of paying with a zero d-rate of an earlier account state, when MaturityPolicy.HISTORY is valid.
TransactionOverviewSearchData	getOverviewSearchData(boolean pendingMyAuthorization)	Returns data used to search for transaction overview
PerformPaymentData	getPaymentData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO paymentType)	Returns data used to prepare a payment matching the given from / to account owners.
PerformPaymentToOwnerData	getPaymentToOwnerData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO transferType)	Returns simplified data used to prepare a payment matching the given arguments
PerformPaymentTypeData	getPaymentTypeData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO transferTypeVO)	Returns the data related to a payment type for a payment
ReceivePaymentData	getReceivePaymentData()	Returns data used to receive a payment
ReceivePaymentFromUserData	getReceivePaymentFromUserData(UserLocatorVO locator, TransferTypeVO paymentType)	Returns data used to receive a payment from a specific user.
PerformPaymentTypeData	getReceivePaymentTypeData(UserLocatorVO locator, TransferTypeVO transferTypeVO)	Returns the data related to a payment type for receiving a payment from a specific user and payment type
TransactionSearchData	getSearchData(InternalAccountOwner owner)	Returns data used to search for transactions for the given owner
boolean	isAccessible(Transaction transaction)
TransactionVO	load(Long id)	Loads a transaction details by id, returning a proper detailed implementation (for example, PaymentVO or ScheduledPaymentVO).
TransactionVO	loadByTransactionNumber(String transactionNumber)	Returns a transfer by transaction number, or throws EntityNotFoundException if not found
<D extends TransactionData> D	postProcess(Transaction transaction, D data)	This method must be invoked by the service security of each TransactionNature
TransferVO	processInstallment(InstallmentActionDTO action)	Settles an installment.
void	removeDeviceConfirmationForReceive(String deviceConfirmationId, @NotNull PerformInternalTransactionDTO parameters)	Removes a confirmation for the payer.
void	requestNewOTPForReceive(PerformInternalTransactionDTO parameters, SendMedium medium)	Generates a new OTP (removing any previous password, if any) and sends it to the payer by the specified medium using the confirmation password type for the BuiltInChannel.POS channel for the specified payer. It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<TransactionResultVO>	search(TransactionQuery query)	Searches for transactions from the point-of-view of a given account owner, according to the given query
Page<InstallmentResultVO>	searchInstallments(InstallmentQuery query)	Searches for installments from an account owner perspective, according to the given query
Page<InstallmentResultVO>	searchInstallmentsOverview(InstallmentOverviewQuery query)	Searches for installments overview, according to the given query
Page<TransactionResultVO>	searchOverview(TransactionOverviewQuery query)	Searches for transactions, according to the given query
void	settleInstallment(InstallmentActionDTO action)	Settles an installment.
DeviceConfirmationVO	viewDeviceConfirmationForReceive(String deviceConfirmationId, @NotNull PerformInternalTransactionDTO parameters)	Loads the details of a confirmation belonging to the payment payer.

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionServiceSecurity

public TransactionServiceSecurity()

Method Detail

checkBaseTransactionQuery

public void checkBaseTransactionQuery(BaseTransactionQuery query)

checkPerform

public PaymentTransferType checkPerform(CalculateInstallmentsDTO params)

checkPerform

public PaymentTransferType checkPerform(PerformInternalTransactionDTO params)

checkQuery

public void checkQuery(BaseTransactionQuery query)

Makes sure that if some authorization status is set, the user has permission to view authorized (returning if true), and check and filter accessible accounts

checkReceive

public PaymentTransferType checkReceive(CalculateInstallmentsDTO parameters)

checkReceive

public PaymentTransferType checkReceive(PerformInternalTransactionDTO parameters)

createDeviceConfirmationForReceive

public DeviceConfirmationVO createDeviceConfirmationForReceive(@NotNull
                                                               @NotNull PerformInternalTransactionDTO parameters)
                                                        throws FrameworkException

Description copied from interface: TransactionService

Creates a new pending for approval device confirmation for the payer. It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.

Specified by:

createDeviceConfirmationForReceive in interface TransactionService

Throws:

FrameworkException

deviceConfirmationBarcodeForReceive

public SerializableInputStream deviceConfirmationBarcodeForReceive(InternalAccountOwner payer,
                                                                   DeviceConfirmationBarcodeParams params)
                                                            throws FrameworkException

Description copied from interface: TransactionService

Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected for the given payer. The logged use must be allowed to locate for receive the payer.

Specified by:

deviceConfirmationBarcodeForReceive in interface TransactionService

Throws:

FrameworkException

exportInstallments

public FileInfo exportInstallments(@NotNull
                                   @NotNull ExportFormatVO format,
                                   @NotNull
                                   @NotNull InstallmentQuery query)

Description copied from interface: TransactionService

Exports a installments search results to file

Specified by:

exportInstallments in interface TransactionService

exportInstallmentsOverview

public FileInfo exportInstallmentsOverview(@NotNull
                                           @NotNull ExportFormatVO format,
                                           @NotNull
                                           @NotNull InstallmentOverviewQuery query)

Description copied from interface: TransactionService

Exports an installments overview search results to file

Specified by:

exportInstallmentsOverview in interface TransactionService

exportOverview

public FileInfo exportOverview(@NotNull
                               @NotNull ExportFormatVO format,
                               @NotNull
                               @NotNull TransactionOverviewQuery query)

Description copied from interface: TransactionService

Exports a transaction overview search results to file

Specified by:

exportOverview in interface TransactionService

exportTransaction

public FileInfo exportTransaction(@NotNull
                                  @NotNull ExportFormatVO format,
                                  @NotNull
                                  @NotNull TransactionVO transaction)
                           throws FrameworkException

Description copied from interface: TransactionService

Exports the details of a given transaction to file

Specified by:

exportTransaction in interface TransactionService

Throws:

FrameworkException

exportTransactions

public FileInfo exportTransactions(@NotNull
                                   @NotNull ExportFormatVO format,
                                   @NotNull
                                   @NotNull TransactionQuery query)

Description copied from interface: TransactionService

Exports a transactions search results to file

Specified by:

exportTransactions in interface TransactionService

getData

public TransactionData getData(TransactionVO vo)
                        throws FrameworkException

Description copied from interface: TransactionService

Returns data for a transaction

Specified by:

getData in interface TransactionService

Throws:

FrameworkException

getInstallmentsOverviewSearchData

public InstallmentOverviewSearchData getInstallmentsOverviewSearchData()
                                                                throws FrameworkException

Description copied from interface: TransactionService

Returns data for searching installments overview

Specified by:

getInstallmentsOverviewSearchData in interface TransactionService

Throws:

FrameworkException

getInstallmentsSearchData

public InstallmentSearchData getInstallmentsSearchData(InternalAccountOwner owner)
                                                throws FrameworkException

Description copied from interface: TransactionService

Returns data for searching installments from an account owner perspective

Specified by:

getInstallmentsSearchData in interface TransactionService

Throws:

FrameworkException

getMaturityTable

public Page<MaturityTableItemData> getMaturityTable(MaturityTableQuery query)

Description copied from interface: TransactionService

returns the maturity table which the user can view in case of paying with a zero d-rate of an earlier account state, when MaturityPolicy.HISTORY is valid.

Specified by:

getMaturityTable in interface TransactionService

getOverviewSearchData

public TransactionOverviewSearchData getOverviewSearchData(boolean pendingMyAuthorization)
                                                    throws FrameworkException

Description copied from interface: TransactionService

Returns data used to search for transaction overview

Specified by:

getOverviewSearchData in interface TransactionService

Throws:

FrameworkException

getPaymentData

public PerformPaymentData getPaymentData(InternalAccountOwner from,
                                         InternalAccountOwner to,
                                         TransferTypeVO paymentType)
                                  throws FrameworkException

Description copied from interface: TransactionService

Returns data used to prepare a payment matching the given from / to account owners. The given payment type is optional. If not passed in, will return detailed data for the first available payment type. If passed in, will return detailed data for that payment type, and must be valid.

Specified by:

getPaymentData in interface TransactionService

Throws:

FrameworkException

getPaymentToOwnerData

public PerformPaymentToOwnerData getPaymentToOwnerData(InternalAccountOwner from,
                                                       InternalAccountOwner to,
                                                       TransferTypeVO transferType)
                                                throws FrameworkException

Description copied from interface: TransactionService

Returns simplified data used to prepare a payment matching the given arguments

Specified by:

getPaymentToOwnerData in interface TransactionService

Throws:

FrameworkException

getPaymentTypeData

public PerformPaymentTypeData getPaymentTypeData(InternalAccountOwner from,
                                                 InternalAccountOwner to,
                                                 TransferTypeVO transferTypeVO)
                                          throws FrameworkException

Description copied from interface: TransactionService

Returns the data related to a payment type for a payment

Specified by:

getPaymentTypeData in interface TransactionService

Throws:

FrameworkException

getReceivePaymentData

public ReceivePaymentData getReceivePaymentData()
                                         throws FrameworkException

Description copied from interface: TransactionService

Returns data used to receive a payment

Specified by:

getReceivePaymentData in interface TransactionService

Throws:

FrameworkException

getReceivePaymentFromUserData

public ReceivePaymentFromUserData getReceivePaymentFromUserData(UserLocatorVO locator,
                                                                TransferTypeVO paymentType)
                                                         throws FrameworkException

Description copied from interface: TransactionService

Returns data used to receive a payment from a specific user. The given payment type is optional. If not passed in, will return detailed data for the first available payment type. If passed in, will return detailed data for that payment type, and must be valid.

Specified by:

getReceivePaymentFromUserData in interface TransactionService

Throws:

FrameworkException

getReceivePaymentTypeData

public PerformPaymentTypeData getReceivePaymentTypeData(UserLocatorVO locator,
                                                        TransferTypeVO transferTypeVO)
                                                 throws FrameworkException

Description copied from interface: TransactionService

Returns the data related to a payment type for receiving a payment from a specific user and payment type

Specified by:

getReceivePaymentTypeData in interface TransactionService

Throws:

FrameworkException

getSearchData

public TransactionSearchData getSearchData(InternalAccountOwner owner)
                                    throws FrameworkException

Description copied from interface: TransactionService

Returns data used to search for transactions for the given owner

Specified by:

getSearchData in interface TransactionService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(Transaction transaction)

load

public TransactionVO load(Long id)
                   throws FrameworkException

Description copied from interface: TransactionService

Loads a transaction details by id, returning a proper detailed implementation (for example, PaymentVO or ScheduledPaymentVO).

Specified by:

load in interface TransactionService

Throws:

FrameworkException

loadByTransactionNumber

public TransactionVO loadByTransactionNumber(String transactionNumber)
                                      throws FrameworkException

Description copied from interface: TransactionService

Returns a transfer by transaction number, or throws EntityNotFoundException if not found

Specified by:

loadByTransactionNumber in interface TransactionService

Throws:

FrameworkException

postProcess

public <D extends TransactionData> D postProcess(Transaction transaction,
                                                 D data)

This method must be invoked by the service security of each TransactionNature

processInstallment

public TransferVO processInstallment(InstallmentActionDTO action)
                              throws FrameworkException

Description copied from interface: TransactionService

Settles an installment. Currently only scheduled payment installments can be settled.

Specified by:

processInstallment in interface TransactionService

Throws:

FrameworkException

removeDeviceConfirmationForReceive

public void removeDeviceConfirmationForReceive(String deviceConfirmationId,
                                               @NotNull
                                               @NotNull PerformInternalTransactionDTO parameters)
                                        throws FrameworkException

Description copied from interface: TransactionService

Removes a confirmation for the payer. It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.

Specified by:

removeDeviceConfirmationForReceive in interface TransactionService

Throws:

FrameworkException

requestNewOTPForReceive

public void requestNewOTPForReceive(PerformInternalTransactionDTO parameters,
                                    SendMedium medium)
                             throws FrameworkException,
                                    SmsSendingException

Description copied from interface: TransactionService

Generates a new OTP (removing any previous password, if any) and sends it to the payer by the specified medium using the confirmation password type for the BuiltInChannel.POS channel for the specified payer.
It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.

Specified by:

requestNewOTPForReceive in interface TransactionService

Parameters:

parameters - the payment to be received.

medium - the medium used to send the OTP.

Throws:

SmsSendingException - only if medium is SendMedium.SMS and the OTP could not be sent to any enabled for sms phone.

FrameworkException

search

public Page<TransactionResultVO> search(TransactionQuery query)
                                 throws FrameworkException

Description copied from interface: TransactionService

Searches for transactions from the point-of-view of a given account owner, according to the given query

Specified by:

search in interface TransactionService

Throws:

FrameworkException

searchInstallments

public Page<InstallmentResultVO> searchInstallments(InstallmentQuery query)
                                             throws FrameworkException

Description copied from interface: TransactionService

Searches for installments from an account owner perspective, according to the given query

Specified by:

searchInstallments in interface TransactionService

Throws:

FrameworkException

searchInstallmentsOverview

public Page<InstallmentResultVO> searchInstallmentsOverview(InstallmentOverviewQuery query)
                                                     throws FrameworkException

Description copied from interface: TransactionService

Searches for installments overview, according to the given query

Specified by:

searchInstallmentsOverview in interface TransactionService

Throws:

FrameworkException

searchOverview

public Page<TransactionResultVO> searchOverview(TransactionOverviewQuery query)
                                         throws FrameworkException

Description copied from interface: TransactionService

Searches for transactions, according to the given query

Specified by:

searchOverview in interface TransactionService

Throws:

FrameworkException

settleInstallment

public void settleInstallment(InstallmentActionDTO action)
                       throws FrameworkException

Description copied from interface: TransactionService

Settles an installment. Currently only scheduled payment installments can be settled.

Specified by:

settleInstallment in interface TransactionService

Throws:

FrameworkException

viewDeviceConfirmationForReceive

public DeviceConfirmationVO viewDeviceConfirmationForReceive(String deviceConfirmationId,
                                                             @NotNull
                                                             @NotNull PerformInternalTransactionDTO parameters)
                                                      throws FrameworkException

Description copied from interface: TransactionService

Loads the details of a confirmation belonging to the payment payer. It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.

Specified by:

viewDeviceConfirmationForReceive in interface TransactionService

Throws:

FrameworkException

doInitialize

protected void doInitialize()

Overrides:

doInitialize in class BaseServiceSecurity

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity