Index (Broadleaf Data Export Common 2.0.1-GA API)

A B C D E F G H I J L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractExportRowConverter<S> - Class in com.broadleafcommerce.common.dataexport.service.specification: The base class that is used to convert from given value to a Map row representation.
AbstractExportRowConverter(ExportSpecification, ObjectMapper) - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter

B

buildCsvWriterSettings() - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriteContext
buildIdFilter(String, Root<D>, CriteriaBuilder, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
buildStatusFilter(String, Root<D>, CriteriaBuilder, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
buildStatusInFilter(Collection<String>, Root<D>, CriteriaBuilder, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository

C

canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.domain.Export
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
canEqual(Object) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties
canHandle(Export) - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter
canHandle(Export) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportFileWriter: Returns whether the writer can support writing the file for the given export.
canHandle(Export) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportProcessor: Returns whether this processor can support performing the given export operation.
canModifyBeanSerializer(Class<?>) - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: Determine whether or not this specification can be used to modify the bean serializer.
changeProperties(SerializationConfig, BeanDescription, List<BeanPropertyWriter>) - Method in class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier
CHANNEL - Static variable in interface com.broadleafcommerce.common.dataexport.messaging.channel.ProcessExportRequestConsumer
CHANNEL - Static variable in interface com.broadleafcommerce.common.dataexport.messaging.channel.ProcessExportRequestProducer
CHANNEL - Static variable in interface com.broadleafcommerce.common.dataexport.messaging.ExportTriggeredJobEventConsumer
close() - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriteContext
com.broadleafcommerce.common.dataexport.autoconfigure - package com.broadleafcommerce.common.dataexport.autoconfigure
com.broadleafcommerce.common.dataexport.data - package com.broadleafcommerce.common.dataexport.data
com.broadleafcommerce.common.dataexport.domain - package com.broadleafcommerce.common.dataexport.domain
com.broadleafcommerce.common.dataexport.messaging - package com.broadleafcommerce.common.dataexport.messaging
com.broadleafcommerce.common.dataexport.messaging.autoconfigure - package com.broadleafcommerce.common.dataexport.messaging.autoconfigure
com.broadleafcommerce.common.dataexport.messaging.channel - package com.broadleafcommerce.common.dataexport.messaging.channel
com.broadleafcommerce.common.dataexport.messaging.mapping - package com.broadleafcommerce.common.dataexport.messaging.mapping
com.broadleafcommerce.common.dataexport.provider.jpa.autoconfigure - package com.broadleafcommerce.common.dataexport.provider.jpa.autoconfigure
com.broadleafcommerce.common.dataexport.provider.jpa.domain - package com.broadleafcommerce.common.dataexport.provider.jpa.domain
com.broadleafcommerce.common.dataexport.provider.jpa.repository - package com.broadleafcommerce.common.dataexport.provider.jpa.repository
com.broadleafcommerce.common.dataexport.provider.jpa.service - package com.broadleafcommerce.common.dataexport.provider.jpa.service
com.broadleafcommerce.common.dataexport.repository - package com.broadleafcommerce.common.dataexport.repository
com.broadleafcommerce.common.dataexport.service - package com.broadleafcommerce.common.dataexport.service
com.broadleafcommerce.common.dataexport.service.autoconfigure - package com.broadleafcommerce.common.dataexport.service.autoconfigure
com.broadleafcommerce.common.dataexport.service.exception - package com.broadleafcommerce.common.dataexport.service.exception
com.broadleafcommerce.common.dataexport.service.specification - package com.broadleafcommerce.common.dataexport.service.specification
com.broadleafcommerce.common.dataexport.service.specification.custom.serializer - package com.broadleafcommerce.common.dataexport.service.specification.custom.serializer
com.broadleafcommerce.common.dataexport.support - package com.broadleafcommerce.common.dataexport.support
com.broadleafcommerce.common.dataexport.util - package com.broadleafcommerce.common.dataexport.util
com.broadleafcommerce.common.dataexport.web.autoconfigure - package com.broadleafcommerce.common.dataexport.web.autoconfigure
com.broadleafcommerce.common.dataexport.web.exception - package com.broadleafcommerce.common.dataexport.web.exception
CommonExportUtils - Class in com.broadleafcommerce.common.dataexport.util: The common utility that contains some useful methods that can be reused in the export endpoints.
configureMapper(ExportSpecification, ObjectMapper) - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter
contextMissingAuthorResponse() - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Creates the response entity with the error message that currently authenticated user cannot be found.
convertAndNormalize(S, Export) - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter: Converts the given entity to a Map row representation, then executes normalization on the result using all of the ExportDataNormalizers configured in ExportSpecification.getExportDataNormalizers().
convertAndNormalize(S, Export, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter: Converts the given entity to a Map row representation, then executes normalization on the result using all of the ExportDataNormalizers configured in ExportSpecification.getExportDataNormalizers().
copyToStorageServiceAndFinishExport(Path, Export, ExportFileWriter<?>) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
create(P) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService: Overriding to add notification behavior.
createExecutionContext(OutputStream) - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter
createExecutionContext(OutputStream) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportFileWriter: Creates a new instance of an ExportFileWriteContext for writing to the given outputStream.
createMessage(Object) - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestMessageFactory
createTemporaryFile(String, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
CSV - Enum constant in enum class com.broadleafcommerce.common.dataexport.domain.DefaultExportFileType
CSVExportFileWriteContext - Class in com.broadleafcommerce.common.dataexport.service: Holds state information required by CSVExportFileWriter.
CSVExportFileWriteContext(OutputStream) - Constructor for class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriteContext
csvExportFileWriter() - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
CSVExportFileWriter - Class in com.broadleafcommerce.common.dataexport.service: An implementation of ExportFileWriter that can write CSV files.
CSVExportFileWriter() - Constructor for class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter
CustomizedExportRepository<D extends com.broadleafcommerce.data.tracking.core.Identifiable> - Interface in com.broadleafcommerce.common.dataexport.repository: Additional functionality necessary for a ExportRepository.

D

DefaultExportDownloadService - Class in com.broadleafcommerce.common.dataexport.service
DefaultExportDownloadService(ExportService<Export>, StorageService) - Constructor for class com.broadleafcommerce.common.dataexport.service.DefaultExportDownloadService
DefaultExportFileType - Enum Class in com.broadleafcommerce.common.dataexport.domain: Default values that are supported for Export.fileType.
DefaultExportManager - Class in com.broadleafcommerce.common.dataexport.service
DefaultExportManager(ExportService<Export>, ExportRequestValidator, List<ExportProcessor<?>>, List<ExportFileWriter<?>>, StorageService, TypeFactory, ExportProcessingConfigurationProperties, DataRouteReference, List<ContextRequestHydrator>, TrackablePolicyUtils) - Constructor for class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
DefaultExportService - Class in com.broadleafcommerce.common.dataexport.service
DefaultExportService(ExportRepository<Identifiable>, RsqlMappableCrudEntityHelper, NotificationManager) - Constructor for class com.broadleafcommerce.common.dataexport.service.DefaultExportService
determineName(ExportRequest, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager

E

equals(Object) - Method in class com.broadleafcommerce.common.dataexport.domain.Export
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse
equals(Object) - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse
ERROR - Enum constant in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Indicates that the export encountered an error and did not complete successfully.
Export - Class in com.broadleafcommerce.common.dataexport.domain: An entity that holds the basic information required to track the status of an export operation.
Export() - Constructor for class com.broadleafcommerce.common.dataexport.domain.Export
EXPORT_ORPHAN_CHECK_JOBTYPE - Static variable in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
ExportAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.autoconfigure
ExportAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.autoconfigure.ExportAutoConfiguration
ExportDataNormalizer - Interface in com.broadleafcommerce.common.dataexport.service.specification: This interface is used for building a data normalizer, which can be used to pre-process the data before writing to the file.
ExportDataRouteSupporting - Interface in com.broadleafcommerce.common.dataexport.data
exportDownloadService(ExportService<Export>, StorageService) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
ExportDownloadService - Interface in com.broadleafcommerce.common.dataexport.service: Provides the ability to retrieve export files.
exportExceptionAdvisor() - Method in class com.broadleafcommerce.common.dataexport.web.autoconfigure.ExportWebAutoConfiguration
ExportExceptionAdvisor - Class in com.broadleafcommerce.common.dataexport.web.exception
ExportExceptionAdvisor() - Constructor for class com.broadleafcommerce.common.dataexport.web.exception.ExportExceptionAdvisor
ExportFileWriteContext - Class in com.broadleafcommerce.common.dataexport.service: Holds state information particular to a specific export write operation.
ExportFileWriteContext(OutputStream) - Constructor for class com.broadleafcommerce.common.dataexport.service.ExportFileWriteContext
ExportFileWriter<C extends ExportFileWriteContext> - Interface in com.broadleafcommerce.common.dataexport.service: Responsible for writing the headers and rows of an export to a file.
ExportFileWriteResponse - Class in com.broadleafcommerce.common.dataexport.service: Response returned by ExportFileWriter to indicate the results of writing to a file.
ExportJpaAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.provider.jpa.autoconfigure: The main JPA auto configuration that initializes the out of the box JPA repositories.
ExportJpaAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.provider.jpa.autoconfigure.ExportJpaAutoConfiguration
exportManager(ExportService<Export>, ExportRequestValidator, List<ExportProcessor<?>>, List<ExportFileWriter<?>>, StorageService, TypeFactory, ExportProcessingConfigurationProperties, List<ContextRequestHydrator>, DataRouteReference, TrackablePolicyUtils) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
ExportManager - Interface in com.broadleafcommerce.common.dataexport.service: While ExportService is purely in charge of CRUD-related operations on Export, this service is a higher level abstraction that performs the surrounding logic of processing export operations.
ExportMessagingAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.messaging.autoconfigure: Configuration for additional messaging functionality for exports.
ExportMessagingAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ExportMessagingAutoConfiguration
ExportNotificationStateMapperMember - Class in com.broadleafcommerce.common.dataexport.messaging.mapping: Creates the NotificationStateAware.getNotificationStates() for the persistent counterpart of Export.
ExportNotificationStateMapperMember(NotificationStateService) - Constructor for class com.broadleafcommerce.common.dataexport.messaging.mapping.ExportNotificationStateMapperMember
ExportOrphanCheckListener - Class in com.broadleafcommerce.common.dataexport.messaging: A listener that accepts triggered scheduled job events of type ExportOrphanCheckListener.EXPORT_ORPHAN_CHECK_JOBTYPE and adjusts the Export.status of any exports that are hanging to ExportStatus.ERROR.
ExportOrphanCheckListener(IdempotentMessageConsumptionService, List<ExportDataRouteSupporting>, ExportService<Export>, TypeFactory) - Constructor for class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
ExportProcessingConfigurationProperties - Class in com.broadleafcommerce.common.dataexport.service.autoconfigure: Properties that can be used to configure how exports are processed.
ExportProcessingConfigurationProperties() - Constructor for class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties
ExportProcessor - Interface in com.broadleafcommerce.common.dataexport.service: While ExportManager is responsible for most of the coordination during an export, it will delegate to an ExportProcessor for performing the actual target- specific operations.
ExportRepository<D extends com.broadleafcommerce.data.tracking.core.Identifiable> - Interface in com.broadleafcommerce.common.dataexport.repository: Repository for persistent counter-parts of Export
ExportRequest - Class in com.broadleafcommerce.common.dataexport.domain: This is the request DTO which should be sent by API callers to request the creation of a Export.
ExportRequest() - Constructor for class com.broadleafcommerce.common.dataexport.domain.ExportRequest
ExportRequest(String, String, List<String>, List<String>, String, String, String, String, String, String, Map<String, Object>) - Constructor for class com.broadleafcommerce.common.dataexport.domain.ExportRequest
exportRequestValidator() - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
ExportRequestValidator - Class in com.broadleafcommerce.common.dataexport.service: Validates ExportRequest.
ExportRequestValidator() - Constructor for class com.broadleafcommerce.common.dataexport.service.ExportRequestValidator
exportService(ExportRepository<Identifiable>, RsqlMappableCrudEntityHelper, NotificationManager) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
ExportService - Interface in com.broadleafcommerce.common.dataexport.service: Service API for Exports.
ExportServiceAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.service.autoconfigure
ExportServiceAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportServiceAutoConfiguration
ExportSpecification - Interface in com.broadleafcommerce.common.dataexport.service.specification: Describes how an ExportProcessor can handle a particular export.
ExportStatus - Enum Class in com.broadleafcommerce.common.dataexport.support: Represents the status of a Export operation.
ExportTriggeredJobEventConsumer - Interface in com.broadleafcommerce.common.dataexport.messaging: Spring cloud stream messaging interface for receiving triggered job execution from the scheduled job microservice.
ExportWebAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.web.autoconfigure
ExportWebAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.web.autoconfigure.ExportWebAutoConfiguration

F

failure(String) - Static method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse
failure(String) - Static method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse
failure(String) - Static method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse
findByPath(String) - Method in interface com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaExportLobRepository: Finds the exports whose Export.status matches one of the given statuses and whose Export.lastUpdated is before the given cutoff.
findByStatusInAndLastUpdatedBefore(List<String>, Instant) - Method in interface com.broadleafcommerce.common.dataexport.repository.ExportRepository: Finds the exports whose Export.status matches one of the given statuses and whose Export.lastUpdated is before the given cutoff.
findByStatusInAndLastUpdatedBeforeAndTenantId(List<String>, Instant, String) - Method in interface com.broadleafcommerce.common.dataexport.repository.ExportRepository: Finds the exports whose Export.status matches one of the given statuses and whose Export.lastUpdated is before the given cutoff, within the specified tenant.
findByTargetAndApplicationIdAndTenantId(String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.repository.ExportRepository: Reads the exports with the given Export.target and Export.applicationId.
findByTargetAndAuthorAndApplicationIdAndTenantId(String, String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.repository.ExportRepository: Finds the exports with the given Export.target, Export.author, and Export.applicationId.
findByTargetAndAuthorAndApplicationIdAndTenantIdAndParentId(String, String, String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.repository.ExportRepository: Finds the exports with the given Export.target, Export.author, and Export.applicationId.
findNotificationReadyMembers(Object, int, String, Duration, Class<?>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
FINISHED - Enum constant in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Indicates that the export has completed successfully.
fromBusinessDomain(Object, D, ContextInfo) - Method in class com.broadleafcommerce.common.dataexport.messaging.mapping.ExportNotificationStateMapperMember
fromMe() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport

G

generateExportFromRequest(ExportRequest, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager: Builds an Export and initializes its basic fields from the values in the ExportRequest.
generateName(String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
generateRows(List, Export) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportProcessor: Accepts a list of objects - this will be a batch subset of the full results returned in ExportProcessor.readRecordsToProcess(Export).
generateStoragePath(Export, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getAdditionalParameters() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getApplicationId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The application that the export is initialized on.
getApplicationId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getApplicationIdFromContext(ContextInfo) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Gets the application id from the context.
getAuthor() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The email address of the author that initiated this export operation.
getAuthor() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getBatchSize() - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties: The processing of the export is done in batches to constrain the load on the system.
getBusinessDomainType() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getContent() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
getContextRequestHydrators() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getCreated() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The timestamp at which this operation was first created.
getCreated() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getCsvWriter() - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriteContext
getDataRoutePartition() - Method in class com.broadleafcommerce.common.dataexport.messaging.mapping.ExportNotificationStateMapperMember
getDataRoutes() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
getDataRoutes() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestListener
getDomainType() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
getEm() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
getErrorMessage() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: When the Export.status is determined to be ExportStatus.ERROR, this field should be set to contain the reasoning for the failure.
getErrorMessage() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getErrorMessage() - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse: If ExportFileWriteResponse.successful is false, then this should contain a description of the error encountered when attempting to write to the file.
getErrorMessage() - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse: If ReadRecordsResponse.successful is false, then this should contain a description of the error encountered when attempting to read the records.
getErrorMessage() - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse: If RowGenerationResponse.successful is false, then this should contain a description of the error encountered when attempting to produce the rows.
getExclusions() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: A list of context IDs of the entities which should not be exported.
getExclusions() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getExclusions() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getExportDataNormalizers() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: The list of ExportDataNormalizer that will be executed to pre-process the data before writing to the file.
getExportFile(String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportDownloadService
getExportFile(String) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportDownloadService: Returns the export file resource for the given export.
getExportFileWriters() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getExportId() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest: The ID of the Export that needs to be processed.
getExportingApplicationId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the application that that the export's data will be sourced from.
getExportingApplicationId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the application that that the export's data will be sourced from.
getExportingApplicationId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getExportingCatalogId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the catalog that that the export's data will be sourced from.
getExportingCatalogId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the catalog that that the export's data will be sourced from.
getExportingCatalogId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getExportingCustomerContextId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the customer context that the export's data will be sourced from.
getExportingCustomerContextId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the customer context that that the export's data will be sourced from.
getExportingCustomerContextId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getExportingSandboxId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the sandbox that the export's data will be sourced from.
getExportingSandboxId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the sandbox that the export's data will be sourced from.
getExportingSandboxId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getExportLobRepository() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.service.JpaLobStorageService
getExportManager() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestListener
getExportProcessingConfigurationProperties() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getExportProcessors() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getExportRequestValidator() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getExportService() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
getExportService() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestListener
getExportService() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getExportSpecification() - Method in class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier
getFieldConfigMap() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: Maintains a Map of String objects, that will be used to process the rows to an export file.
getFileExtension() - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter
getFileExtension() - Method in interface com.broadleafcommerce.common.dataexport.service.ExportFileWriter: Returns the file extension that should be used for the export file that the writer will be writing to.
getFileLocation() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: After the export file is created, this holds its location in the storage provider.
getFileLocation() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getFileType() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The type of file that the export should ultimately produce for download by the user.
getFileType() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The type of file that the export should ultimately produce for download by the user.
getFileType() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getFileWriterForExport(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getFilterString() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The (by default, RSQL) filter string that should be used to find the records to export.
getFilterString() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getFilterString() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getHANGING_ERROR_MESSAGE() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
getHangingCutoff() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener: This value represents the amount of time that an export is allowed to be idle (in a state of "REQUESTED" or "PROCESSING") before it is considered hanging and set to an error state.
getHeader(String) - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: Returns the value for the given property name.
getHeaderNamesToNormalize() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportDataNormalizer: The list of header names to normalize.
getHeaderNamesToNormalize() - Method in class com.broadleafcommerce.common.dataexport.service.specification.TimeZoneDataNormalizer
getHeaders() - Method in interface com.broadleafcommerce.common.dataexport.service.ExportProcessor: Returns the exhaustive set of headers that this processor may output values for.
getHeaders() - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter: Returns the exhaustive set of headers that specified in ExportSpecification.
getHeaders() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: Returns the exhaustive set of headers that specified in ExportSpecification
getId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The unique identifier of the export operation.
getId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
getIdempotentConsumptionService() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
getInclusions() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: A list of (additional) context IDs of specific entities which should be exported.
getInclusions() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getInclusions() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getLastUpdated() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The timestamp at which this operation last experienced a change.
getLastUpdated() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getMapper() - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter
getName() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The name of the export operation.
getName() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The name of this export.
getName() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getNotification() - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
getNotificationFragment() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
getNotificationManager() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
getNotificationStates() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getNotificationStates(boolean) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getNotificationStateService() - Method in class com.broadleafcommerce.common.dataexport.messaging.mapping.ExportNotificationStateMapperMember
getNumberOfRecordsProcessed() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The number of records that have been successfully processed thus far.
getNumberOfRecordsProcessed() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getOutputStream() - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteContext
getOutputStream(Path) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getParameters() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: Additional parameters for this export.
getParameters() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getParentId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The parent id of the entities to export.
getParentId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getParentId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getPath() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
getProcessorForExport(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getRecords() - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse: If ReadRecordsResponse.successful is true, then this should contain all of the records in the data store that should be processed in the update, as described by ExportProcessor.readRecordsToProcess(Export).
getReference() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getRepository() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
getRetry() - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
getRows() - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse: If RowGenerationResponse.successful is true, then this should contain all of the generated rows.
getSECURE_RANDOM() - Static method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getSpecification() - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter
getSpecificationExportModule(ExportSpecification) - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter
getStatus() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The overall status of the export.
getStatus() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getStorageService() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getTarget() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The target of the export.
getTarget() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getTenantId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The tenant that the export is initialized on.
getTenantId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getTenantIdFromContext(ContextInfo) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Gets the tenant id from the context.
getTimeZoneId() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the time zone that will be used to format any date fields in the exported file.
getTimeZoneId() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
getTimeZoneId() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getToken() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
getTotalRecordsToProcess() - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The total number of records that should be processed.
getTotalRecordsToProcess() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
getTrackablePolicyUtils() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager: Used to validate that the user initiating an operation is able to access the context in which the operation will apply.
getTypeFactory() - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
getTypeFactory() - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
getUserFriendlyFilenameForExport(Export) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Creates the user friendly file name for the current export.
getUTC_TIMESTAMP_FORMATTER() - Static method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager

H

handleEntityMissingException(Exception, WebRequest) - Method in class com.broadleafcommerce.common.dataexport.web.exception.ExportExceptionAdvisor
handleMessage(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
hashCode() - Method in class com.broadleafcommerce.common.dataexport.domain.Export
hashCode() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
hashCode() - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
hashCode() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
hashCode() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
hashCode() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
hashCode() - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties
hashCode() - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse
hashCode() - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse
hashCode() - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse

I

includeHeaders() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: Whether or not include the header in the exported file.
initializeContextFields(Export, ExportRequest, ContextInfo) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager: Initializes the context-related fields on the given Export, including the fields describing the context where the operation itself was initiated (such as Export.getApplicationId()), and "exporting context" fields describing the context where the operation will be performed (such as Export.getExportingApplicationId()).
initializeGeneralFields(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
initiateExport(ExportRequest, String, ContextInfo) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
initiateExport(ExportRequest, String, ContextInfo) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportManager: This method accepts an export request and the context of the request to build a Export and persist it in the data store.
initiateExport(ExportRequest, String, String, ContextInfo) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
initiateExport(ExportRequest, String, String, ContextInfo) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportManager: Deprecated.
since 2.0.1, in favor of ExportManager.initiateExport(ExportRequest, String, ContextInfo). The new implementation for export grids includes the filter string as part of the ExportRequest, instead of passing it as a parameter in the HTTP request.
initSpecification() - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportSpecification: This the main method to initialize this specification.
isExportBelongsToCurrentApplication(Export, ContextInfo) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Determines whether or not this export belongs to the application from the context.
isExportBelongsToCurrentTenant(Export, ContextInfo) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Determines whether or not this export belongs to the tenant from the context.
isExportFinished(Export) - Static method in class com.broadleafcommerce.common.dataexport.util.CommonExportUtils: Determines whether or not this export is finished.
isSuccessful() - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse: True if the write operation completed successfully, false otherwise.
isSuccessful() - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse: True if the records were read successfully, false otherwise.
isSuccessful() - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse: True if the rows were produced successfully, false otherwise.

J

JpaCustomizedExportRepository<D extends JpaExport> - Class in com.broadleafcommerce.common.dataexport.provider.jpa.repository
JpaCustomizedExportRepository(NotificationStateRepositoryFragment) - Constructor for class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
JpaExport - Class in com.broadleafcommerce.common.dataexport.provider.jpa.domain: Persistent counter-part to a Export for use with a JPA datastore.
JpaExport() - Constructor for class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
JpaExportLob - Class in com.broadleafcommerce.common.dataexport.provider.jpa.domain
JpaExportLob() - Constructor for class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
JpaExportLobRepository<D extends JpaExportLob> - Interface in com.broadleafcommerce.common.dataexport.provider.jpa.repository: JPA domain-specific implementation of ExportRepository.
JpaExportRepository<D extends JpaExport> - Interface in com.broadleafcommerce.common.dataexport.provider.jpa.repository: JPA domain-specific implementation of ExportRepository.
JpaLobStorageService<D extends JpaExportLob> - Class in com.broadleafcommerce.common.dataexport.provider.jpa.service: Utilizes Jpa to save and retrieve files for export
JpaLobStorageService(JpaExportLobRepository<D>, TypeFactory) - Constructor for class com.broadleafcommerce.common.dataexport.provider.jpa.service.JpaLobStorageService

L

listen(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener: Queries the data store for all exports with ExportStatus.REQUESTED and ExportStatus.PROCESSING statuses whose Export.lastUpdated is beyond an acceptable threshold from the current time.
logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.common.dataexport.web.exception.ExportExceptionAdvisor

M

MonetaryAmountExportSerializer - Class in com.broadleafcommerce.common.dataexport.service.specification.custom.serializer: Serialize MonetaryAmount to String, during the export.
MonetaryAmountExportSerializer() - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.MonetaryAmountExportSerializer

N

normalize(Map<String, String>, Export, Map<String, Object>) - Method in interface com.broadleafcommerce.common.dataexport.service.specification.ExportDataNormalizer: Normalizes the data under certain headers from ExportDataNormalizer.getHeaderNamesToNormalize().
normalize(Map<String, String>, Export, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.service.specification.TimeZoneDataNormalizer
normalizeExportDataRow(Map<String, String>, Export, Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter

P

PACKAGE_FRAGMENT - Static variable in interface com.broadleafcommerce.common.dataexport.data.ExportDataRouteSupporting
processExport(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
processExport(Export) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportManager: Performs an Export, processing the requested records and writing the file in batches while updating the status for the Export as it goes.
ProcessExportRequest - Class in com.broadleafcommerce.common.dataexport.messaging: A message representing a request to perform (actually process) an Export.
ProcessExportRequest(String) - Constructor for class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
ProcessExportRequestConsumer - Interface in com.broadleafcommerce.common.dataexport.messaging.channel: Spring cloud data channel description for messaging output.
processExportRequestInput() - Method in interface com.broadleafcommerce.common.dataexport.messaging.channel.ProcessExportRequestConsumer
ProcessExportRequestListener - Class in com.broadleafcommerce.common.dataexport.messaging: A listener that accepts a ProcessExportRequest and performs the export.
ProcessExportRequestListener(List<ExportDataRouteSupporting>, ExportService<Export>, ExportManager) - Constructor for class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestListener
processExportRequestMessageFactory(DomainMapperManager) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationAutoConfiguration
ProcessExportRequestMessageFactory - Class in com.broadleafcommerce.common.dataexport.messaging: MessageFactory for creating ProcessExportRequest messages.
ProcessExportRequestMessageFactory(DomainMapperManager) - Constructor for class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestMessageFactory
ProcessExportRequestNotificationAutoConfiguration - Class in com.broadleafcommerce.common.dataexport.messaging.autoconfigure: Configure the durable notification components for ProcessExportRequestProducer.
ProcessExportRequestNotificationAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationAutoConfiguration
processExportRequestNotificationHandler(ProcessExportRequestProducer, ProcessExportRequestNotificationProperties, List<IgnoredNotificationStateRepository>, MessageFactory<ProcessExportRequest>, MessageSerializationHelper) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationAutoConfiguration
ProcessExportRequestNotificationProperties - Class in com.broadleafcommerce.common.dataexport.messaging.autoconfigure: Configuration properties for the NotificationHandler and RetryHandler for ProcessExportRequestProducer.
ProcessExportRequestNotificationProperties() - Constructor for class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
processExportRequestOutput() - Method in interface com.broadleafcommerce.common.dataexport.messaging.channel.ProcessExportRequestProducer
ProcessExportRequestProducer - Interface in com.broadleafcommerce.common.dataexport.messaging.channel: Spring cloud data channel description for messaging output.
processExportRequestRetryClusterService(CamelClusterService, ProcessExportRequestNotificationProperties, ExportRepository<?>, NotificationHandler, List<IgnoredNotificationStateRepository>, DataRouteReference) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationAutoConfiguration
processInBatches(ExportProcessor, ExportFileWriter<C>, Export, Path) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
PROCESSING - Enum constant in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Indicates that the export is currently being processed.

R

read(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.service.JpaLobStorageService
read(String) - Method in interface com.broadleafcommerce.common.dataexport.service.StorageService: Reads out previously-stored data with StorageService.store(InputStream, String)
readByTargetAndApplicationIdAndTenantId(String, String, String, Node, Pageable) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
readByTargetAndApplicationIdAndTenantId(String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Reads the exports with the given Export.target and Export.applicationId.
readByTargetAndAuthorAndApplicationIdAndTenantId(String, String, String, String, Node, Pageable) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
readByTargetAndAuthorAndApplicationIdAndTenantId(String, String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Reads the exports with the given Export.target, Export.author, and Export.applicationId.
readByTargetAndAuthorAndApplicationIdAndTenantIdAndParentId(String, String, String, String, String, Node, Pageable) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
readByTargetAndAuthorAndApplicationIdAndTenantIdAndParentId(String, String, String, String, String, Node, Pageable) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Reads the exports with the given Export.target, Export.author, and Export.applicationId.
readIncompleteLastUpdatedBefore(Instant) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
readIncompleteLastUpdatedBefore(Instant) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Reads the exports which are incomplete (those with status ExportStatus.REQUESTED or ExportStatus.PROCESSING) whose Export.lastUpdated is before the given cutoff.
readIncompleteLastUpdatedBeforeAndTenantId(Instant, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
readIncompleteLastUpdatedBeforeAndTenantId(Instant, String) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Reads the exports which are incomplete (those with status ExportStatus.REQUESTED or ExportStatus.PROCESSING) whose Export.lastUpdated is before the given cutoff, within the specified tenant.
ReadRecordsResponse - Class in com.broadleafcommerce.common.dataexport.service: A response returned by ExportProcessor.readRecordsToProcess(Export) indicating the results of attempting to read all of the records to process in an export.
readRecordsToProcess(Export) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportProcessor: Returns the full stream of records from the data store that should be processed.
remove(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.service.JpaLobStorageService
remove(String) - Method in interface com.broadleafcommerce.common.dataexport.service.StorageService: Deletes the resource at the given path
REQUESTED - Enum constant in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Indicates that the export has been created, but has not yet begun processing.
resolveCurrency(Object) - Method in class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer
RowGenerationResponse - Class in com.broadleafcommerce.common.dataexport.service: A response returned by ExportProcessor.generateRows(List, Export) indicating the results of producing some rows in an export.

S

save(Object) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
saveAll(Iterable<?>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
scaleAmount(BigDecimal, CurrencyUnit) - Method in class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer
serialize(Iterable<? extends CharSequence>, JsonGenerator, SerializerProvider) - Method in class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.SimpleExportCollectionSerializer
serialize(Object, JsonGenerator, SerializerProvider) - Method in class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer
serialize(MonetaryAmount, JsonGenerator, SerializerProvider) - Method in class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.MonetaryAmountExportSerializer
setAdditionalParameters(Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setApplicationId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The application that the export is initialized on.
setApplicationId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setAuthor(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The email address of the author that initiated this export operation.
setAuthor(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setBatchSize(int) - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties: The processing of the export is done in batches to constrain the load on the system.
setContent(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
setCreated(Instant) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The timestamp at which this operation was first created.
setCreated(Instant) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setError(String, String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setError(String, String) - Method in interface com.broadleafcommerce.common.dataexport.repository.CustomizedExportRepository: Atomically finds and updates the given export: finds the export with the ID matching the given export, sets the export's Export.errorMessage to the given value, sets Export.status to ExportStatus.ERROR, and renews Export.lastUpdated.
setError(String, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
setError(String, String) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Atomically finds and updates the given export: finds the export with the ID matching the given export, sets the export's Export.errorMessage to the given value, sets Export.status to ExportStatus.ERROR, and renews Export.lastUpdated.
setErrorMessage(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: When the Export.status is determined to be ExportStatus.ERROR, this field should be set to contain the reasoning for the failure.
setErrorMessage(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setExclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: A list of context IDs of the entities which should not be exported.
setExclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setExclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setExportingApplicationId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the application that that the export's data will be sourced from.
setExportingApplicationId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the application that that the export's data will be sourced from.
setExportingApplicationId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setExportingCatalogId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the catalog that that the export's data will be sourced from.
setExportingCatalogId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the catalog that that the export's data will be sourced from.
setExportingCatalogId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setExportingCustomerContextId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the customer context that the export's data will be sourced from.
setExportingCustomerContextId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the customer context that that the export's data will be sourced from.
setExportingCustomerContextId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setExportingSandboxId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the sandbox that the export's data will be sourced from.
setExportingSandboxId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The ID of the sandbox that the export's data will be sourced from.
setExportingSandboxId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setFailedNotificationAttempt(Object, String, int, Instant, Class<?>, boolean) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setFileLocation(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: After the export file is created, this holds its location in the storage provider.
setFileLocation(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setFileLocationAndFinishedStatus(String, String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setFileLocationAndFinishedStatus(String, String) - Method in interface com.broadleafcommerce.common.dataexport.repository.CustomizedExportRepository: Atomically sets the Export.status to ExportStatus.FINISHED, sets the Export.fileLocation to fileLocation, and renews Export.lastUpdated if the export is found and has a Export.status of ExportStatus.PROCESSING.
setFileLocationAndFinishedStatus(String, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
setFileLocationAndFinishedStatus(String, String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
setFileLocationAndFinishedStatus(String, String) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Atomically finds and updates the export with the given exportId: sets the Export.status to ExportStatus.FINISHED, sets the Export.fileLocation to fileLocation, and renews Export.lastUpdated.
setFileType(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The type of file that the export should ultimately produce for download by the user.
setFileType(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The type of file that the export should ultimately produce for download by the user.
setFileType(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setFilterString(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The (by default, RSQL) filter string that should be used to find the records to export.
setFilterString(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setFilterString(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setHangingCutoff(Duration) - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener: This value represents the amount of time that an export is allowed to be idle (in a state of "REQUESTED" or "PROCESSING") before it is considered hanging and set to an error state.
setHangingError(Export) - Method in class com.broadleafcommerce.common.dataexport.messaging.ExportOrphanCheckListener
setId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The unique identifier of the export operation.
setId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
setInclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: A list of (additional) context IDs of specific entities which should be exported.
setInclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setInclusions(List<String>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setLastUpdated(Instant) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The timestamp at which this operation last experienced a change.
setLastUpdated(Instant) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setName(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The name of the export operation.
setName(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest: The name of this export.
setName(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setNotification(NotificationProperties) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
setNotificationAcknowledged(Object, String, int, Class<?>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setNotificationStates(List<NotificationState>) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setNumberOfRecordsProcessed(long) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The number of records that have been successfully processed thus far.
setNumberOfRecordsProcessed(long) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setNumberOfRecordsProcessed(String, long) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setNumberOfRecordsProcessed(String, long) - Method in interface com.broadleafcommerce.common.dataexport.repository.CustomizedExportRepository: Atomically sets the Export.numberOfRecordsProcessed to the given value and renews Export.lastUpdated if the export is found and has a Export.status of ExportStatus.PROCESSING.
setNumberOfRecordsProcessed(String, long) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
setNumberOfRecordsProcessed(String, long) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Atomically finds and updates the export with the given exportId: sets Export.numberOfRecordsProcessed to the given value and renews Export.lastUpdated.
setParameters(Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: Additional parameters for this export.
setParameters(Map<String, Object>) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setParentId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The parent id of the entities to export.
setParentId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setParentId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setPath(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
setProcessingStatus(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.repository.JpaCustomizedExportRepository
setProcessingStatus(String) - Method in interface com.broadleafcommerce.common.dataexport.repository.CustomizedExportRepository: Atomically update Export.status to ExportStatus.PROCESSING and renew Export.lastUpdated if the current Export.status is ExportStatus.REQUESTED.
setProcessingStatus(String) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportService
setProcessingStatus(String) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportService: Atomically finds and updates the export with the given exportId, setting the Export.status to ExportStatus.PROCESSING and renewing Export.lastUpdated.
setRetry(RetryProperties) - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
setStatus(ExportStatus) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The overall status of the export.
setStatus(ExportStatus) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setTarget(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The target of the export.
setTarget(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setTenantId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The tenant that the export is initialized on.
setTenantId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setTimeZoneId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The ID of the time zone that will be used to format any date fields in the exported file.
setTimeZoneId(String) - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
setTimeZoneId(String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setToken(String) - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
setTotalRecordsToProcess(long) - Method in class com.broadleafcommerce.common.dataexport.domain.Export: The total number of records that should be processed.
setTotalRecordsToProcess(long) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
setTotalRecordsToProcess(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
SimpleExportCollectionSerializer - Class in com.broadleafcommerce.common.dataexport.service.specification.custom.serializer: Joins the elements of the provided Iterable into a single String containing the provided elements separated with a specified separator.
SimpleExportCollectionSerializer() - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.SimpleExportCollectionSerializer: Construct the serializer with default "|" separator.
SimpleExportCollectionSerializer(String) - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.SimpleExportCollectionSerializer: Construct the serializer with a specified separator.
SpecificationCurrencyAwareBigDecimalSerializer() - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer
SpecificationPropertiesSerializerModifier - Class in com.broadleafcommerce.common.dataexport.service.specification: Excludes properties, that do not exist in the specification, during serialization and converts property names to header names.
SpecificationPropertiesSerializerModifier(ExportSpecification) - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier
SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer - Class in com.broadleafcommerce.common.dataexport.service.specification: The custom serializer that is used to serialize BigDecimal price to String value.
SpecificationPropertiesSerializerModifier.SpecificationPropertyWriter - Class in com.broadleafcommerce.common.dataexport.service.specification: Extension needed to get ability to create new BeanPropertyWriter with new property name.
SpecificationPropertyWriter(BeanPropertyWriter, String) - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationPropertyWriter
startExport(ProcessExportRequest) - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequestListener: Delegates to ExportService.setProcessingStatus(String) and ExportManager.processExport(Export).
StorageService - Interface in com.broadleafcommerce.common.dataexport.service
store(InputStream, String) - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.service.JpaLobStorageService
store(InputStream, String) - Method in interface com.broadleafcommerce.common.dataexport.service.StorageService: Stores a stream to a backing provider, overwriting any data existing at the path
success() - Static method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse
success(List<Map<String, String>>) - Static method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse
success(Stream) - Static method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse

T

TimeZoneDataNormalizer - Class in com.broadleafcommerce.common.dataexport.service.specification: This normalizer is used to format the date values for specified time-zone.
TimeZoneDataNormalizer(List<String>) - Constructor for class com.broadleafcommerce.common.dataexport.service.specification.TimeZoneDataNormalizer
toMe() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
toString() - Method in class com.broadleafcommerce.common.dataexport.domain.Export
toString() - Method in class com.broadleafcommerce.common.dataexport.domain.ExportRequest
toString() - Method in class com.broadleafcommerce.common.dataexport.messaging.autoconfigure.ProcessExportRequestNotificationProperties
toString() - Method in class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest
toString() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport
toString() - Method in class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob
toString() - Method in class com.broadleafcommerce.common.dataexport.service.autoconfigure.ExportProcessingConfigurationProperties
toString() - Method in class com.broadleafcommerce.common.dataexport.service.ExportFileWriteResponse
toString() - Method in class com.broadleafcommerce.common.dataexport.service.ReadRecordsResponse
toString() - Method in class com.broadleafcommerce.common.dataexport.service.RowGenerationResponse
triggeredJobEventInputOrphanExport() - Method in interface com.broadleafcommerce.common.dataexport.messaging.ExportTriggeredJobEventConsumer
TYPE - Static variable in interface com.broadleafcommerce.common.dataexport.messaging.channel.ProcessExportRequestProducer

U

UnknownExportTargetException - Exception in com.broadleafcommerce.common.dataexport.service.exception
UnknownExportTargetException(String) - Constructor for exception com.broadleafcommerce.common.dataexport.service.exception.UnknownExportTargetException

V

validate(ExportRequest, Errors) - Method in class com.broadleafcommerce.common.dataexport.service.ExportRequestValidator: Validates the fields of the request and registers errorMessage in errorMessage.
validateCanBeExported(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager
validateExportingContextAccessibility(Export) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager: 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.
validateExportRequest(ExportRequest) - Method in class com.broadleafcommerce.common.dataexport.service.DefaultExportManager: Validates the ExportRequest, throwing a ValidationException in the event that there is a validation failure.
validateFileType(Errors) - Method in class com.broadleafcommerce.common.dataexport.service.ExportRequestValidator
valueOf(String) - Static method in enum class com.broadleafcommerce.common.dataexport.domain.DefaultExportFileType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.common.dataexport.domain.DefaultExportFileType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.common.dataexport.support.ExportStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

writeHeaders(LinkedHashSet<String>, C) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportFileWriter: Writes the given headers to the output file.
writeHeaders(LinkedHashSet<String>, CSVExportFileWriteContext) - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter
writeRows(List<Map<String, String>>, C) - Method in interface com.broadleafcommerce.common.dataexport.service.ExportFileWriter: Writes the given rows to the export file.
writeRows(List<Map<String, String>>, CSVExportFileWriteContext) - Method in class com.broadleafcommerce.common.dataexport.service.CSVExportFileWriter

A B C D E F G H I J L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form