com.neurosys.ecom.user.service.jaxrs

Class StrategiesService<P extends Product,U extends IGenericEcomUser,CONTEXT>

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.ecom.user.service.jaxrs.StrategiesService<P,U,CONTEXT>

All Implemented Interfaces:

ChangeGenerator, ChangeListener, Serializable, EventListener

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
public class StrategiesService<P extends Product,U extends IGenericEcomUser,CONTEXT>
extends SecurableService
implements ChangeListener, ChangeGenerator

THIS CLASS IS WICKET DEPENDENT AS IT INTERNALLY USES A WICKET EComSession Web Service Layer for accessing Strategies over a users Session (Guest or Logged in)
This can be used to compute things like Packaging costs, Tax, Shipping costs etc. of individual Product(s) or Session-Cart-Products
If any of the used Strategy is a ChangeGenerator and a ChangeListener then any object notified will call onChange(ChangeGenerator, Object) of the same Strategy with the event being
Object[] {HttpServletReuest, original context as event sent by Strategy}

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.collections.Transformer	throwableToMessage Marshal errors to just their messages

Fields inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
StrategiesService()
StrategiesService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
protected PartialTransactionException	_strategiesCalcData(Map<P,Number> productQtyMap, List<CartItem> cartItems, U user, String currency, List<PromotionForUser> promotions, Amount subTotal, Number totalQuantity, Collection<String> paramNames, EComSession session, CONTEXT context, PartialTransactionException pte) Can override if there are any App specific Strategies not handled by this default service
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
protected CONTEXT	deriveContext(U user, EComSession session, String contextStr) Derive Context - Give pref to param, if not provided then rely on Session. Context Derivation Algo: If contextProviderStrategy exists then pass raw contextStr to it and derive CONTEXT object(s) and will also update the ContextualSession.setPartialContext(Object).
AdapterService	getAdapterService() Strategies can be Adapters; that can be updated @ runtime.
Object	getAreas(String id, String type) For international shipping etc, area information
AreaStrategy<AreaType,CONTEXT>	getAreaStrategy()
CartProductTransformService<P,CartItem>	getCartProductTransform() Handle All conversions
ContextProviderStrategy<U,CONTEXT>	getContextProviderStrategy()
CurrencyStrategy	getCurrencyStrategy()
List	getListeners() Get list directly.
CumulativeChargeStrategy	getPackagingStrategy()
ProductService	getProductService()
PromotionStrategy<P,U>	getPromotionStrategy()
SaleStrategy	getSaleStrategy()
CumulativeChargeStrategy	getShippingStrategy()
CumulativeChargeStrategy	getTaxStrategy()
org.apache.commons.collections.Transformer	getThrowableToMessage() Marshal errors to just their messages
void	init()
protected void	logValidationError(String strategyName, Amount subTotal, List<CartItem> cartItems, U user, String currency, Collection<String> paramNames, EComSession session, String contextStr, Throwable e)
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
void	onChange(ChangeGenerator changeGenerator, Object context) Allow Strategies that are ChangeGenerators to modify the session via ContextualSession.setPartialContext(Object)
String	productListCalcs(String productNames, String params, String currency, String toCurrency, String context) A JSON object that contains all data from various strategies available to this service; over the Products in the Session-Cart
String	reloadScripts(String keysStr) Reload the strategies that can be reloaded (Scripts)
String	sessionCartCalcs(String params, String currency, String toCurrency, String context) A JSON object that contains all data from various strategies available to this service; over the Products in the Session-Cart
void	setAdapterService(AdapterService adapterService) Strategies can be Adapters; that can be updated @ runtime.
void	setAreaStrategy(AreaStrategy<AreaType,CONTEXT> areaStrategy)
void	setCartProductTransform(CartProductTransformService<P,CartItem> cartProductTransform) Handle All conversions
void	setContextProviderStrategy(ContextProviderStrategy<U,CONTEXT> contextProviderStrategy)
void	setCurrencyStrategy(CurrencyStrategy currencyStrategy)
void	setListeners(List listeners) Set list directly.
void	setPackagingStrategy(CumulativeChargeStrategy packagingStrategy)
void	setProductService(ProductService productService)
void	setPromotionStrategy(PromotionStrategy<P,U> promotionStrategy)
void	setSaleStrategy(SaleStrategy saleStrategy)
void	setShippingStrategy(CumulativeChargeStrategy shippingStrategy)
void	setTaxStrategy(CumulativeChargeStrategy taxStrategy)
void	setThrowableToMessage(org.apache.commons.collections.Transformer throwableToMessage) Marshal errors to just their messages
Map	strategiesCalcData(List<CartItem> cartItems, U user, String currency, String toCurrency, Collection<String> paramNames, EComSession session, String contextStr)

Methods inherited from class com.neurosys.amorphous.service.jaxrs.SecurableService

checkAuthFilterInvoked, filter, query

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

filter, getCacheDef, getTestString, query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

throwableToMessage

protected org.apache.commons.collections.Transformer throwableToMessage

Marshal errors to just their messages

Constructor Detail

StrategiesService

public StrategiesService()

StrategiesService

public StrategiesService(boolean checkAuthFiltered)

Method Detail

init

@PostConstruct
public void init()

deriveContext

protected CONTEXT deriveContext(U user,
                                EComSession session,
                                String contextStr)

Derive Context - Give pref to param, if not provided then rely on Session.
Context Derivation Algo:

1. If contextProviderStrategy exists then pass raw contextStr to it and derive CONTEXT object(s) and will also update the ContextualSession.setPartialContext(Object).
   If no current contextStr passed, then rely on ContextualSession.getContext()
2. If no contextProviderStrategy exists and contextStr is not null, then it will log that as a WARNING and return null by default.

Parameters:

user - as U

session - as EComSession

contextStr - as String (loosely app defined as usually JSON) (custom to Application)

Returns:

logValidationError

protected void logValidationError(String strategyName,
                                  Amount subTotal,
                                  List<CartItem> cartItems,
                                  U user,
                                  String currency,
                                  Collection<String> paramNames,
                                  EComSession session,
                                  String contextStr,
                                  Throwable e)

_strategiesCalcData

protected PartialTransactionException _strategiesCalcData(Map<P,Number> productQtyMap,
                                                          List<CartItem> cartItems,
                                                          U user,
                                                          String currency,
                                                          List<PromotionForUser> promotions,
                                                          Amount subTotal,
                                                          Number totalQuantity,
                                                          Collection<String> paramNames,
                                                          EComSession session,
                                                          CONTEXT context,
                                                          PartialTransactionException pte)

Can override if there are any App specific Strategies not handled by this default service

Parameters:

productQtyMap - as Map of Product to Number

cartItems - as List of CartItem

user - as U

currency - as String

promotions - as List of PromotionForUser

subTotal - as Amount (sub total calculated **so far**)

totalQuantity - as # of items as Number

paramNames - as List of String of derivations requested byclient

context - as CONTEXT

pte - as PartialTransactionException to add to incase of errors, warnings, info messages to return back to client.

Returns:

PartialTransactionException

strategiesCalcData

public Map strategiesCalcData(List<CartItem> cartItems,
                              U user,
                              String currency,
                              String toCurrency,
                              Collection<String> paramNames,
                              EComSession session,
                              String contextStr)

Parameters:

cartItems - as List of CartItem.

user - as User

currency - as String, for the currency to display all calcs in

toCurrency - as String, an optional nullable parameter that specifies any additional calculation conversion for an alternate currency. See also currencyStrategy

paramNames - as Collection of String; @nullable true. If not null and type of error specified, will fetch additional (non-strategy), related info.

• shipping
• tax
• packaging
• subTotal
• quantity - Associated map of count for each Product; identified by Product Name
• promotions

In addition to the data; various internal details as comma separated strings for each can also be obtained by using the following:
These will be included only if paramNames contains the type of error requested

• infos
• warns
• errors

In addition; one can also query the context. Some strategies may modify the session context. In which case one can parse processedContext.

• rawContext
• processedContext

Error handling: There are 3 levels an error can be trapped:

1. CITICAL ERROR - Break the code flow from that point on : Any RuntimeException that does not fit in the following. This will not even result in a return object, and be passed on the to the calling API to be handled
2. errors - Any ValidationException; these will also replace any value in the result Map
3. warns - Any BreakChainException
4. infos - Any ContinueProcessingException

contextStr - as String (loosely app defined as usually JSON) (custom to Application)

Returns:

Map with all calculations per Strategy + a context if ContextualSession.getContext() exists

See Also:

AbstractCartService, CartItem

sessionCartCalcs

@GET
 @Path(value="sessionCartCalcs")
public String sessionCartCalcs(@QueryParam(value="params")
                                                                     String params,
                                                                     @QueryParam(value="currency")
                                                                     String currency,
                                                                     @QueryParam(value="toCurrency")
                                                                     String toCurrency,
                                                                     @QueryParam(value="context")
                                                                     String context)
                                                              throws Exception

A JSON object that contains all data from various strategies available to this service; over the Products in the Session-Cart

Parameters:

params - as comma separated String of params; @nullable true. If null will fetch all params
For Param List see #strategiesCalcData(List, AbstractUser, List)

currency - as String, for the currency to display all calcs in

toCurrency - as String, an optional nullable parameter that specifies any additional calculation conversion for an alternate currency. See also currencyStrategy

context - as String (loosely app defined as usually JSON) (custom to Application)

Returns:

JSON with all calculations per Strategy + a context if ContextualSession.getContext() exists

Throws:

Exception

productListCalcs

@POST
 @Path(value="productListCalcs")
public String productListCalcs(@FormParam(value="productNames")
                                                                      String productNames,
                                                                      @FormParam(value="params")
                                                                      String params,
                                                                      @FormParam(value="currency")
                                                                      String currency,
                                                                      @QueryParam(value="toCurrency")
                                                                      String toCurrency,
                                                                      @FormParam(value="context")
                                                                      String context)
                                                               throws Exception

A JSON object that contains all data from various strategies available to this service; over the Products in the Session-Cart

Parameters:

productNames - as List of product names or keys that represent the items in the cart

params - as comma separated String of params; @nullable true. If null will fetch all params
For Param List see #strategiesCalcData(List, AbstractUser, List)

currency - as String, for the currency to display all calcs in

toCurrency - as String, an optional nullable parameter that specifies any additional calculation conversion for an alternate currency. See also currencyStrategy

context - as String (loosely app defined as usually JSON) (custom to Application)

Returns:

JSON with all calculations per Strategy + a context if ContextualSession.getContext() exists

Throws:

Exception

getAreas

@GET
 @Path(value="areas")
public Object getAreas(@QueryParam(value="id")
                                                  String id,
                                                  @QueryParam(value="type")
                                                  String type)

For international shipping etc, area information

Parameters:

is - as Area Id @nullable true. If Null, will fetch the full map

id - as String. If specified will fetch only AreaType for that id and type, or return null if it does not exist

type - as String. If specified, will clarify the nature/level of Id. Like region, country, state, zip etc.

Returns:

AreaType record if id is null OR List of AreaTypes or a Map of id to AreaType (depends on implementation of AreaStrategy.

reloadScripts

@GET
 @Path(value="admin/reload")
public String reloadScripts(@QueryParam(value="keys")
                                                              String keysStr)
                                                       throws Exception

Reload the strategies that can be reloaded (Scripts)

Parameters:

keysStr - as comma separated keys that define the Script(s) @nullable true; if no name provided then all are reloaded

Throws:

Exception

getShippingStrategy

public CumulativeChargeStrategy getShippingStrategy()

setShippingStrategy

public void setShippingStrategy(CumulativeChargeStrategy shippingStrategy)

getTaxStrategy

public CumulativeChargeStrategy getTaxStrategy()

setTaxStrategy

public void setTaxStrategy(CumulativeChargeStrategy taxStrategy)

getPackagingStrategy

public CumulativeChargeStrategy getPackagingStrategy()

setPackagingStrategy

public void setPackagingStrategy(CumulativeChargeStrategy packagingStrategy)

getSaleStrategy

public SaleStrategy getSaleStrategy()

setSaleStrategy

public void setSaleStrategy(SaleStrategy saleStrategy)

getProductService

public ProductService getProductService()

setProductService

public void setProductService(ProductService productService)

getPromotionStrategy

public PromotionStrategy<P,U> getPromotionStrategy()

setPromotionStrategy

public void setPromotionStrategy(PromotionStrategy<P,U> promotionStrategy)

getContextProviderStrategy

public ContextProviderStrategy<U,CONTEXT> getContextProviderStrategy()

setContextProviderStrategy

public void setContextProviderStrategy(ContextProviderStrategy<U,CONTEXT> contextProviderStrategy)

getAreaStrategy

public AreaStrategy<AreaType,CONTEXT> getAreaStrategy()

setAreaStrategy

public void setAreaStrategy(AreaStrategy<AreaType,CONTEXT> areaStrategy)

getCurrencyStrategy

public CurrencyStrategy getCurrencyStrategy()

setCurrencyStrategy

public void setCurrencyStrategy(CurrencyStrategy currencyStrategy)

getThrowableToMessage

public org.apache.commons.collections.Transformer getThrowableToMessage()

Marshal errors to just their messages

setThrowableToMessage

public void setThrowableToMessage(org.apache.commons.collections.Transformer throwableToMessage)

Marshal errors to just their messages

getAdapterService

public AdapterService getAdapterService()

Strategies can be Adapters; that can be updated @ runtime. If the ability to modify them @ runtime is desired we can define Strategies as scripts and update then via the AdapterService

Can be null:

true

setAdapterService

public void setAdapterService(AdapterService adapterService)

Strategies can be Adapters; that can be updated @ runtime. If the ability to modify them @ runtime is desired we can define Strategies as scripts and update then via the AdapterService

Can be null:

true

getCartProductTransform

public CartProductTransformService<P,CartItem> getCartProductTransform()

Handle All conversions

See Also:

CartProductTransformService

setCartProductTransform

public void setCartProductTransform(CartProductTransformService<P,CartItem> cartProductTransform)

Handle All conversions

See Also:

CartProductTransformService

onChange

public void onChange(ChangeGenerator changeGenerator,
                     Object context)

Allow Strategies that are ChangeGenerators to modify the session via ContextualSession.setPartialContext(Object)

Specified by:

onChange in interface ChangeListener

Parameters:

changeGenerator - as the generator that caused the change. Specially useful if the Listener is subscribing to multiple ChangeGenerators

context - as the model change communicated

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator