Package org.cyclos.security.banking

Class VoucherServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.VoucherServiceSecurity

All Implemented Interfaces:

VoucherService, Service

@Security
public class VoucherServiceSecurity
extends BaseServiceSecurity
implements VoucherService

Security layer for VoucherService

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
VoucherServiceSecurity()

Method Summary

Modifier and Type	Method	Description
VoucherInfoVO	activateGiftVoucher(@NotNull String token, ActivateGiftVoucherDTO params)	Changes the voucher PIN using the voucher information page.
void	assign(@NotNull AssignVoucherDTO params)	Assigns an unassigned, open generated voucher to a user
SerializableInputStream	barcode(VoucherBarcodeParams params)	Returns a barcode image of the token of the given voucher
VoucherPackWithIdsVO	buy(BuyVouchersDTO params)	Buys one or more vouchers
void	cancel(CancelVoucherDTO params)	Cancels one or more vouchers
void	changeExpirationDate(ChangeVoucherExpirationDateDTO params)	Changes the voucher expiration date according to the given information.
void	changeInfoNotificationSettings(String token, String pin, SimpleChangeVoucherNotificationSettingsDTO settings)	Change the voucher notifications settings using the voucher information page.
void	changeInfoPin(@NotNull String token, SimpleChangeVoucherPinDTO changeVoucherPin)	Changes the voucher PIN using the voucher information page.
void	changeNotificationSettings(@NotNull ChangeVoucherNotificationSettingsDTO params)	Change the voucher notifications settings using the voucher information page.
void	changePin(ChangeVoucherPinDTO changeVoucherPin)	Changes the voucher PIN
protected void	doInitialize()
FileInfo	exportTransaction(@NotNull ExportFormatVO format, @NotNull VoucherTransactionVO transaction)	Generates a file with the voucher.
FileInfo	exportVoucher(@NotNull ExportFormatVO format, @NotNull VoucherVO voucher, boolean markAsPrinted)	Generates a file with the voucher.
FileInfo	exportVouchers(@NotNull ExportFormatVO format, @NotNull BasicVoucherQuery query, boolean markAsPrinted)	Generates a file with the query result.
List<VouchersSummaryVO>	generalSearchSummary(GeneralVoucherQuery params)	Returns the summary for a general vouchers search according to the given filters
VoucherPackWithIdsVO	generate(GenerateVouchersDTO params)	Generates vouchers
BuyVoucherData	getBuyData(CreateVoucherDataParams params)	Returns data used to buy a voucher
VoucherData	getData(Long id)	Returns data about a specific voucher
GeneralVouchersSearchData	getGeneralSearchData()	Returns data for a general vouchers search
GenerateVouchersData	getGenerateData(CreateVoucherDataParams params)	Returns data which is needed for generating vouchers
VoucherInfoVO	getInfo(@NotNull String token, String pin)	Returns information about a voucher which is accessible as guest.
VoucherInfoData	getInfoData()	Returns common data for displaying the voucher info application
RedeemVoucherData	getRedeemData(VoucherTransactionDataParams params)	Returns data used to redeem a voucher
InitialVoucherUserData	getRedeemInitialData(UserLocatorVO userVO)	Returns data for starting a voucher redeeming
BuyVoucherData	getSendData(CreateVoucherDataParams params)	Returns data used to send a voucher
TopUpVoucherData	getTopUpData(@NotNull VoucherTransactionDataParams params)	Returns data used to top-up a voucher
InitialVoucherUserData	getTopUpInitialData(UserLocatorVO userVO)	Returns data for starting a voucher top-up
VoucherTransactionData	getTransactionData(Long id)	Returns details of a voucher transaction
VoucherTransactionsSearchData	getUserTransactionsSearchData(UserLocatorVO vo)	Returns data for a searching redeemed vouchers of the given user
UserVouchersSearchData	getUserVouchersSearchData(UserLocatorVO vo)	Returns data for a searching vouchers of the given user
boolean	isVisible(VoucherPack voucherPack)
boolean	isVisible(VoucherVO vo)
VoucherVO	loadByToken(String token)	Returns a voucher by token
BuyVoucherPreviewVO	previewBuy(@NotNull BuyVouchersDTO params)	Previews a voucher buying
RedeemVoucherPreviewVO	previewRedeem(@NotNull RedeemVoucherDTO params)	Previews the redeeming of a voucher
BuyVoucherPreviewVO	previewSend(@NotNull SendVoucherDTO params)	Preview a voucher sending to an e-mail address
TopUpVoucherPreviewVO	previewTopUp(@NotNull TopUpVoucherDTO params)	Previews the top-up of a voucher
VoucherTransactionResultVO	redeem(RedeemVoucherDTO params)	Redeems a voucher, returning the generated voucher id
void	resendEmail(@NotNull VoucherVO voucherVO)	Re-sends the e-mail for a sent voucher
List<String>	resendPin(@NotNull String token, CaptchaResponseDTO captcha)	Re-send the voucher pin to the mediums (email/mobile phone) associated to the voucher (if any)
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<VoucherVO>	searchGeneral(GeneralVoucherQuery params)	Performs a general vouchers search according to the given filters
Page<VoucherTransactionVO>	searchInfoTransactions(@NotNull VoucherInfoTransactionsQuery params, String pin)	Searches for voucher transactions according to the given filters
Page<VoucherTransactionResultVO>	searchTransactions(@NotNull VoucherTransactionsQuery params)	Searches for voucher transactions according to the given filters
Page<VoucherVO>	searchUser(@NotNull UserVoucherQuery params)	Searches for user vouchers according to the given filters
VoucherPackWithIdsVO	send(@NotNull SendVoucherDTO params)	Sends a voucher to an e-mail address
VoucherTransactionResultVO	topUp(@NotNull TopUpVoucherDTO params)	Performs a top-up of a voucher.
void	unblock(@NotNull UnblockVoucherParams params)	Unblocks a voucher in the VoucherStatus.BLOCKED status
void	unblockPin(@NotNull VoucherVO voucherVO)	Manually unblocks a voucher PIN that was blocked by exceeding tries

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

VoucherServiceSecurity

public VoucherServiceSecurity()

Method Detail

activateGiftVoucher

public VoucherInfoVO activateGiftVoucher(@NotNull
                                         @NotNull String token,
                                         ActivateGiftVoucherDTO params)
                                  throws FrameworkException

Description copied from interface: VoucherService

Changes the voucher PIN using the voucher information page.

Specified by:

activateGiftVoucher in interface VoucherService

Throws:

FrameworkException

assign

public void assign(@NotNull
                   @NotNull AssignVoucherDTO params)
            throws FrameworkException

Description copied from interface: VoucherService

Assigns an unassigned, open generated voucher to a user

Specified by:

assign in interface VoucherService

Throws:

FrameworkException

barcode

public SerializableInputStream barcode(VoucherBarcodeParams params)
                                throws FrameworkException

Description copied from interface: VoucherService

Returns a barcode image of the token of the given voucher

Specified by:

barcode in interface VoucherService

Throws:

FrameworkException

buy

public VoucherPackWithIdsVO buy(BuyVouchersDTO params)
                         throws FrameworkException

Description copied from interface: VoucherService

Buys one or more vouchers

Specified by:

buy in interface VoucherService

Throws:

FrameworkException

cancel

public void cancel(CancelVoucherDTO params)
            throws FrameworkException

Description copied from interface: VoucherService

Cancels one or more vouchers

Specified by:

cancel in interface VoucherService

Throws:

FrameworkException

changeExpirationDate

public void changeExpirationDate(ChangeVoucherExpirationDateDTO params)
                          throws FrameworkException

Description copied from interface: VoucherService

Changes the voucher expiration date according to the given information.

Specified by:

changeExpirationDate in interface VoucherService

Throws:

FrameworkException

changeInfoNotificationSettings

public void changeInfoNotificationSettings(String token,
                                           String pin,
                                           SimpleChangeVoucherNotificationSettingsDTO settings)
                                    throws FrameworkException

Description copied from interface: VoucherService

Change the voucher notifications settings using the voucher information page.

Specified by:

changeInfoNotificationSettings in interface VoucherService

Throws:

FrameworkException

changeInfoPin

public void changeInfoPin(@NotNull
                          @NotNull String token,
                          SimpleChangeVoucherPinDTO changeVoucherPin)
                   throws FrameworkException

Description copied from interface: VoucherService

Changes the voucher PIN using the voucher information page.

Specified by:

changeInfoPin in interface VoucherService

Throws:

FrameworkException

changeNotificationSettings

public void changeNotificationSettings(@NotNull
                                       @NotNull ChangeVoucherNotificationSettingsDTO params)
                                throws FrameworkException

Description copied from interface: VoucherService

Change the voucher notifications settings using the voucher information page.

Specified by:

changeNotificationSettings in interface VoucherService

Throws:

FrameworkException

changePin

public void changePin(ChangeVoucherPinDTO changeVoucherPin)
               throws FrameworkException

Description copied from interface: VoucherService

Changes the voucher PIN

Specified by:

changePin in interface VoucherService

Throws:

FrameworkException

exportTransaction

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

Description copied from interface: VoucherService

Generates a file with the voucher.

Specified by:

exportTransaction in interface VoucherService

Throws:

FrameworkException

exportVoucher

public FileInfo exportVoucher(@NotNull
                              @NotNull ExportFormatVO format,
                              @NotNull
                              @NotNull VoucherVO voucher,
                              boolean markAsPrinted)
                       throws FrameworkException

Description copied from interface: VoucherService

Generates a file with the voucher. This operation is read/write because it can update the voucher printed flag.

Specified by:

exportVoucher in interface VoucherService

Throws:

FrameworkException

exportVouchers

public FileInfo exportVouchers(@NotNull
                               @NotNull ExportFormatVO format,
                               @NotNull
                               @NotNull BasicVoucherQuery query,
                               boolean markAsPrinted)
                        throws FrameworkException

Description copied from interface: VoucherService

Generates a file with the query result. This operation is read/write because it can update the each voucher printed flag.

Specified by:

exportVouchers in interface VoucherService

Throws:

FrameworkException

generalSearchSummary

public List<VouchersSummaryVO> generalSearchSummary(GeneralVoucherQuery params)
                                             throws FrameworkException

Description copied from interface: VoucherService

Returns the summary for a general vouchers search according to the given filters

Specified by:

generalSearchSummary in interface VoucherService

Throws:

FrameworkException

generate

public VoucherPackWithIdsVO generate(GenerateVouchersDTO params)
                              throws FrameworkException

Description copied from interface: VoucherService

Generates vouchers

Specified by:

generate in interface VoucherService

Throws:

FrameworkException

getBuyData

public BuyVoucherData getBuyData(CreateVoucherDataParams params)
                          throws FrameworkException

Description copied from interface: VoucherService

Returns data used to buy a voucher

Specified by:

getBuyData in interface VoucherService

Throws:

FrameworkException

getData

public VoucherData getData(Long id)
                    throws FrameworkException

Description copied from interface: VoucherService

Returns data about a specific voucher

Specified by:

getData in interface VoucherService

Throws:

FrameworkException

getGeneralSearchData

public GeneralVouchersSearchData getGeneralSearchData()
                                               throws FrameworkException

Description copied from interface: VoucherService

Returns data for a general vouchers search

Specified by:

getGeneralSearchData in interface VoucherService

Throws:

FrameworkException

getGenerateData

public GenerateVouchersData getGenerateData(CreateVoucherDataParams params)
                                     throws FrameworkException

Description copied from interface: VoucherService

Returns data which is needed for generating vouchers

Specified by:

getGenerateData in interface VoucherService

Throws:

FrameworkException

getInfo

public VoucherInfoVO getInfo(@NotNull
                             @NotNull String token,
                             String pin)
                      throws FrameworkException

Description copied from interface: VoucherService

Returns information about a voucher which is accessible as guest. If a PIN is required, the object will be returned only with the token (echoing the input token) and the pinInput field.

Specified by:

getInfo in interface VoucherService

Throws:

FrameworkException

getInfoData

public VoucherInfoData getInfoData()
                            throws FrameworkException

Description copied from interface: VoucherService

Returns common data for displaying the voucher info application

Specified by:

getInfoData in interface VoucherService

Throws:

FrameworkException

getRedeemData

public RedeemVoucherData getRedeemData(VoucherTransactionDataParams params)
                                throws FrameworkException

Description copied from interface: VoucherService

Returns data used to redeem a voucher

Specified by:

getRedeemData in interface VoucherService

Throws:

FrameworkException

See Also:

VoucherService.redeem(RedeemVoucherDTO)

getRedeemInitialData

public InitialVoucherUserData getRedeemInitialData(UserLocatorVO userVO)
                                            throws FrameworkException

Description copied from interface: VoucherService

Returns data for starting a voucher redeeming

Specified by:

getRedeemInitialData in interface VoucherService

Throws:

FrameworkException

getSendData

public BuyVoucherData getSendData(CreateVoucherDataParams params)
                           throws FrameworkException

Description copied from interface: VoucherService

Returns data used to send a voucher

Specified by:

getSendData in interface VoucherService

Throws:

FrameworkException

getTopUpData

public TopUpVoucherData getTopUpData(@NotNull
                                     @NotNull VoucherTransactionDataParams params)
                              throws FrameworkException,
                                     VoucherTopUpException

Description copied from interface: VoucherService

Returns data used to top-up a voucher

Specified by:

getTopUpData in interface VoucherService

Throws:

FrameworkException

VoucherTopUpException

See Also:

VoucherService.topUp(TopUpVoucherDTO)

getTopUpInitialData

public InitialVoucherUserData getTopUpInitialData(UserLocatorVO userVO)
                                           throws FrameworkException

Description copied from interface: VoucherService

Returns data for starting a voucher top-up

Specified by:

getTopUpInitialData in interface VoucherService

Throws:

FrameworkException

getTransactionData

public VoucherTransactionData getTransactionData(Long id)
                                          throws FrameworkException

Description copied from interface: VoucherService

Returns details of a voucher transaction

Specified by:

getTransactionData in interface VoucherService

Throws:

FrameworkException

getUserTransactionsSearchData

public VoucherTransactionsSearchData getUserTransactionsSearchData(UserLocatorVO vo)
                                                            throws FrameworkException

Description copied from interface: VoucherService

Returns data for a searching redeemed vouchers of the given user

Specified by:

getUserTransactionsSearchData in interface VoucherService

Throws:

FrameworkException

getUserVouchersSearchData

public UserVouchersSearchData getUserVouchersSearchData(UserLocatorVO vo)
                                                 throws FrameworkException

Description copied from interface: VoucherService

Returns data for a searching vouchers of the given user

Specified by:

getUserVouchersSearchData in interface VoucherService

Throws:

FrameworkException

isVisible

public boolean isVisible(VoucherPack voucherPack)

isVisible

public boolean isVisible(VoucherVO vo)

loadByToken

public VoucherVO loadByToken(String token)
                      throws FrameworkException

Description copied from interface: VoucherService

Returns a voucher by token

Specified by:

loadByToken in interface VoucherService

Throws:

FrameworkException

previewBuy

public BuyVoucherPreviewVO previewBuy(@NotNull
                                      @NotNull BuyVouchersDTO params)
                               throws FrameworkException,
                                      VoucherBuyingException,
                                      MaxTotalOpenAmountException,
                                      TransferException

Description copied from interface: VoucherService

Previews a voucher buying

Specified by:

previewBuy in interface VoucherService

Throws:

FrameworkException

VoucherBuyingException

MaxTotalOpenAmountException

TransferException

See Also:

VoucherService.buy(BuyVouchersDTO)

previewRedeem

public RedeemVoucherPreviewVO previewRedeem(@NotNull
                                            @NotNull RedeemVoucherDTO params)
                                     throws FrameworkException,
                                            VoucherRedeemingException

Description copied from interface: VoucherService

Previews the redeeming of a voucher

Specified by:

previewRedeem in interface VoucherService

Throws:

FrameworkException

VoucherRedeemingException

previewSend

public BuyVoucherPreviewVO previewSend(@NotNull
                                       @NotNull SendVoucherDTO params)
                                throws FrameworkException,
                                       VoucherBuyingException,
                                       MaxTotalOpenAmountException,
                                       TransferException

Description copied from interface: VoucherService

Preview a voucher sending to an e-mail address

Specified by:

previewSend in interface VoucherService

Throws:

FrameworkException

VoucherBuyingException

MaxTotalOpenAmountException

TransferException

See Also:

VoucherService.send(SendVoucherDTO)

previewTopUp

public TopUpVoucherPreviewVO previewTopUp(@NotNull
                                          @NotNull TopUpVoucherDTO params)
                                   throws FrameworkException,
                                          VoucherTopUpException

Description copied from interface: VoucherService

Previews the top-up of a voucher

Specified by:

previewTopUp in interface VoucherService

Throws:

FrameworkException

VoucherTopUpException

redeem

public VoucherTransactionResultVO redeem(RedeemVoucherDTO params)
                                  throws FrameworkException

Description copied from interface: VoucherService

Redeems a voucher, returning the generated voucher id

Specified by:

redeem in interface VoucherService

Throws:

FrameworkException

resendEmail

public void resendEmail(@NotNull
                        @NotNull VoucherVO voucherVO)
                 throws FrameworkException

Description copied from interface: VoucherService

Re-sends the e-mail for a sent voucher

Specified by:

resendEmail in interface VoucherService

Throws:

FrameworkException

resendPin

public List<String> resendPin(@NotNull
                              @NotNull String token,
                              CaptchaResponseDTO captcha)
                       throws FrameworkException

Description copied from interface: VoucherService

Re-send the voucher pin to the mediums (email/mobile phone) associated to the voucher (if any)

Specified by:

resendPin in interface VoucherService

Throws:

FrameworkException

searchGeneral

public Page<VoucherVO> searchGeneral(GeneralVoucherQuery params)
                              throws FrameworkException

Description copied from interface: VoucherService

Performs a general vouchers search according to the given filters

Specified by:

searchGeneral in interface VoucherService

Throws:

FrameworkException

searchInfoTransactions

public Page<VoucherTransactionVO> searchInfoTransactions(@NotNull
                                                         @NotNull VoucherInfoTransactionsQuery params,
                                                         String pin)
                                                  throws FrameworkException

Description copied from interface: VoucherService

Searches for voucher transactions according to the given filters

Specified by:

searchInfoTransactions in interface VoucherService

Throws:

FrameworkException

searchTransactions

public Page<VoucherTransactionResultVO> searchTransactions(@NotNull
                                                           @NotNull VoucherTransactionsQuery params)
                                                    throws FrameworkException

Description copied from interface: VoucherService

Searches for voucher transactions according to the given filters

Specified by:

searchTransactions in interface VoucherService

Throws:

FrameworkException

searchUser

public Page<VoucherVO> searchUser(@NotNull
                                  @NotNull UserVoucherQuery params)
                           throws FrameworkException

Description copied from interface: VoucherService

Searches for user vouchers according to the given filters

Specified by:

searchUser in interface VoucherService

Throws:

FrameworkException

send

public VoucherPackWithIdsVO send(@NotNull
                                 @NotNull SendVoucherDTO params)
                          throws FrameworkException,
                                 VoucherBuyingException,
                                 MaxTotalOpenAmountException,
                                 TransferException

Description copied from interface: VoucherService

Sends a voucher to an e-mail address

Specified by:

send in interface VoucherService

Throws:

BuyingNotAllowedForUserException - When the user is not in a group allowed to buy this type

BuyingMaxOpenAmountException - When the max open amount for the given user is exceeded

MaxTotalOpenAmountException - When the total amount of all open vouchers of this type would be exceeded

TransferException - When there is an error on the payment

FrameworkException

VoucherBuyingException

topUp

public VoucherTransactionResultVO topUp(@NotNull
                                        @NotNull TopUpVoucherDTO params)
                                 throws FrameworkException,
                                        TransferException

Description copied from interface: VoucherService

Performs a top-up of a voucher. If the voucher is inactive, activates it.

Specified by:

topUp in interface VoucherService

Throws:

TransferException - When there was a problem when performing the top-up payment

FrameworkException

unblock

public void unblock(@NotNull
                    @NotNull UnblockVoucherParams params)
             throws FrameworkException,
                    VoucherTopUpException

Description copied from interface: VoucherService

Unblocks a voucher in the VoucherStatus.BLOCKED status

Specified by:

unblock in interface VoucherService

Throws:

FrameworkException

VoucherTopUpException

unblockPin

public void unblockPin(@NotNull
                       @NotNull VoucherVO voucherVO)
                throws FrameworkException

Description copied from interface: VoucherService

Manually unblocks a voucher PIN that was blocked by exceeding tries

Specified by:

unblockPin in interface VoucherService

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