com.broadleafcommerce.enterprise.workflow.admin.service.event.consumer

Class ScheduledDeploySystemEventConsumer

java.lang.Object

com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

com.broadleafcommerce.enterprise.workflow.admin.service.event.consumer.ScheduledDeploySystemEventConsumer

All Implemented Interfaces:

com.broadleafcommerce.jobsevents.service.EntityManagerFactoryAwareSystemEventConsumer, com.broadleafcommerce.jobsevents.service.SystemEventConsumer, org.springframework.core.Ordered

Direct Known Subclasses:

RecurringScheduledDeploySystemEventConsumer

@Service(value="blScheduledDeploySystemEventConsumer")
public class ScheduledDeploySystemEventConsumer
extends com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

Handles a scheduled deployment event from the enterprise admin. Is responsible for iterating through all the WorkflowSandBoxItem instances that were scheduled and replaying their associated changes on production. Once this consumer is finished with its work, the changes are available for customers to see in the production environment.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.openadmin.server.security.service.AdminSecurityService	adminSecurityService
static String	APPROVAL_PROCESS_TYPE
protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao	databaseSystemEventDao
protected org.broadleafcommerce.common.util.DeployBehaviorUtil	deployBehaviorUtil
protected javax.persistence.EntityManager	em
protected String	emailDistro
protected org.broadleafcommerce.common.email.service.EmailService	emailService
protected com.broadleafcommerce.enterprise.common.extension.EnterpriseStateManager	enterpriseStateManager
protected org.springframework.context.MessageSource	messageSource
protected com.broadleafcommerce.jobsevents.service.ProcessStatusManager	processStatusManager
protected org.broadleafcommerce.common.sandbox.service.SandBoxService	sandBoxService
protected WorkflowSandBoxItemService	sbItemService
protected org.broadleafcommerce.common.email.service.info.EmailInfo	scheduledDeploymentFailureEmailInfo
protected org.broadleafcommerce.common.email.service.info.EmailInfo	scheduledDeploymentSuccessEmailInfo
protected com.broadleafcommerce.jobsevents.service.SystemEventSender	systemEventSender Deprecated. No longer used internally
protected WorkflowEventService	workflowEventService
protected EnterpriseWorkflowLogger	workflowLogger
protected WorkflowManager	workflowManager

Fields inherited from class com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

entityManagerFactory

Fields inherited from interface com.broadleafcommerce.jobsevents.service.SystemEventConsumer

DEFAULT_PRECEDENCE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ScheduledDeploySystemEventConsumer()

Method Summary

Modifier and Type	Method and Description
protected WorkflowDeployment	attemptDeploy(com.broadleafcommerce.jobsevents.domain.SystemEvent event, WorkflowDeployment deployment)
protected Map<String,Object>	buildEmailVars(com.broadleafcommerce.jobsevents.domain.SystemEvent systemEvent, String message, org.broadleafcommerce.common.sandbox.domain.SandBox sandBox, Date deployDate)
protected List<? extends org.springframework.security.core.GrantedAuthority>	buildGrantedAuthoritiesForPromote(org.broadleafcommerce.openadmin.server.security.domain.AdminUser adminUser) Sets the default admin permission - provides a hook for additional promotion level permission concerns.
void	consumeEvent(com.broadleafcommerce.jobsevents.domain.SystemEvent event)
protected void	deploy(WorkflowDeployment workflowDeployment, org.broadleafcommerce.common.site.domain.Site site, Long[] convertedItems, String message, org.broadleafcommerce.openadmin.server.security.domain.AdminUser adminUser, TimeZone tz, org.broadleafcommerce.common.locale.domain.Locale locale, Map<String,Long> prodAddedItems)
String	getEventType()
protected void	sendTransactionalEmail(org.broadleafcommerce.common.email.service.info.EmailInfo emailInfo, Map<String,Object> vars)
protected void	setupDeploy(com.broadleafcommerce.jobsevents.domain.SystemEvent event, WorkflowDeployment deployment)
protected WorkflowDeployment	setupProcessStatusManager(com.broadleafcommerce.jobsevents.domain.SystemEvent event)
protected boolean	shouldResumeOnException(Exception e) Subclasses can override for a more targeted determination of whether or not a promotion attempt should be resumed based on the exception.
protected Long[]	sortItems(Long[] convertedItems, List<Long> themeFiles)
protected boolean	startDeployment(WorkflowDeployment deployment)

Methods inherited from class com.broadleafcommerce.jobsevents.service.AbstractSystemEventConsumer

getEntityManagerFactory, getOrder, setEntityManagerFactory

Methods inherited from class java.lang.Object

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

Field Detail

APPROVAL_PROCESS_TYPE

public static final String APPROVAL_PROCESS_TYPE

See Also:

Constant Field Values

workflowManager

protected WorkflowManager workflowManager

workflowEventService

protected WorkflowEventService workflowEventService

adminSecurityService

protected org.broadleafcommerce.openadmin.server.security.service.AdminSecurityService adminSecurityService

em

protected javax.persistence.EntityManager em

emailDistro

@Value(value="${workflow.scheduled.deploy.transactional.email.distro}")
protected String emailDistro

emailService

protected org.broadleafcommerce.common.email.service.EmailService emailService

scheduledDeploymentSuccessEmailInfo

protected org.broadleafcommerce.common.email.service.info.EmailInfo scheduledDeploymentSuccessEmailInfo

scheduledDeploymentFailureEmailInfo

protected org.broadleafcommerce.common.email.service.info.EmailInfo scheduledDeploymentFailureEmailInfo

sandBoxService

protected org.broadleafcommerce.common.sandbox.service.SandBoxService sandBoxService

sbItemService

protected WorkflowSandBoxItemService sbItemService

messageSource

protected org.springframework.context.MessageSource messageSource

workflowLogger

protected EnterpriseWorkflowLogger workflowLogger

systemEventSender

@Deprecated
protected com.broadleafcommerce.jobsevents.service.SystemEventSender systemEventSender

Deprecated. No longer used internally

enterpriseStateManager

protected com.broadleafcommerce.enterprise.common.extension.EnterpriseStateManager enterpriseStateManager

databaseSystemEventDao

protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao databaseSystemEventDao

deployBehaviorUtil

protected org.broadleafcommerce.common.util.DeployBehaviorUtil deployBehaviorUtil

processStatusManager

protected com.broadleafcommerce.jobsevents.service.ProcessStatusManager processStatusManager

Constructor Detail

ScheduledDeploySystemEventConsumer

public ScheduledDeploySystemEventConsumer()

Method Detail

consumeEvent

public void consumeEvent(com.broadleafcommerce.jobsevents.domain.SystemEvent event)

setupDeploy

protected void setupDeploy(com.broadleafcommerce.jobsevents.domain.SystemEvent event,
                           WorkflowDeployment deployment)

attemptDeploy

protected WorkflowDeployment attemptDeploy(com.broadleafcommerce.jobsevents.domain.SystemEvent event,
                                           WorkflowDeployment deployment)
                                    throws Exception

Throws:

Exception

sortItems

protected Long[] sortItems(Long[] convertedItems,
                           List<Long> themeFiles)

startDeployment

protected boolean startDeployment(WorkflowDeployment deployment)

setupProcessStatusManager

protected WorkflowDeployment setupProcessStatusManager(com.broadleafcommerce.jobsevents.domain.SystemEvent event)

shouldResumeOnException

protected boolean shouldResumeOnException(Exception e)

Subclasses can override for a more targeted determination of whether or not a promotion attempt should be resumed based on the exception.

Parameters:

e -

Returns:

deploy

protected void deploy(WorkflowDeployment workflowDeployment,
                      org.broadleafcommerce.common.site.domain.Site site,
                      Long[] convertedItems,
                      String message,
                      org.broadleafcommerce.openadmin.server.security.domain.AdminUser adminUser,
                      TimeZone tz,
                      org.broadleafcommerce.common.locale.domain.Locale locale,
                      Map<String,Long> prodAddedItems)
               throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

buildEmailVars

protected Map<String,Object> buildEmailVars(com.broadleafcommerce.jobsevents.domain.SystemEvent systemEvent,
                                            String message,
                                            org.broadleafcommerce.common.sandbox.domain.SandBox sandBox,
                                            Date deployDate)

buildGrantedAuthoritiesForPromote

protected List<? extends org.springframework.security.core.GrantedAuthority> buildGrantedAuthoritiesForPromote(org.broadleafcommerce.openadmin.server.security.domain.AdminUser adminUser)

Sets the default admin permission - provides a hook for additional promotion level permission concerns.

Returns:

sendTransactionalEmail

protected void sendTransactionalEmail(org.broadleafcommerce.common.email.service.info.EmailInfo emailInfo,
                                      Map<String,Object> vars)

getEventType

public String getEventType()