com.broadleafcommerce.enterprise.workflow.admin.persistence.event

Class WorkflowStatePersistenceManagerEventHandler

java.lang.Object

org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

com.broadleafcommerce.enterprise.workflow.admin.persistence.event.WorkflowStatePersistenceManagerEventHandler

All Implemented Interfaces:

ModuleManager, org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler, org.springframework.core.Ordered

@Component(value="blWorkflowModuleManager")
public class WorkflowStatePersistenceManagerEventHandler
extends org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter
implements ModuleManager

Handle PersistenceManager persistence events from the workflow module perspective. This gives the different workflow modules an opportunity to impact the request and alter request data if necessary.

Author:

Jeff Fischer

See Also:

BasicWorkflowPersistenceModule, AdornedTargetListWorkflowPersistenceModule, MapStructureWorkflowPersistenceModule

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheInvalidationProducer	cacheInvalidationProducer
protected EnterpriseEventProducer	enterpriseEventProducer
protected SandBoxHelperImpl	sandBoxHelper
protected WorkflowSandBoxItemService	sbItemService
protected EnterpriseWorkflowLogger	workflowLogger
protected WorkflowManager	workflowManager
protected List<WorkflowPersistenceModule>	workflowModules
protected WorkflowStateManager	workflowStateManager

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
WorkflowStatePersistenceManagerEventHandler()

Method Summary

Modifier and Type	Method and Description
protected void	autoPromote(Long sandBoxItem, org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager)
WorkflowPersistenceModule	getCompatibleWorkflowModule(org.broadleafcommerce.openadmin.server.service.type.ChangeType changeType, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage) Retrieve a WorkflowPersistenceModule using the change type (i.e.
WorkflowPersistenceModule	getCompatibleWorkflowModule(org.broadleafcommerce.common.presentation.client.OperationType operationType) Retrieve a WorkflowPersistenceModule using a type describing the module.
int	getOrder()
void	init()
protected void	invalidateLocalAdminCache(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.Entity original, org.broadleafcommerce.openadmin.dto.Entity response)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	postAdd(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	postFetch(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	postInspect(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	postRemove(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	postUpdate(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	preAdd(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	preFetch(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	preRemove(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	preUpdate(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse	processValidationError(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager, org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Methods inherited from class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

preInspect

Methods inherited from class java.lang.Object

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

Field Detail

workflowModules

protected List<WorkflowPersistenceModule> workflowModules

workflowManager

protected WorkflowManager workflowManager

sbItemService

protected WorkflowSandBoxItemService sbItemService

workflowStateManager

protected WorkflowStateManager workflowStateManager

workflowLogger

protected EnterpriseWorkflowLogger workflowLogger

cacheInvalidationProducer

protected CacheInvalidationProducer cacheInvalidationProducer

enterpriseEventProducer

protected EnterpriseEventProducer enterpriseEventProducer

sandBoxHelper

protected SandBoxHelperImpl sandBoxHelper

Constructor Detail

WorkflowStatePersistenceManagerEventHandler

public WorkflowStatePersistenceManagerEventHandler()

Method Detail

init

@PostConstruct
public void init()

preUpdate

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse preUpdate(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                   org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                            throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

preUpdate in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

preUpdate in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

preAdd

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse preAdd(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                         throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

preAdd in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

preAdd in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

preRemove

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse preRemove(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                   org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                            throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

preRemove in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

preRemove in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

postUpdate

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse postUpdate(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                    org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                    org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                             throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

postUpdate in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

postUpdate in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

processValidationError

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse processValidationError(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                                org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                                org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                                         throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

processValidationError in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

processValidationError in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

postRemove

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse postRemove(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                    org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                             throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

postRemove in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

postRemove in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

postAdd

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse postAdd(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                 org.broadleafcommerce.openadmin.dto.Entity entity,
                                                                                                                 org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                          throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

postAdd in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

postAdd in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

postFetch

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse postFetch(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                   org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet,
                                                                                                                   org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                                                                   org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)
                                                                                                            throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

postFetch in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

postFetch in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

preFetch

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse preFetch(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                  org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                                                                  org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto)
                                                                                                           throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

preFetch in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

preFetch in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

postInspect

public org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerResponse postInspect(org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager,
                                                                                                                     org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet,
                                                                                                                     org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
                                                                                                              throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

postInspect in interface org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandler

Overrides:

postInspect in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

getCompatibleWorkflowModule

public WorkflowPersistenceModule getCompatibleWorkflowModule(org.broadleafcommerce.openadmin.server.service.type.ChangeType changeType,
                                                             org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Description copied from interface: ModuleManager

Retrieve a WorkflowPersistenceModule using the change type (i.e. add, update and delete) and the change request.

Specified by:

getCompatibleWorkflowModule in interface ModuleManager

Parameters:

changeType - add, update or delete

persistencePackage - the change request

Returns:

the found module

getCompatibleWorkflowModule

public WorkflowPersistenceModule getCompatibleWorkflowModule(org.broadleafcommerce.common.presentation.client.OperationType operationType)

Description copied from interface: ModuleManager

Retrieve a WorkflowPersistenceModule using a type describing the module.

Specified by:

getCompatibleWorkflowModule in interface ModuleManager

Parameters:

operationType - module description

Returns:

the found module

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerEventHandlerAdapter

invalidateLocalAdminCache

protected void invalidateLocalAdminCache(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                         org.broadleafcommerce.openadmin.dto.Entity original,
                                         org.broadleafcommerce.openadmin.dto.Entity response)

autoPromote

protected void autoPromote(Long sandBoxItem,
                           org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager persistenceManager)
                    throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException