org.broadleafcommerce.core.util.service

Class ResourcePurgeServiceImpl

java.lang.Object

org.broadleafcommerce.core.util.service.ResourcePurgeServiceImpl

All Implemented Interfaces:

ResourcePurgeService

@Service(value="blResourcePurgeService")
public class ResourcePurgeServiceImpl
extends Object
implements ResourcePurgeService

Service capable of deleting old or defunct entities from the persistence layer (e.g. Carts and anonymous Customers). ResourcePurgeService for additional API documentation.

A basic Quartz scheduled job configuration for calling this service can be configured as follows:

<bean id="purgeCartConfig" class="org.springframework.beans.factory.config.MapFactoryBean"> <property name="sourceMap"> <map> <entry key="SECONDS_OLD" value="2592000"/> <entry key="STATUS" value="IN_PROCESS"/> </map> </property> </bean> <p/> <bean id="purgeCartJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject" ref="blResourcePurgeService" /> <property name="targetMethod" value="purgeCarts" /> <property name="arguments"> <list> <ref bean="purgeCartConfig"/> </list> </property> </bean> <p/> <bean id="purgeCartTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean"> <property name="jobDetail" ref="purgeCartJobDetail" /> <property name="startDelay" value="30000" /> <property name="repeatInterval" value="86400000" /> </bean>

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected CustomerService	customerService
protected OrderService	orderService
protected Integer	pageSize
protected ResourcePurgeDao	resourcePurgeDao
protected StreamingTransactionCapableUtil	transUtil

Constructor Summary

Constructors

Constructor and Description
ResourcePurgeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deleteCart(Order cart) Remove the cart from the persistence layer.
protected void	deleteCustomer(Customer customer) Remove the cart from the persistence layer.
protected List<Order>	getCartsToPurge(Map<String,String> config, int startPos, int length) Get the list of carts to delete from the database.
protected Long	getCartsToPurgeLength(Map<String,String> config) Get the count of carts to delete from the database.
protected List<Customer>	getCustomersToPurge(Map<String,String> config, int startPos, int length) Get the list of carts to delete from the database.
protected Long	getCustomersToPurgeLength(Map<String,String> config) Get the count of carts to delete from the database.
Integer	getPageSize() Override the default page size (set by property streaming.transaction.item.page.size) by which entities will be purged.
void	init()
void	purgeCarts(Map<String,String> config) Execute a purge of carts from the persistence layer based on the configuration parameters.
void	purgeCustomers(Map<String,String> config)
void	setPageSize(Integer pageSize) Override the default page size (set by property streaming.transaction.item.page.size) by which entities will be purged.

Methods inherited from class java.lang.Object

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

Field Detail

transUtil

protected StreamingTransactionCapableUtil transUtil

resourcePurgeDao

protected ResourcePurgeDao resourcePurgeDao

orderService

protected OrderService orderService

customerService

protected CustomerService customerService

pageSize

protected Integer pageSize

Constructor Detail

ResourcePurgeServiceImpl

public ResourcePurgeServiceImpl()

Method Detail

init

@PostConstruct
public void init()

purgeCarts

public void purgeCarts(Map<String,String> config)

Description copied from interface: ResourcePurgeService

Execute a purge of carts from the persistence layer based on the configuration parameters. The default implementation is capable of looking at any combination of name, status and creation date. Take a look at org.broadleafcommerce.core.order.service.OrderService#findCarts(String[], org.broadleafcommerce.core.order.service.type.OrderStatus[], java.util.Date, Boolean, int, int) for more info on the default behavior.

Specified by:

purgeCarts in interface ResourcePurgeService

Parameters:

config - Map of params used to drive the selection of carts to purge

purgeCustomers

public void purgeCustomers(Map<String,String> config)

Specified by:

purgeCustomers in interface ResourcePurgeService

getPageSize

public Integer getPageSize()

Description copied from interface: ResourcePurgeService

Override the default page size (set by property streaming.transaction.item.page.size) by which entities will be purged. Candidates are retrieved in pages and deleted a page at a time to minimize transaction times.

Specified by:

getPageSize in interface ResourcePurgeService

Returns:

the page size

setPageSize

public void setPageSize(Integer pageSize)

Description copied from interface: ResourcePurgeService

Override the default page size (set by property streaming.transaction.item.page.size) by which entities will be purged. Candidates are retrieved in pages and deleted a page at a time to minimize transaction times.

Specified by:

setPageSize in interface ResourcePurgeService

Parameters:

pageSize - the page size

getCartsToPurge

protected List<Order> getCartsToPurge(Map<String,String> config,
                          int startPos,
                          int length)

Get the list of carts to delete from the database. Subclasses may override for custom cart retrieval logic.

Parameters:

config - params for the query

Returns:

list of carts to delete

getCartsToPurgeLength

protected Long getCartsToPurgeLength(Map<String,String> config)

Get the count of carts to delete from the database. Subclasses may override for custom cart retrieval logic.

Parameters:

config - params for the query

Returns:

count of carts to delete

deleteCart

protected void deleteCart(Order cart)

Remove the cart from the persistence layer. Subclasses may override for custom cart retrieval logic.

Parameters:

cart - the cart to remove

getCustomersToPurge

protected List<Customer> getCustomersToPurge(Map<String,String> config,
                                 int startPos,
                                 int length)

Get the list of carts to delete from the database. Subclasses may override for custom cart retrieval logic.

Parameters:

config - params for the query

Returns:

list of carts to delete

getCustomersToPurgeLength

protected Long getCustomersToPurgeLength(Map<String,String> config)

Get the count of carts to delete from the database. Subclasses may override for custom cart retrieval logic.

Parameters:

config - params for the query

Returns:

count of carts to delete

deleteCustomer

protected void deleteCustomer(Customer customer)

Remove the cart from the persistence layer. Subclasses may override for custom cart retrieval logic.

Parameters:

customer - the customer to remove