Package org.cyclos.impl.banking

Class TicketServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.banking.TicketServiceImpl

All Implemented Interfaces:

TicketServiceLocal, TicketService, Service

@Service
public class TicketServiceImpl
extends BaseServiceImpl
implements TicketServiceLocal

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

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.
int	cancelAll(UserAccount account)	Cancels all open tickets for the given account
void	checkExists(String ticketNumber, boolean mustBeOpen)	Checks that a ticket with the given number exists, throwing EntityNotFoundException if not.
TicketVO	create(CreateTicketDTO parameters)	Creates a new ticket with status TicketStatus.OPEN for the logged user (i.e setting it as the receiver).
void	expire(Ticket ticket)	Expires the given ticket
Ticket	findByTicketNumber(String ticketNumber)	Returns a ticket by ticket number, or throws EntityNotFoundException if not found.
String	getApproveUrl(Ticket ticket)	Returns the URL used to approve the given ticket, or null if the ticket isn't open.
CreateTicketData	getCreateData(UserLocatorVO ownerVO, UserLocatorVO payerVO)	Returns data used to crate a new ticket for the given user, optionally with a fixed payer.
TicketData	getData(Ticket ticket)	Returns data for a ticket
TicketData	getData(TicketVO vo)	Returns data to view the ticket's details.
TicketPaymentTypeData	getTicketPaymentTypeData(UserLocatorVO ownerVO, TransferTypeVO transferType)	Returns the data for a specific payment type used to create a new ticket
List<PaymentTransferType>	listPossiblePaymentTypesForCreateTicket(User ownerOrNull, User payer)	Based on the logged user's permissions over the given owner, returns the possible payment types for creating tickets, optionally to the given fixed payer
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 void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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

TicketServiceImpl

public TicketServiceImpl()

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

cancelAll

public int cancelAll(UserAccount account)

Description copied from interface: TicketServiceLocal

Cancels all open tickets for the given account

Specified by:

cancelAll in interface TicketServiceLocal

checkExists

public void checkExists(String ticketNumber,
                        boolean mustBeOpen)

Description copied from interface: TicketServiceLocal

Checks that a ticket with the given number exists, throwing EntityNotFoundException if not. Optionally only succeds if the ticket is open.

Specified by:

checkExists in interface TicketServiceLocal

create

public TicketVO create(CreateTicketDTO parameters)
                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

expire

public void expire(Ticket ticket)

Description copied from interface: TicketServiceLocal

Expires the given ticket

Specified by:

expire in interface TicketServiceLocal

findByTicketNumber

public Ticket findByTicketNumber(String ticketNumber)

Description copied from interface: TicketServiceLocal

Returns a ticket by ticket number, or throws EntityNotFoundException if not found.

Specified by:

findByTicketNumber in interface TicketServiceLocal

getApproveUrl

public String getApproveUrl(Ticket ticket)

Description copied from interface: TicketServiceLocal

Returns the URL used to approve the given ticket, or null if the ticket isn't open.

Specified by:

getApproveUrl in interface TicketServiceLocal

getCreateData

public CreateTicketData getCreateData(UserLocatorVO ownerVO,
                                      UserLocatorVO payerVO)
                               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(Ticket ticket)
                   throws FrameworkException

Description copied from interface: TicketServiceLocal

Returns data for a ticket

Specified by:

getData in interface TicketServiceLocal

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

listPossiblePaymentTypesForCreateTicket

public List<PaymentTransferType> listPossiblePaymentTypesForCreateTicket(User ownerOrNull,
                                                                         User payer)

Description copied from interface: TicketServiceLocal

Based on the logged user's permissions over the given owner, returns the possible payment types for creating tickets, optionally to the given fixed payer

Specified by:

listPossiblePaymentTypesForCreateTicket in interface TicketServiceLocal

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

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl