de.hybris.platform.auditreport.service.impl

Class DefaultAuditReportDataService

java.lang.Object

de.hybris.platform.auditreport.service.impl.DefaultAuditReportDataService

All Implemented Interfaces:

AuditReportDataService

public class DefaultAuditReportDataService
extends java.lang.Object
implements AuditReportDataService

This service uses instances of ReportViewConverterStrategy to generate a zip file containing files generated by all of the strategies. The generated files contain representations of the ReportView's obtained for a given configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FILE_NAME
protected static java.lang.String	ZIP_EXTENSION
protected static java.lang.String	ZIP_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultAuditReportDataService()

Method Summary

Modifier and Type	Method and Description
protected byte[]	compressContent(java.util.Map<java.lang.String,byte[]> filesByName) Creates a byte array representation of ZIP archive.
AuditReportDataModel	createReport(CreateAuditReportParams params) Creates a new report for given parameters.
protected java.lang.String	createReportFileName() Creates report file name which always ends with ".zip".
protected java.util.List<ReportView>	createReportsViews(ItemModel item, java.lang.String configName, boolean audit, java.util.Collection<LanguageModel> includedLanguages) Creates reports views for given item specified and configuration name.
void	deleteReportsForItem(ItemModel item) Deletes all reports generated for given ItemModel
protected java.util.Map<java.lang.String,byte[]>	evaluateStrategies(java.util.List<ReportView> reports, java.util.Map<java.lang.String,java.lang.Object> context) Creates a map which stores binary representation of the reports (keys = files names).
AuditViewService	getAuditViewService()
protected FlexibleSearchService	getFlexibleSearchService()
MediaService	getMediaService()
ModelService	getModelService()
java.lang.String	getReportFileName()
java.lang.String	getReportFolderName()
java.util.List<ReportViewConverterStrategy>	getReportViewConverterStrategies()
UserService	getUserService()
protected java.util.Map<java.lang.String,java.lang.Object>	populateReportGenerationContext(ItemModel rootItem, java.lang.String configName, java.lang.String reportId, AuditReportTemplateModel template) Populates context map that will be passed to the report generation procedure.
protected AuditReportDataModel	saveReport(ItemModel rootItem, java.lang.String reportId, java.lang.String configName, byte[] content) Saves an audit report with given identifier and content.
void	setAuditViewService(AuditViewService auditViewService)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setMediaService(MediaService mediaService)
void	setModelService(ModelService modelService)
void	setReportFileName(java.lang.String reportFileName) Sets a name of the ZIP archive saved in the report media.
void	setReportFolderName(java.lang.String reportFolderName)
void	setReportViewConverterStrategies(java.util.List<ReportViewConverterStrategy> reportViewConverterStrategies)
void	setUserService(UserService userService)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

See Also:

Constant Field Values

ZIP_MIME_TYPE

protected static final java.lang.String ZIP_MIME_TYPE

See Also:

Constant Field Values

ZIP_EXTENSION

protected static final java.lang.String ZIP_EXTENSION

See Also:

Constant Field Values

Constructor Detail

DefaultAuditReportDataService

public DefaultAuditReportDataService()

Method Detail

createReport

public AuditReportDataModel createReport(CreateAuditReportParams params)

Description copied from interface: AuditReportDataService

Creates a new report for given parameters. The created report is saved in database before return.

Specified by:

createReport in interface AuditReportDataService

Parameters:

params - parameters needed to generate the report.

Returns:

the new report with audit data.

deleteReportsForItem

public void deleteReportsForItem(ItemModel item)

Description copied from interface: AuditReportDataService

Deletes all reports generated for given ItemModel

Specified by:

deleteReportsForItem in interface AuditReportDataService

Parameters:

item - item to be used to lookup reports

populateReportGenerationContext

protected java.util.Map<java.lang.String,java.lang.Object> populateReportGenerationContext(ItemModel rootItem,
                                                                                           java.lang.String configName,
                                                                                           java.lang.String reportId,
                                                                                           AuditReportTemplateModel template)

Populates context map that will be passed to the report generation procedure.

Parameters:

rootItem - for which item / user the report is generated.

configName - name of the configuration that was used to generate the report.

reportId - name of the report.

template - template used to generate the report view.

Returns:

a map of values available in the report generation.

evaluateStrategies

protected java.util.Map<java.lang.String,byte[]> evaluateStrategies(java.util.List<ReportView> reports,
                                                                    java.util.Map<java.lang.String,java.lang.Object> context)

Creates a map which stores binary representation of the reports (keys = files names). It uses converter strategies to convert reports to binary format.

Parameters:

reports - the list with reports to convert.

context - context object to pass in data to the used generation strategies.

Returns:

the map with files.

See Also:

getReportViewConverterStrategies()

createReportsViews

protected java.util.List<ReportView> createReportsViews(ItemModel item,
                                                        java.lang.String configName,
                                                        boolean audit,
                                                        java.util.Collection<LanguageModel> includedLanguages)

Creates reports views for given item specified and configuration name.

Parameters:

item - the item for which report will be generated.

configName - the configuration name used to create a new report.

audit - if set to true the generated report will contain audit data. Otherwise data snapshot will be taken.

includedLanguages - all mentioned languages will be included in the report. Other languages will be omitted. In case no language is set all available languages will be exported.

Returns:

reports views.

compressContent

protected byte[] compressContent(java.util.Map<java.lang.String,byte[]> filesByName)
                          throws java.io.IOException

Creates a byte array representation of ZIP archive.

Parameters:

filesByName - the map where keys store files names and values store files content.

Returns:

the input stream which represents ZIP archive.

Throws:

java.io.IOException - if any I/O error occurred.

saveReport

protected AuditReportDataModel saveReport(ItemModel rootItem,
                                          java.lang.String reportId,
                                          java.lang.String configName,
                                          byte[] content)

Saves an audit report with given identifier and content. Reports are stored in folder returned by getReportFileName().

Parameters:

rootItem - item for which the report is generated

reportId - the report identifier.

configName - name of the AuditReportConfigModel used to generate report

content - the content saved in report media. @return the saved audit report.

createReportFileName

protected java.lang.String createReportFileName()

Creates report file name which always ends with ".zip".

Returns:

the report file name.

getReportFileName

public java.lang.String getReportFileName()

setReportFileName

public void setReportFileName(java.lang.String reportFileName)

Sets a name of the ZIP archive saved in the report media. By default the service uses DEFAULT_FILE_NAME. If file name does not end with ".zip" extension, then it will be appended.

Parameters:

reportFileName - the ZIP archive name.

getAuditViewService

public AuditViewService getAuditViewService()

setAuditViewService

public void setAuditViewService(AuditViewService auditViewService)

getMediaService

public MediaService getMediaService()

setMediaService

public void setMediaService(MediaService mediaService)

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getReportViewConverterStrategies

public java.util.List<ReportViewConverterStrategy> getReportViewConverterStrategies()

setReportViewConverterStrategies

public void setReportViewConverterStrategies(java.util.List<ReportViewConverterStrategy> reportViewConverterStrategies)

getReportFolderName

public java.lang.String getReportFolderName()

setReportFolderName

public void setReportFolderName(java.lang.String reportFolderName)

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)