com.broadleafcommerce.enterprise.workflow.admin.service.audit

Class AuditReportServiceImpl

java.lang.Object

com.broadleafcommerce.enterprise.workflow.admin.service.audit.AuditReportServiceImpl

All Implemented Interfaces:

AuditReportService

@Service(value="blAuditReportService")
public class AuditReportServiceImpl
extends Object
implements AuditReportService

Author:

Jeff Fischer

See Also:

AuditReportService

Field Summary

Fields

Modifier and Type	Field and Description
protected AuditLogFileProvider	auditLogFileProvider
protected AuditReportDao	auditReportDao
protected WorkflowAuditService	auditService
protected EnterpriseEventProducer	enterpriseEventProducer
protected EntityItemService	entityItemService
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	eventTransUtil
protected AuditReportServiceExtensionManager	extensionManager
protected WorkflowSandBoxItemService	sandBoxItemService
protected WorkflowSandBoxItemService	sbItemService
protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao	systemEventDao
protected com.broadleafcommerce.jobsevents.service.SystemEventSender	systemEventSender Deprecated. No longer used internally
protected org.springframework.transaction.PlatformTransactionManager	transactionManager
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil

Constructor Summary

Constructors

Constructor and Description
AuditReportServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	appendFooter(AuditLogRequest completed, File merged, boolean weaved)
protected void	buildBasicReportData(StringBuilder reportBuilder, WorkflowSandBoxItem sandBoxItem)
protected void	buildChildItemsReportData(StringBuilder reportBuilder, WorkflowSandBoxItem sandBoxItem)
protected void	buildDeploymentsReportData(StringBuilder reportBuilder, List<WorkflowDeployment> deployments)
protected void	buildDomainChangeLineage(StringBuilder reportBuilder, EntityItem entityItem)
protected void	buildEntityItemReportData(StringBuilder reportBuilder, Long entityItemId)
protected List<WorkflowDeployment>	buildEventsReportData(StringBuilder reportBuilder, WorkflowSandBoxItem sandBoxItem)
protected void	buildLibraryReportData(StringBuilder reportBuilder)
protected void	buildPropertyReportData(StringBuilder reportBuilder, Property property)
String	buildReportData(List<Long> workflowItemIds) Compile the WorkflowSandBoxItem report information.
protected StringBuilder	buildReportFooter(AuditLogRequest completed, boolean weaved)
void	completeReportCompilation() When the system determines that all admin nodes have checked in and uploaded all relevant logs, this method is called to perform the final report compilation steps.
protected File	concatenateLogFiles(Stack<AuditLogNodeRequest> requestStack)
protected List<AuditLogRequest>	findCompletedUploads() This method relies on the DatabaseSystemEventDao to determine if all active nodes in the cluster have checked in.
protected List<Date>	getLogDatesFromItems(List<Long> itemIds)
void	init()
Long	launchAuditReportRequestProcess(List<Long> containerIds, AuditReportType reportType) Start an asynchronous process for retrieval of an audit report (either a standalone log, or a WorkflowSandBoxItem report that includes the log).
protected Blob	prependReportData(AuditReportRequest reportRequest, File merged)
void	remove(Long requestId) Delete an AuditLogRequest instance from the database.
protected void	sendAuditLogRequestEvent(AuditLogRequest request) Deprecated. use EnterpriseEventProducer.initiateAuditLogRequest(AuditLogRequest) instead
protected Date	truncate(Date original)
void	uploadLogs(Long requestId, String hostInfo, List<Date> dates, Map<String,String> additionalInfo) When a admin node consumes the event created in AuditReportService.launchAuditReportRequestProcess(List, AuditReportType), it will call this method in order to upload relevant logs based on the passed in information.
protected File	weaveLogFiles(Stack<AuditLogNodeRequest> requestStack)
protected void	weaveLogLines(BufferedWriter stageFileWriter, BufferedReader mergedReader, BufferedReader nextFileReader, String mergedSuffix, String nextSuffix)

Methods inherited from class java.lang.Object

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

Field Detail

sandBoxItemService

protected WorkflowSandBoxItemService sandBoxItemService

auditReportDao

protected AuditReportDao auditReportDao

systemEventSender

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

Deprecated. No longer used internally

enterpriseEventProducer

protected EnterpriseEventProducer enterpriseEventProducer

auditLogFileProvider

protected AuditLogFileProvider auditLogFileProvider

transactionManager

protected org.springframework.transaction.PlatformTransactionManager transactionManager

eventTransUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil eventTransUtil

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

systemEventDao

protected com.broadleafcommerce.jobsevents.dao.DatabaseSystemEventDao systemEventDao

sbItemService

protected WorkflowSandBoxItemService sbItemService

extensionManager

protected AuditReportServiceExtensionManager extensionManager

entityItemService

protected EntityItemService entityItemService

auditService

protected WorkflowAuditService auditService

Constructor Detail

AuditReportServiceImpl

public AuditReportServiceImpl()

Method Detail

init

@PostConstruct
public void init()

launchAuditReportRequestProcess

@Transactional(value="blTransactionManager")
public Long launchAuditReportRequestProcess(List<Long> containerIds,
                                                                                         AuditReportType reportType)

Description copied from interface: AuditReportService

Start an asynchronous process for retrieval of an audit report (either a standalone log, or a WorkflowSandBoxItem report that includes the log). This method sets up an event that all admin nodes on the cluster will consume. The event consumption requires that the admin node retrieve all the relevant logs related to the workflowSandBoxItemContainerIds.

Specified by:

launchAuditReportRequestProcess in interface AuditReportService

Parameters:

containerIds - the WorkflowSandBoxItem ids that are associated with the log files that should be retrieved

reportType - the type of report (either standalone log or WorkflowSandBoxItem report - including log)

Returns:

the id of the AuditLogRequest instance tracking this request

uploadLogs

@Transactional(value="blTransactionManager")
public void uploadLogs(Long requestId,
                                                                    String hostInfo,
                                                                    List<Date> dates,
                                                                    Map<String,String> additionalInfo)

Description copied from interface: AuditReportService

When a admin node consumes the event created in AuditReportService.launchAuditReportRequestProcess(List, AuditReportType), it will call this method in order to upload relevant logs based on the passed in information.

Specified by:

uploadLogs in interface AuditReportService

Parameters:

requestId - the primary key value of AuditLogRequest

hostInfo - the ip address and host information for this node

dates - the dates requested for log retrieval

additionalInfo - any additional information required by the implementation to effectively upload logs

See Also:

AuditReportRequestEventConsumer

remove

@Transactional(value="blTransactionManager")
public void remove(Long requestId)

Description copied from interface: AuditReportService

Delete an AuditLogRequest instance from the database.

Specified by:

remove in interface AuditReportService

Parameters:

requestId - the primary key value of AuditLogRequest

completeReportCompilation

public void completeReportCompilation()

Description copied from interface: AuditReportService

When the system determines that all admin nodes have checked in and uploaded all relevant logs, this method is called to perform the final report compilation steps. This generally involves weaving together multiple log files from multiple nodes into a single log file based on log line timestamps. It is at this point that AuditLogRequest.getFinalReport() is populated.

Specified by:

completeReportCompilation in interface AuditReportService

buildReportData

@Transactional(value="blTransactionManager")
public String buildReportData(List<Long> workflowItemIds)

Description copied from interface: AuditReportService

Compile the WorkflowSandBoxItem report information. This is used when a AuditReportType.REPORT is requested in AuditReportService.launchAuditReportRequestProcess(List, AuditReportType)

Specified by:

buildReportData in interface AuditReportService

Parameters:

workflowItemIds - the primary key values for the WorkflowSandBoxItem instances used to created the report

Returns:

the compiled text report - does not include log information

buildBasicReportData

protected void buildBasicReportData(StringBuilder reportBuilder,
                                    WorkflowSandBoxItem sandBoxItem)

buildChildItemsReportData

protected void buildChildItemsReportData(StringBuilder reportBuilder,
                                         WorkflowSandBoxItem sandBoxItem)

buildEntityItemReportData

protected void buildEntityItemReportData(StringBuilder reportBuilder,
                                         Long entityItemId)

buildDomainChangeLineage

protected void buildDomainChangeLineage(StringBuilder reportBuilder,
                                        EntityItem entityItem)

buildPropertyReportData

protected void buildPropertyReportData(StringBuilder reportBuilder,
                                       Property property)

buildDeploymentsReportData

protected void buildDeploymentsReportData(StringBuilder reportBuilder,
                                          List<WorkflowDeployment> deployments)

buildEventsReportData

protected List<WorkflowDeployment> buildEventsReportData(StringBuilder reportBuilder,
                                                         WorkflowSandBoxItem sandBoxItem)

buildLibraryReportData

protected void buildLibraryReportData(StringBuilder reportBuilder)

getLogDatesFromItems

protected List<Date> getLogDatesFromItems(List<Long> itemIds)

prependReportData

protected Blob prependReportData(AuditReportRequest reportRequest,
                                 File merged)
                          throws IOException

Throws:

IOException

appendFooter

protected void appendFooter(AuditLogRequest completed,
                            File merged,
                            boolean weaved)
                     throws IOException

Throws:

IOException

concatenateLogFiles

protected File concatenateLogFiles(Stack<AuditLogNodeRequest> requestStack)
                            throws IOException,
                                   SQLException

Throws:

IOException

SQLException

weaveLogFiles

protected File weaveLogFiles(Stack<AuditLogNodeRequest> requestStack)
                      throws IOException,
                             SQLException,
                             LineParseException

Throws:

IOException

SQLException

LineParseException

weaveLogLines

protected void weaveLogLines(BufferedWriter stageFileWriter,
                             BufferedReader mergedReader,
                             BufferedReader nextFileReader,
                             String mergedSuffix,
                             String nextSuffix)
                      throws LineParseException,
                             IOException

Throws:

LineParseException

IOException

buildReportFooter

protected StringBuilder buildReportFooter(AuditLogRequest completed,
                                          boolean weaved)

findCompletedUploads

protected List<AuditLogRequest> findCompletedUploads()

This method relies on the DatabaseSystemEventDao to determine if all active nodes in the cluster have checked in. Subclasses may override to implement alternate methods of detecting log upload completion.

Returns:

Completed requests

truncate

protected Date truncate(Date original)

sendAuditLogRequestEvent

@Deprecated
protected void sendAuditLogRequestEvent(AuditLogRequest request)

Deprecated. use EnterpriseEventProducer.initiateAuditLogRequest(AuditLogRequest) instead

Parameters:

request -