Uses of Class
com.broadleafcommerce.common.dataexport.domain.Export

Packages that use Export

Package	Description
com.broadleafcommerce.common.dataexport.messaging
com.broadleafcommerce.common.dataexport.service
com.broadleafcommerce.common.dataexport.service.autoconfigure
com.broadleafcommerce.common.dataexport.service.specification
com.broadleafcommerce.common.dataexport.util

Uses of Export in com.broadleafcommerce.common.dataexport.messaging

Methods in com.broadleafcommerce.common.dataexport.messaging that return types with arguments of type Export

Modifier and Type	Method	Description
protected ExportService<Export>	ExportOrphanCheckListener.getExportService()
protected ExportService<Export>	ProcessExportRequestListener.getExportService()

Methods in com.broadleafcommerce.common.dataexport.messaging with parameters of type Export

Modifier and Type	Method	Description
protected void	ExportOrphanCheckListener.setHangingError(Export export)

Constructor parameters in com.broadleafcommerce.common.dataexport.messaging with type arguments of type Export

Constructor	Description
ExportOrphanCheckListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, List<ExportDataRouteSupporting> dataRoutes, ExportService<Export> exportService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)
ProcessExportRequestListener(List<ExportDataRouteSupporting> dataRoutes, ExportService<Export> exportService, ExportManager exportManager)

Uses of Export in com.broadleafcommerce.common.dataexport.service

Classes in com.broadleafcommerce.common.dataexport.service with type parameters of type Export

Modifier and Type	Class	Description
class	DefaultExportService<P extends Export>
interface	ExportService<P extends Export>	Service API for Exports.

Methods in com.broadleafcommerce.common.dataexport.service that return Export

Modifier and Type	Method	Description
protected Export	DefaultExportManager.generateExportFromRequest(ExportRequest request, String target)	Builds an Export and initializes its basic fields from the values in the ExportRequest.
Export	DefaultExportManager.initiateExport(ExportRequest request, String target, String filterString, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Export	ExportManager.initiateExport(ExportRequest request, String target, String filterString, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method accepts an export request and the context of the request to build a Export and persist it in the data store.

Methods in com.broadleafcommerce.common.dataexport.service that return types with arguments of type Export

Modifier and Type	Method	Description
protected ExportService<Export>	DefaultExportManager.getExportService()

Methods in com.broadleafcommerce.common.dataexport.service with parameters of type Export

Modifier and Type	Method	Description
boolean	CSVExportFileWriter.canHandle(Export export)
boolean	ExportFileWriter.canHandle(Export export)	Returns whether the writer can support writing the file for the given export.
boolean	ExportProcessor.canHandle(Export export)	Returns whether this processor can support performing the given export operation.
protected void	DefaultExportManager.copyToStorageServiceAndFinishExport(Path toCopy, Export toUpdate, ExportFileWriter<?> fileWriter)
RowGenerationResponse	ExportProcessor.generateRows(List<P> batchToProcess, Export export)	Accepts a list of objects - this will be a batch subset of the full results returned in ExportProcessor.readRecordsToProcess(Export).
protected String	DefaultExportManager.generateStoragePath(Export export, String fileExtension)
protected Optional<ExportFileWriter<?>>	DefaultExportManager.getFileWriterForExport(Export export)
protected Optional<ExportProcessor<?>>	DefaultExportManager.getProcessorForExport(Export export)
protected void	DefaultExportManager.initializeContextFields(Export target, ExportRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Initializes the context-related fields on the given Export, including the fields describing the context where the operation itself was initiated (such as getApplicationId()), and "exporting context" fields describing the context where the operation will be performed (such as getExportingApplicationId()).
protected void	DefaultExportManager.initializeGeneralFields(Export toInitialize)
void	DefaultExportManager.processExport(Export export)
void	ExportManager.processExport(Export export)	Performs an Export, processing the requested records and writing the file in batches while updating the status for the Export as it goes.
protected <P,C extends ExportFileWriteContext> void	DefaultExportManager.processInBatches(ExportProcessor<P> processor, ExportFileWriter<C> fileWriter, Export export, Path tempFile)
ReadRecordsResponse<P>	ExportProcessor.readRecordsToProcess(Export export)	Returns the full stream of records from the data store that should be processed.
protected void	DefaultExportManager.setTotalRecordsToProcess(Export export)
protected void	DefaultExportManager.validateCanBeExported(Export export)
protected void	DefaultExportManager.validateExportingContextAccessibility(Export export)	Builds a ContextInfo matching the exporting context fields from export, and then evaluates whether the currently authenticated user is allowed to perform the operation in that context.

Constructor parameters in com.broadleafcommerce.common.dataexport.service with type arguments of type Export

Constructor	Description
DefaultExportDownloadService(ExportService<Export> exportService, StorageService storageService)
DefaultExportManager(ExportService<Export> exportService, ExportRequestValidator exportRequestValidator, List<ExportProcessor<?>> exportProcessors, List<ExportFileWriter<?>> exportFileWriters, StorageService storageService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExportProcessingConfigurationProperties exportProcessingConfigurationProperties, com.broadleafcommerce.common.extension.data.DataRouteReference reference, List<com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator> contextRequestHydrators, com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils trackablePolicyUtils)

Uses of Export in com.broadleafcommerce.common.dataexport.service.autoconfigure

Methods in com.broadleafcommerce.common.dataexport.service.autoconfigure that return types with arguments of type Export

Modifier and Type	Method	Description
ExportService<Export>	ExportServiceAutoConfiguration.exportService(ExportRepository<com.broadleafcommerce.data.tracking.core.Identifiable> exportRepository, com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityHelper helper, com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager)

Method parameters in com.broadleafcommerce.common.dataexport.service.autoconfigure with type arguments of type Export

Modifier and Type	Method	Description
ExportDownloadService	ExportServiceAutoConfiguration.exportDownloadService(ExportService<Export> exportService, StorageService storageService)
ExportManager	ExportServiceAutoConfiguration.exportManager(ExportService<Export> exportService, ExportRequestValidator exportRequestValidator, List<ExportProcessor<?>> exportProcessors, List<ExportFileWriter<?>> exportFileWriters, StorageService storageService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExportProcessingConfigurationProperties exportProcessingConfigurationProperties, List<com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator> contextRequestHydrators, com.broadleafcommerce.common.extension.data.DataRouteReference dataRouteReference, com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils trackablePolicyUtils)

Uses of Export in com.broadleafcommerce.common.dataexport.service.specification

Methods in com.broadleafcommerce.common.dataexport.service.specification with parameters of type Export

Modifier and Type	Method	Description
Map<String,String>	AbstractExportRowConverter.convertAndNormalize(S source, Export export)	Converts the given entity to a Map row representation, then executes normalization on the result using all of the ExportDataNormalizers configured in ExportSpecification.getExportDataNormalizers().
Map<String,String>	AbstractExportRowConverter.convertAndNormalize(S source, Export export, Map<String,Object> params)	Converts the given entity to a Map row representation, then executes normalization on the result using all of the ExportDataNormalizers configured in ExportSpecification.getExportDataNormalizers().
void	ExportDataNormalizer.normalize(Map<String,String> row, Export export, Map<String,Object> params)	Normalizes the data under certain headers from ExportDataNormalizer.getHeaderNamesToNormalize().
void	TimeZoneDataNormalizer.normalize(Map<String,String> row, Export export, Map<String,Object> params)
protected void	AbstractExportRowConverter.normalizeExportDataRow(Map<String,String> row, Export export, Map<String,Object> params)

Uses of Export in com.broadleafcommerce.common.dataexport.util

Methods in com.broadleafcommerce.common.dataexport.util with parameters of type Export

Modifier and Type	Method	Description
static String	CommonExportUtils.getUserFriendlyFilenameForExport(Export export)	Creates the user friendly file name for the current export.
static boolean	CommonExportUtils.isExportBelongsToCurrentApplication(Export export, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether or not this export belongs to the application from the context.
static boolean	CommonExportUtils.isExportBelongsToCurrentTenant(Export export, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether or not this export belongs to the tenant from the context.
static boolean	CommonExportUtils.isExportFinished(Export export)	Determines whether or not this export is finished.