Serialized Form

Package com.broadleafcommerce.common.dataexport.domain

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

class Export extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The application that the export is initialized on. This can be different than the Export.exportingApplicationId.

author

String author

The email address of the author that initiated this export operation. Derived from the current security principal when receiving an ExportRequest.

created

Instant created

The timestamp at which this operation was first created.

errorMessage

String errorMessage

When the Export.status is determined to be ExportStatus.ERROR, this field should be set to contain the reasoning for the failure.

See Also:

• Export.status

exclusions

List<String> exclusions

A list of context IDs of the entities which should not be exported. This would be a filter to exclude any entities that are targeted for updating by Export.filterString/Export.inclusions.

Note: how to interpret Export.filterString, Export.inclusions, and Export.exclusions is entirely left to ExportProcessor implementations.

See Also:

• Export.filterString
• Export.inclusions
• ExportProcessor.readRecordsToProcess(Export)

exportingApplicationId

String exportingApplicationId

The ID of the application that that the export's data will be sourced from.

exportingCatalogId

String exportingCatalogId

The ID of the catalog that that the export's data will be sourced from.

exportingCustomerContextId

String exportingCustomerContextId

The ID of the customer context that the export's data will be sourced from.

exportingSandboxId

String exportingSandboxId

The ID of the sandbox that the export's data will be sourced from.

fileLocation

String fileLocation

After the export file is created, this holds its location in the storage provider.

fileType

String fileType

The type of file that the export should ultimately produce for download by the user.

See Also:

• DefaultExportFileType

filterString

String filterString

The (by default, RSQL) filter string that should be used to find the records to export.

Note: how to interpret Export.filterString, Export.inclusions, and Export.exclusions is entirely left to ExportProcessor implementations.

See Also:

• Export.exclusions
• Export.inclusions
• ExportProcessor.readRecordsToProcess(Export)

id

String id

The unique identifier of the export operation.

inclusions

List<String> inclusions

A list of (additional) context IDs of specific entities which should be exported.

Note: how to interpret Export.filterString, Export.inclusions, and Export.exclusions is entirely left to ExportProcessor implementations.

See Also:

• Export.filterString
• Export.exclusions
• ExportProcessor.readRecordsToProcess(Export)

lastUpdated

Instant lastUpdated

The timestamp at which this operation last experienced a change. This is very important, and should be constantly updated by the logic responsible for performing the actual entity exports. The value of this field will be compared against a timeout for operations that are marked as ExportStatus.REQUESTED or ExportStatus.PROCESSING in order to determine whether an operation is hanging or failed.

name

String name

The name of the export operation.

numberOfRecordsProcessed

long numberOfRecordsProcessed

The number of records that have been successfully processed thus far. This value should be updated as progress is made.

parameters

Map<String,Object> parameters

Additional parameters for this export.

parentId

String parentId

The parent id of the entities to export. This should be specified if the entities to export belong to some parent entity.

status

ExportStatus status

The overall status of the export. This value should be updated as progress is made.

See Also:

• ExportStatus
• Export.errorMessage

target

String target

The target of the export. This is some value that can be mapped to a particular domain by the logic performing the export, rather than requiring explicit persistence of the fully qualified classname. An example of a value would be "PRODUCT" or "CATEGORY"

tenantId

String tenantId

The tenant that the export is initialized on.

timeZoneId

String timeZoneId

The ID of the time zone that will be used to format any date fields in the exported file. If null, will default to UTC.

See Also:

• TimeZoneDataNormalizer

totalRecordsToProcess

long totalRecordsToProcess

The total number of records that should be processed. This can be used in conjunction with Export.numberOfRecordsProcessed to determine progress. This value should be determined before a request is made (ideally by running a count query that determines how many records will be targeted by the export).

Class com.broadleafcommerce.common.dataexport.domain.ExportRequest

class ExportRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

exclusions

List<String> exclusions

See Also:

• Export.exclusions

exportingApplicationId

String exportingApplicationId

The ID of the application that that the export's data will be sourced from.

If not supplied, the value will be sourced from the request's ContextInfo.

See Also:

• DefaultExportManager.initiateExport(ExportRequest, String, String, ContextInfo)
• Export.getExportingApplicationId()

exportingCatalogId

String exportingCatalogId

The ID of the catalog that that the export's data will be sourced from.

If not supplied, the value will be sourced from the request's ContextInfo.

See Also:

• DefaultExportManager.initiateExport(ExportRequest, String, String, ContextInfo)
• Export.getExportingCatalogId()

exportingCustomerContextId

String exportingCustomerContextId

The ID of the customer context that that the export's data will be sourced from.

If not supplied, the value will be sourced from the request's ContextInfo.

See Also:

• DefaultExportManager.initiateExport(ExportRequest, String, String, ContextInfo)
• Export.getExportingCustomerContextId()

exportingSandboxId

String exportingSandboxId

The ID of the sandbox that the export's data will be sourced from.

If not supplied, the value will be sourced from the request's ContextInfo.

See Also:

• DefaultExportManager.initiateExport(ExportRequest, String, String, ContextInfo)
• Export.getExportingSandboxId()

fileType

String fileType

The type of file that the export should ultimately produce for download by the user.

See Also:

• Export.fileType

filterString

String filterString

See Also:

• Export.getFilterString()

inclusions

List<String> inclusions

See Also:

• Export.inclusions

name

String name

The name of this export. If this is left null, a name will be generated with the following format:

$target + " - " + $timestamp

See Also:

• Export.name
• Export.target

parameters

Map<String,Object> parameters

See Also:

• Export.getParameters()

parentId

String parentId

See Also:

• Export.getParentId()

timeZoneId

String timeZoneId

See Also:

• Export.getTimeZoneId()

Package com.broadleafcommerce.common.dataexport.messaging

Class com.broadleafcommerce.common.dataexport.messaging.ProcessExportRequest

class ProcessExportRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

exportId

String exportId

The ID of the Export that needs to be processed.

See Also:

• Export.id

token

String token

Package com.broadleafcommerce.common.dataexport.provider.jpa.domain

Class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExport

class JpaExport extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalParameters

Map<String,Object> additionalParameters

applicationId

String applicationId

author

String author

created

Instant created

errorMessage

String errorMessage

exclusions

List<String> exclusions

exportingApplicationId

String exportingApplicationId

exportingCatalogId

String exportingCatalogId

exportingCustomerContextId

String exportingCustomerContextId

exportingSandboxId

String exportingSandboxId

fileLocation

String fileLocation

fileType

String fileType

filterString

String filterString

id

String id

inclusions

List<String> inclusions

lastUpdated

Instant lastUpdated

name

String name

notificationStates

List<? super com.broadleafcommerce.data.tracking.jpa.filtering.domain.JpaNotificationState> notificationStates

See Also:

• NotificationStateAware.getNotificationStates()

numberOfRecordsProcessed

long numberOfRecordsProcessed

parentId

String parentId

status

String status

target

String target

tenantId

String tenantId

timeZoneId

String timeZoneId

totalRecordsToProcess

long totalRecordsToProcess

Class com.broadleafcommerce.common.dataexport.provider.jpa.domain.JpaExportLob

class JpaExportLob extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

id

String id

path

String path

Package com.broadleafcommerce.common.dataexport.service.exception

Exception com.broadleafcommerce.common.dataexport.service.exception.UnknownExportTargetException

class UnknownExportTargetException extends RuntimeException implements Serializable

Package com.broadleafcommerce.common.dataexport.service.specification

Class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationCurrencyAwareBigDecimalSerializer

class SpecificationCurrencyAwareBigDecimalSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Object> implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.common.dataexport.service.specification.SpecificationPropertiesSerializerModifier.SpecificationPropertyWriter

class SpecificationPropertyWriter extends com.fasterxml.jackson.databind.ser.BeanPropertyWriter implements Serializable

Package com.broadleafcommerce.common.dataexport.service.specification.custom.serializer

Class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.MonetaryAmountExportSerializer

class MonetaryAmountExportSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<javax.money.MonetaryAmount> implements Serializable

Class com.broadleafcommerce.common.dataexport.service.specification.custom.serializer.SimpleExportCollectionSerializer

class SimpleExportCollectionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Iterable<? extends CharSequence>> implements Serializable

Serialized Fields

separator

String separator