Package org.cyclos.security.banking

Class TicketServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.TicketServiceSecurity

All Implemented Interfaces:

TicketService, Service

@Security
public class TicketServiceSecurity
extends BaseServiceSecurity
implements TicketService

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

Method Summary

Modifier and Type	Method	Description
TicketVO	approve(ApproveTicketDTO params)	Approves a ticket, as a payer, only if status is TicketStatus.OPEN. If there is no "success URL" defined then it generates a new direct payment and the ticket goes to TicketStatus.PROCESSED.
SerializableInputStream	barcode(TicketBarcodeParams params)	Generates a two-dimensional barcode (aka QR code) only if status is TicketStatus.OPEN containing a URL of the form: .../pay/ticket_id (e.g https://www.cyclos.org/pay/1234567890123456789).
void	cancel(TicketVO ticketVO)	Cancels the ticket only if status is TicketStatus.OPEN and the logged user is the ticket's receiver or a manger of him.
TicketVO	create(CreateTicketDTO params)	Creates a new ticket with status TicketStatus.OPEN for the logged user (i.e setting it as the receiver).
CreateTicketData	getCreateData(UserLocatorVO ownerVO, UserLocatorVO payer)	Returns data used to crate a new ticket for the given user, optionally with a fixed payer.
TicketData	getData(TicketVO vo)	Returns data to view the ticket's details.
TicketPaymentTypeData	getTicketPaymentTypeData(UserLocatorVO ownerVO, @NotNull TransferTypeVO transferType)	Returns the data for a specific payment type used to create a new ticket
boolean	isAccessible(Ticket ticket)
ApproveTicketPreviewVO	previewApprove(TicketVO ticketVO)	Previews the payment which would be performed when approving the given ticket as the payer.
TicketProcessResult	process(ProcessTicketDTO params)	Processes a ticket as the receiver of the payment (i.e the ticket creator). Only if the ticket status is TicketStatus.APPROVED a new direct payment will be generated and the new ticket status will be: TicketStatus.PROCESSED.
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none

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

TicketServiceSecurity

public TicketServiceSecurity()

Method Detail

approve

public TicketVO approve(ApproveTicketDTO params)
                 throws FrameworkException,
                        TransferException

Description copied from interface: TicketService

Approves a ticket, as a payer, only if status is TicketStatus.OPEN.
If there is no "success URL" defined then it generates a new direct payment and the ticket goes to TicketStatus.PROCESSED. Otherwise, no payment is generated and the ticket goes to TicketStatus.APPROVED status. The payment will be generated only after being processed by the receiver.

Specified by:

approve in interface TicketService

Throws:

FrameworkException

TransferException

barcode

public SerializableInputStream barcode(TicketBarcodeParams params)
                                throws FrameworkException

Description copied from interface: TicketService

Generates a two-dimensional barcode (aka QR code) only if status is TicketStatus.OPEN containing a URL of the form: .../pay/ticket_id (e.g https://www.cyclos.org/pay/1234567890123456789).

Specified by:

barcode in interface TicketService

Throws:

FrameworkException

cancel

public void cancel(TicketVO ticketVO)
            throws FrameworkException

Description copied from interface: TicketService

Cancels the ticket only if status is TicketStatus.OPEN and the logged user is the ticket's receiver or a manger of him.

Specified by:

cancel in interface TicketService

Throws:

FrameworkException

create

public TicketVO create(CreateTicketDTO params)
                throws FrameworkException

Description copied from interface: TicketService

Creates a new ticket with status TicketStatus.OPEN for the logged user (i.e setting it as the receiver).

Specified by:

create in interface TicketService

Throws:

FrameworkException

getCreateData

public CreateTicketData getCreateData(UserLocatorVO ownerVO,
                                      UserLocatorVO payer)
                               throws FrameworkException

Description copied from interface: TicketService

Returns data used to crate a new ticket for the given user, optionally with a fixed payer.

Specified by:

getCreateData in interface TicketService

Throws:

FrameworkException

getData

public TicketData getData(TicketVO vo)
                   throws FrameworkException

Description copied from interface: TicketService

Returns data to view the ticket's details.

Specified by:

getData in interface TicketService

Throws:

FrameworkException

getTicketPaymentTypeData

public TicketPaymentTypeData getTicketPaymentTypeData(UserLocatorVO ownerVO,
                                                      @NotNull
                                                      @NotNull TransferTypeVO transferType)
                                               throws FrameworkException

Description copied from interface: TicketService

Returns the data for a specific payment type used to create a new ticket

Specified by:

getTicketPaymentTypeData in interface TicketService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(Ticket ticket)

previewApprove

public ApproveTicketPreviewVO previewApprove(TicketVO ticketVO)
                                      throws FrameworkException

Description copied from interface: TicketService

Previews the payment which would be performed when approving the given ticket as the payer. The ticket status must be TicketStatus.APPROVED or TicketStatus.OPEN without a success url.

Specified by:

previewApprove in interface TicketService

Throws:

FrameworkException

process

public TicketProcessResult process(ProcessTicketDTO params)
                            throws TransferException,
                                   FrameworkException

Description copied from interface: TicketService

Processes a ticket as the receiver of the payment (i.e the ticket creator).
Only if the ticket status is TicketStatus.APPROVED a new direct payment will be generated and the new ticket status will be: TicketStatus.PROCESSED. There could be a case where this method is invoked for an already processed ticket (e.g. the ticket has both a success url and an success webhook), for it, only in case the given process code is the correct one this method runs without errors and returns the same result as the previous invocation (no payment is generated) but with the TicketProcessResult.ACTUALLY_PROCESSED flag in false.

Specified by:

process in interface TicketService

Throws:

TransferException

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