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
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.
FileInfo	exportVoucher(@NotNull ExportFormatVO format, @NotNull VoucherVO voucher, boolean markAsPrinted)	Generates a file with the voucher.
FileInfo	exportVouchers(@NotNull ExportFormatVO format, @NotNull VoucherQuery query, boolean markAsPrinted)	Generates a file with the query result.
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
GenerateVouchersData	getGenerateData(CreateVoucherDataParams params)	Returns data which is needed for generating vouchers
RedeemVoucherData	getRedeemData(RedeemVoucherDataParams params)	Returns data used to redeem a voucher
InitialRedeemVoucherData	getRedeemInitialData(UserLocatorVO userVO)	Returns data for starting a voucher redeeming
VouchersSearchData	getSearchData(VoucherSearchContext context, UserLocatorVO locator)	Returns data for searching vouchers, either over a user or for a general search
List<VoucherTypeDetailedVO>	listTypesForBuy(UserLocatorVO forUserVO)	Returns the voucher types the logged user can buy vouchers to the given user (defaults to the logged user himself)
VoucherVO	loadByToken(String token)	Returns a voucher by token
RedeemVoucherResult	redeem(RedeemVoucherDTO params)	Redeems a voucher, returning the generated voucher id
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<VoucherVO>	search(VoucherQuery params)	Searches for vouchers according to the given filters
VouchersResultsWithSummaryVO	searchWithSummary(VoucherQuery params)	Searches for vouchers according to the given filters, also returning summaries per status

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, 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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, 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

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

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 VoucherQuery 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

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

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

getRedeemData

public RedeemVoucherData getRedeemData(RedeemVoucherDataParams 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 InitialRedeemVoucherData 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

getSearchData

public VouchersSearchData getSearchData(VoucherSearchContext context,
                                        UserLocatorVO locator)
                                 throws FrameworkException

Description copied from interface: VoucherService

Returns data for searching vouchers, either over a user or for a general search

Specified by:

getSearchData in interface VoucherService

Throws:

FrameworkException

listTypesForBuy

public List<VoucherTypeDetailedVO> listTypesForBuy(UserLocatorVO forUserVO)
                                            throws FrameworkException

Description copied from interface: VoucherService

Returns the voucher types the logged user can buy vouchers to the given user (defaults to the logged user himself)

Specified by:

listTypesForBuy in interface VoucherService

Throws:

FrameworkException

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

redeem

public RedeemVoucherResult 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

search

public Page<VoucherVO> search(VoucherQuery params)
                       throws FrameworkException

Description copied from interface: VoucherService

Searches for vouchers according to the given filters

Specified by:

search in interface VoucherService

Throws:

FrameworkException

searchWithSummary

public VouchersResultsWithSummaryVO searchWithSummary(VoucherQuery params)
                                               throws FrameworkException

Description copied from interface: VoucherService

Searches for vouchers according to the given filters, also returning summaries per status

Specified by:

searchWithSummary in interface VoucherService

Throws:

FrameworkException

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