Package org.cyclos.security.marketplace

Class OrderServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

org.cyclos.security.marketplace.OrderServiceSecurity

All Implemented Interfaces:

CRUDService<OrderDTO,OrderData,OrderDataParams>, CRUDWithConfirmationPasswordService<OrderDTO,OrderData,OrderDataParams>, OrderService, Service

@Security
public class OrderServiceSecurity
extends CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>
implements OrderService

Security for OrderService

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

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

Method Summary

Modifier and Type	Method	Description
OrderStatus	accept(AcceptOrderParams params)	Accepts the given order, which should be in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status, and needs the delivery price to be already set.
int	addToCart(BasicAdVO ad, BigDecimal quantity)	Adds the given product to the logged user's shopping cart, returning the total count of ads in the cart. When the given quantity is null, the minimum allowed quantity on the shopping cart for the given product is assumed
ShoppingCartDTO	adjustAndGetMyCart()	Returns the current logged user's shopping cart, adjusting all quantities
OrderData	adjustShoppingCartAndGetData(OrderVO vo)	Perform adjustments to the shopping cart quantities and returns the data for it
void	checkCartStock(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Checks that all items on the given cart are still on stock
protected void	checkCreateNew(OrderDataParams params)	Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
ShoppingCartCheckoutResult	checkout(ShoppingCartCheckoutParams params)	Checks out the logged user's shopping cart with the given seller and currency, checking the confirmation password (if any), and reserving the amount when the delivery price is previously known (otherwise, the buyer still needs to confirm before the payment is done).
int	countCartItems()	Returns the total number of items in the logged user's shopping cart
protected void	customizeData(OrderData data)	Can be overridden in order to process the returned data object for the given entity
boolean	doHasManageAccess(Order order)	Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(Order order)	Should be implemented in order to return whether the caller is allowed to view the given entity.
FileInfo	exportOrder(ExportFormatVO format, OrderVO vo)	Exports the given order to file
OrderData	getCheckoutData(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Returns data for checkout the cart items of the given seller and currency
protected OrderServiceLocal	getImplementation()	Should be implemented in order to return the actual implementation of the service
ShoppingCartDTO	getMyCart()	Returns the current logged user's shopping cart, without adjusting any quantity
OrderData	getOrderData(OrderVO vo)	Returns data of an order
long	getOrderId(OrderVO order)	Return the id of the given order only if the logged user can see the order.
OrderSearchData	getSearchData(@NotNull UserLocatorVO locator, boolean sales)	Returns data for searching orders / sales
boolean	isAccessible(SessionData sessionData, Order entity)	Must be implemented in order to determine whether the given entity is accessible for the given session data.
int	modifyQuantityOnCart(BasicAdVO ad, BigDecimal quantity)	Updates the quantity for the given product on the logged user's shopping cart returning the total count of ads in the cart.
void	reject(RejectOrderParams params)	Rejects the given order
int	removeCart(UserLocatorVO sellerVO, CurrencyVO currencyVO)	Removes the logged user's shopping cart for the given seller and currency returning the remaining count of ads in the cart
int	removeCartById(Long id)	Same as CRUDService.remove(Long) but returning the total count of items present the whole shopping cart
int	removeCartItem(BasicAdVO ad)	Removes the given product from the logged user's shopping cart returning the remaining count of ads in the cart.
Page<OrderVO>	search(OrderQuery query)	Searches for orders based on OrderQuery
void	setDeliveryMethod(SetDeliveryMethodParams deliveryInfo)	Updates the delivery method information of an order when it is on the OrderStatus.PENDING_SELLER status and there is no delivery information yet.
Long	submitToBuyer(OrderDTO order)	Submits the given order for buyer approval

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canPerformOperation, canViewData, checkManageAccess, checkOperation, checkSave, checkViewAccess, find, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, hasManageAccess, hasViewAccess, load, onBeforeSave, remove, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveEntityCheck, save, saveWithConfirmationPassword

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Constructor Detail

OrderServiceSecurity

public OrderServiceSecurity()

Method Detail

accept

public OrderStatus accept(AcceptOrderParams params)
                   throws FrameworkException,
                          TransferException,
                          PasswordException

Description copied from interface: OrderService

Accepts the given order, which should be in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status, and needs the delivery price to be already set. When the buyer hasn't yet chosen a payment type, it is required now. Also, when no amount was reserved, the confirmation password will be checked before performing the actual payment.

Specified by:

accept in interface OrderService

Throws:

PasswordException - The given confirmation password is invalid

IllegalActionException - The given order is not in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER status

TransferException - When there was a problem while reserving the amount, like there is no available balance

FrameworkException

addToCart

public int addToCart(BasicAdVO ad,
                     BigDecimal quantity)
              throws FrameworkException,
                     OutOfStockException

Description copied from interface: OrderService

Adds the given product to the logged user's shopping cart, returning the total count of ads in the cart.
When the given quantity is null, the minimum allowed quantity on the shopping cart for the given product is assumed

Specified by:

addToCart in interface OrderService

Throws:

OutOfStockException - When the given quantity is greater than the available stock

FrameworkException

adjustAndGetMyCart

public ShoppingCartDTO adjustAndGetMyCart()
                                   throws FrameworkException

Description copied from interface: OrderService

Returns the current logged user's shopping cart, adjusting all quantities

Specified by:

adjustAndGetMyCart in interface OrderService

Throws:

FrameworkException

adjustShoppingCartAndGetData

public OrderData adjustShoppingCartAndGetData(OrderVO vo)
                                       throws FrameworkException

Description copied from interface: OrderService

Perform adjustments to the shopping cart quantities and returns the data for it

Specified by:

adjustShoppingCartAndGetData in interface OrderService

Throws:

FrameworkException

checkCartStock

public void checkCartStock(UserLocatorVO sellerVO,
                           CurrencyVO currencyVO)
                    throws FrameworkException,
                           OutOfStockException

Description copied from interface: OrderService

Checks that all items on the given cart are still on stock

Specified by:

checkCartStock in interface OrderService

Throws:

FrameworkException

OutOfStockException

checkout

public ShoppingCartCheckoutResult checkout(ShoppingCartCheckoutParams params)
                                    throws FrameworkException,
                                           EntityNotFoundException,
                                           OutOfStockException,
                                           TransferException,
                                           PasswordException

Description copied from interface: OrderService

Checks out the logged user's shopping cart with the given seller and currency, checking the confirmation password (if any), and reserving the amount when the delivery price is previously known (otherwise, the buyer still needs to confirm before the payment is done).

Specified by:

checkout in interface OrderService

Returns:

A result containing the order and the remaining webshop ads added to the shopping cart.

Throws:

EntityNotFoundException - When there is no current shopping cart order with the given seller and currency

PasswordException - The given confirmation password is invalid

OutOfStockException - When at least one of the expected items exceeds the available stock

InsufficientBalanceException - When there was a problem while reserving the amount

FrameworkException

TransferException

countCartItems

public int countCartItems()
                   throws FrameworkException

Description copied from interface: OrderService

Returns the total number of items in the logged user's shopping cart

Specified by:

countCartItems in interface OrderService

Throws:

FrameworkException

doHasManageAccess

public boolean doHasManageAccess(Order order)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation

Specified by:

doHasManageAccess in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

doHasViewAccess

public boolean doHasViewAccess(Order order)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to view the given entity.

Specified by:

doHasViewAccess in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

exportOrder

public FileInfo exportOrder(ExportFormatVO format,
                            OrderVO vo)
                     throws FrameworkException

Description copied from interface: OrderService

Exports the given order to file

Specified by:

exportOrder in interface OrderService

Throws:

FrameworkException

getCheckoutData

public OrderData getCheckoutData(UserLocatorVO sellerVO,
                                 CurrencyVO currencyVO)

Description copied from interface: OrderService

Returns data for checkout the cart items of the given seller and currency

Specified by:

getCheckoutData in interface OrderService

getMyCart

public ShoppingCartDTO getMyCart()

Description copied from interface: OrderService

Returns the current logged user's shopping cart, without adjusting any quantity

Specified by:

getMyCart in interface OrderService

getOrderData

public OrderData getOrderData(OrderVO vo)
                       throws FrameworkException

Description copied from interface: OrderService

Returns data of an order

Specified by:

getOrderData in interface OrderService

Throws:

FrameworkException

getOrderId

public long getOrderId(OrderVO order)
                throws FrameworkException

Description copied from interface: OrderService

Return the id of the given order only if the logged user can see the order.

Specified by:

getOrderId in interface OrderService

Throws:

FrameworkException

getSearchData

public OrderSearchData getSearchData(@NotNull
                                     @NotNull UserLocatorVO locator,
                                     boolean sales)
                              throws FrameworkException

Description copied from interface: OrderService

Returns data for searching orders / sales

Specified by:

getSearchData in interface OrderService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            Order entity)

Description copied from class: CRUDServiceSecurity

Must be implemented in order to determine whether the given entity is accessible for the given session data. This method shouldn't check the same condition as CRUDServiceSecurity.hasViewAccess(BaseEntity). If the only condition for an entity is CRUDServiceSecurity.hasViewAccess(BaseEntity), this method should return false.

Specified by:

isAccessible in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

modifyQuantityOnCart

public int modifyQuantityOnCart(BasicAdVO ad,
                                BigDecimal quantity)
                         throws FrameworkException,
                                IllegalActionException,
                                OutOfStockException

Description copied from interface: OrderService

Updates the quantity for the given product on the logged user's shopping cart returning the total count of ads in the cart.

Specified by:

modifyQuantityOnCart in interface OrderService

Throws:

IllegalActionException - When the given ad is not in the logged user's shopping cart

OutOfStockException - When the new quantity is greater than the available stock

FrameworkException

reject

public void reject(RejectOrderParams params)
            throws FrameworkException

Description copied from interface: OrderService

Rejects the given order

Specified by:

reject in interface OrderService

Throws:

IllegalActionException - When the given order is not in either OrderStatus.PENDING_BUYER or OrderStatus.PENDING_SELLER statuses.

FrameworkException

removeCart

public int removeCart(UserLocatorVO sellerVO,
                      CurrencyVO currencyVO)

Description copied from interface: OrderService

Removes the logged user's shopping cart for the given seller and currency returning the remaining count of ads in the cart

Specified by:

removeCart in interface OrderService

removeCartById

public int removeCartById(Long id)
                   throws FrameworkException

Description copied from interface: OrderService

Same as CRUDService.remove(Long) but returning the total count of items present the whole shopping cart

Specified by:

removeCartById in interface OrderService

Throws:

FrameworkException

See Also:

CRUDService.remove(java.lang.Long)

removeCartItem

public int removeCartItem(BasicAdVO ad)
                   throws FrameworkException

Description copied from interface: OrderService

Removes the given product from the logged user's shopping cart returning the remaining count of ads in the cart.

Specified by:

removeCartItem in interface OrderService

Throws:

IllegalActionException - When the given ad is not in the logged user's shopping cart

FrameworkException

search

public Page<OrderVO> search(OrderQuery query)

Description copied from interface: OrderService

Searches for orders based on OrderQuery

Specified by:

search in interface OrderService

setDeliveryMethod

public void setDeliveryMethod(SetDeliveryMethodParams deliveryInfo)
                       throws FrameworkException

Description copied from interface: OrderService

Updates the delivery method information of an order when it is on the OrderStatus.PENDING_SELLER status and there is no delivery information yet. Afterwards, the new status will be OrderStatus.PENDING_BUYER for final approval.

Specified by:

setDeliveryMethod in interface OrderService

Throws:

IllegalActionException - When the referenced order is not on the OrderStatus.PENDING_SELLER status or already has delivery information

FrameworkException

submitToBuyer

public Long submitToBuyer(OrderDTO order)
                   throws FrameworkException,
                          OutOfStockException

Description copied from interface: OrderService

Submits the given order for buyer approval

Specified by:

submitToBuyer in interface OrderService

Throws:

OutOfStockException - When any of the order products have ran out of stock right before processing

FrameworkException

checkCreateNew

protected void checkCreateNew(OrderDataParams params)

Description copied from class: CRUDServiceSecurity

Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not

Specified by:

checkCreateNew in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

customizeData

protected void customizeData(OrderData data)

Description copied from class: CRUDServiceSecurity

Can be overridden in order to process the returned data object for the given entity

Overrides:

customizeData in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>

getImplementation

protected OrderServiceLocal getImplementation()

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return the actual implementation of the service

Specified by:

getImplementation in class CRUDServiceSecurity<OrderDTO,Order,OrderData,OrderDataParams>