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

Constructor Summary

Constructors

Constructor and Description
TicketServiceSecurity()

Method Summary

Modifier and Type	Method and Description
TicketVO	accept(AcceptTicketDTO params) Accepts a ticked only if status is TicketStatus.OPEN, as a payer, generating a new direct payment.
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 payer) Returns data used to crate a new ticket, optionally with a fixed payer.
TicketData	getData(TicketVO vo) Returns data to view the ticket's details.
EasyInvoiceData	getEasyInvoiceData(PerformPaymentDTO params) Returns data for an easy invoice after logging in.
TicketPaymentTypeData	getTicketPaymentTypeData(TransferTypeVO transferType) Returns the data for a specific payment type used to create a new ticket
boolean	hasViewPermission(InternalAccountOwner owner)
boolean	isAccessible(Ticket ticket)
PrepareEasyInvoiceData	prepareEasyInvoice(PrepareEasyInvoiceParams params) Returns data for displaying details of an easy invoice while still as guest.
AcceptTicketPreviewVO	previewAccept(TicketVO ticketVO) Previews the payment which would be performed when accepting the given ticket as the payer.
protected org.cyclos.impl.access.EntityCheck<?>	resolveEntityCheck() Must be implemented in order to return the EntityCheck managed by this security component, or null if none
Page<TicketEntryVO>	search(TicketQuery query) Searches for tickets according to the given query.

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getAccountHandler, getAuthHandler, getBaseEntityManagerHandler, getChannelConfiguration, getConfiguration, getConversionHandler, getCustomFieldValueHandler, getEntityManagerHandler, getGroupsHandler, getLoggedBasicUser, getLoggedUser, getProducts, getProductsHandler, getReportHandler, getTranslatedName, getTranslatedValue, getUserLocatorHandler, getValidationResult, 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

delete, detach, find, flush, from, getApplicationContext, getConfigurationHandler, getDataTranslationHandler, getFormatter, getFormatter, getFormatter, getLogger, getNotificationHandler, getProfileFieldHandler, getRemoteAddress, getSessionData, getTransactionHandler, getTranslationHandler, mailContentBuilder, message, message, persist, 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

accept

public TicketVO accept(AcceptTicketDTO params)
                throws FrameworkException,
                       TransferException

Description copied from interface: TicketService

Accepts a ticked only if status is TicketStatus.OPEN, as a payer, generating a new direct payment. The returned ticket will contains a reference to the generated payment.

Specified by:

accept 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 payer)
                               throws FrameworkException

Description copied from interface: TicketService

Returns data used to crate a new ticket, 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

getEasyInvoiceData

public EasyInvoiceData getEasyInvoiceData(PerformPaymentDTO params)
                                   throws FrameworkException

Description copied from interface: TicketService

Returns data for an easy invoice after logging in. Minimally, a to user is required. The amount either is not specified or a currency must be resolved, in the same way as TicketService.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 TicketService

Throws:

FrameworkException

getTicketPaymentTypeData

public TicketPaymentTypeData getTicketPaymentTypeData(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

hasViewPermission

public boolean hasViewPermission(InternalAccountOwner owner)

isAccessible

public boolean isAccessible(Ticket ticket)

prepareEasyInvoice

public PrepareEasyInvoiceData prepareEasyInvoice(PrepareEasyInvoiceParams params)
                                          throws FrameworkException

Description copied from interface: TicketService

Returns data for displaying details of an easy invoice while still as guest. Minimally, a to 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 TicketService

Throws:

FrameworkException

previewAccept

public AcceptTicketPreviewVO previewAccept(TicketVO ticketVO)
                                    throws FrameworkException

Description copied from interface: TicketService

Previews the payment which would be performed when accepting the given ticket as the payer.

Specified by:

previewAccept in interface TicketService

Throws:

FrameworkException

search

public Page<TicketEntryVO> search(TicketQuery query)
                           throws FrameworkException

Description copied from interface: TicketService

Searches for tickets according to the given query. Returns tickets of the owner user (i.e ticket's receiver).

Specified by:

search in interface TicketService

Throws:

FrameworkException

resolveEntityCheck

protected org.cyclos.impl.access.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