Package org.cyclos.security.banking

Class EasyInvoiceServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.EasyInvoiceServiceSecurity

All Implemented Interfaces:

EasyInvoiceService, Service

@Security
public class EasyInvoiceServiceSecurity
extends BaseServiceSecurity
implements EasyInvoiceService

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

Method Summary

Modifier and Type	Method	Description
SerializableInputStream	barcode(EasyInvoiceBarcodeParams params)	Generates a QR-Code image for the given PerformPaymentDTO
EasyInvoiceData	getEasyInvoiceData(PerformPaymentDTO params)	Returns data for an easy invoice after logging in.
PaymentVO	perform(@NotNull PerformPaymentDTO parameters)	Same as PaymentService.perform(PerformPaymentDTO) but through the BuiltInChannel.EASY_INVOICE channel
PrepareEasyInvoiceData	prepareEasyInvoice(PrepareEasyInvoiceParams params)	Returns data for displaying details of an easy invoice while still as guest.
PaymentPreviewVO	preview(@NotNull PerformPaymentDTO parameters)	Previews a payment to be performed
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	validate(@NotNull PerformPaymentDTO parameters)	Validates the parameters to perform a payment without actually performing the payment.

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

EasyInvoiceServiceSecurity

public EasyInvoiceServiceSecurity()

Method Detail

barcode

public SerializableInputStream barcode(EasyInvoiceBarcodeParams params)
                                throws FrameworkException

Description copied from interface: EasyInvoiceService

Generates a QR-Code image for the given PerformPaymentDTO

Specified by:

barcode in interface EasyInvoiceService

Throws:

FrameworkException

getEasyInvoiceData

public EasyInvoiceData getEasyInvoiceData(PerformPaymentDTO params)
                                   throws FrameworkException

Description copied from interface: EasyInvoiceService

Returns data for an easy invoice after logging in. Minimally, a owner user is required. The amount either is not specified or a currency must be resolved, in the same way as EasyInvoiceService.prepareEasyInvoice(PrepareEasyInvoiceParams) The resulting data will contain the resolved read-only custom field values. The resulting PerformPaymentTypeData will contain the custom fields for the missing values.

Specified by:

getEasyInvoiceData in interface EasyInvoiceService

Throws:

FrameworkException

perform

public PaymentVO perform(@NotNull
                         @NotNull PerformPaymentDTO parameters)
                  throws TransferException,
                         FrameworkException

Description copied from interface: EasyInvoiceService

Same as PaymentService.perform(PerformPaymentDTO) but through the BuiltInChannel.EASY_INVOICE channel

Specified by:

perform in interface EasyInvoiceService

Throws:

TransferException

FrameworkException

prepareEasyInvoice

public PrepareEasyInvoiceData prepareEasyInvoice(PrepareEasyInvoiceParams params)
                                          throws FrameworkException

Description copied from interface: EasyInvoiceService

Returns data for displaying details of an easy invoice while still as guest. Minimally, the owner user is required. If an amount is specified, it is required that a single currency is resolved. This can be either because:

• A payment type was specified
• A currency was specified
• The destination user has a single currency

The resulting user will be returned only if the guest can search / view profile of that group. Without this permission, a null user will be returned. However, if the user is not found, a regular EntityNotFoundException will be thrown.

Specified by:

prepareEasyInvoice in interface EasyInvoiceService

Throws:

FrameworkException

preview

public PaymentPreviewVO preview(@NotNull
                                @NotNull PerformPaymentDTO parameters)
                         throws FrameworkException

Description copied from interface: EasyInvoiceService

Previews a payment to be performed

Specified by:

preview in interface EasyInvoiceService

Throws:

FrameworkException

validate

public void validate(@NotNull
                     @NotNull PerformPaymentDTO parameters)
              throws FrameworkException

Description copied from interface: EasyInvoiceService

Validates the parameters to perform a payment without actually performing the payment. Attention: will only validate for required / invalid fields, but will not check for balance, maximum amount per day or other validations that require access to actual accounts.

Specified by:

validate in interface EasyInvoiceService

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