Serialized Form

Package com.broadleafcommerce.dataimport.domain

Class com.broadleafcommerce.dataimport.domain.Import

class Import extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The application that the import is initialized on. This can be different than the Import.importingApplicationId.

author

String author

Who is making the change

changeContainer

com.broadleafcommerce.data.tracking.core.filtering.domain.ChangeContainer changeContainer

Metadata used to populate any ChangeEvent created from this request.

errorCount

long errorCount

errorMessage

String errorMessage

If the import as a whole encountered an error and needed to stop, this field holds a description of the error.

fileLocation

String fileLocation

The location to the file that was uploaded representing this import. The binary data from this path can be looked up using the StorageService.

fileType

String fileType

The original file type that this import comes from

See Also:

• DefaultImportFileType

id

String id

The unique ID of this import

importingApplicationId

String importingApplicationId

The application that the import items should go into.

importingCatalogId

String importingCatalogId

The catalog that the import items should go into. Required when importing items that are catalog-discriminated as determined by Import.type.

In the case of hierarchical catalogs, this is most-derived catalog id.

importingCustomerContextId

String importingCustomerContextId

The ID of the customer context that the import items should go into.

importingSandboxId

String importingSandboxId

The sandbox that the import items should go into.

This field only has any meaning if Import.productionImport is false. This should always be null if Import.productionImport is true.

If a new sandbox needs to be created for this import, initially this field's value will be set to null by ImportManager.initiateImport(ImportRequest, InputStreamSource, ContextInfo), but then ImportManager.processImport(String) will generate and initialize a value for it.

As a result, ultimately every non-production import will have a non-null value for this field.

See Also:

• ImportRequest.importingSandboxId
• ImportManager.processImport(String)
• ImportService.createSandbox(String, String)

importingSandboxNameToCreate

String importingSandboxNameToCreate

If and only if a new sandbox needs to be created for the current import (determined using the logic described in Import.importingSandboxId), this field will hold the name of the sandbox that will be created.

If not supplied in the ImportRequest.importingSandboxNameToCreate, the name of the import will be used (will be the generated name if the import name had to be generated as described on ImportRequest.name).

includedHeaders

Set<String> includedHeaders

Restrictive defined headers to use for the import. If null or empty, this assumes that all headers in the import will be used

lastUpdated

Instant lastUpdated

When this import was last touched

name

String name

The name of this import.

parameters

Map<String,Object> parameters

Additional information passed down to each batch to the resource tier. These are attached to each BatchRequest

parentEntityId

String parentEntityId

Certain imports may be responsible for importing entities under a common 'parent entity'. For example, an import of price data should place all the price data entities in the import under the same parent price list.

To make it easier to support such use-cases without requiring the parent entity information to be supplied in the imported file itself, this first-class field is accepted in ImportRequest.getParentEntityId() and eventually passed to the resource-tier batch handler through BatchRequest.BatchContext.getParentEntityId().

Ultimately, the usage of this value is entirely determined by the resource tier handler implementation.

See Also:

• ImportRequest.getParentEntityId()
• BatchRequest.BatchContext.getParentEntityId()

productionImport

boolean productionImport

Whether or not this import should go straight to production or into a sandbox.

See Also:

• Import.importingSandboxId

specificationRef

String specificationRef

Reference to the specification used for this import. Please see ImportSpecificationService and DefaultImportSpecificationService for how this is used.

started

Instant started

When this import was started, meaning the file was being read and batches created

status

ImportStatus status

Current status, see state diagram for statuses as they flow through the system

stopped

Instant stopped

When this import was last stopped

successCount

long successCount

tenantId

String tenantId

The tenant that the import is initialized on.

totalItems

long totalItems

type

String type

Configurable type of this import, like product, catalog, etc

See Also:

• DefaultImportType

vendorRef

String vendorRef

The reference to the vendor associated with this import. This value can be null, in which case, no vendor is associated.

Package com.broadleafcommerce.dataimport.messaging

Class com.broadleafcommerce.dataimport.messaging.CreateSandboxRequest

class CreateSandboxRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The ID of the application that should be set as the owning application of the sandbox.

description

String description

The description for the sandbox that should be created.

sandboxId

String sandboxId

The ID of the sandbox that should be created.

sandboxName

String sandboxName

The name of the sandbox that should be created.

tenantId

String tenantId

The ID of the tenant that should be set as the owning tenant of the sandbox.

token

String token

Class com.broadleafcommerce.dataimport.messaging.DeleteSandboxRequest

class DeleteSandboxRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The ID of the application that owns the sandbox.

See Also:

• Import.importingApplicationId

author

String author

The author of the import (and thus the author who created the sandbox).

See Also:

• Import.author

sandboxId

String sandboxId

The ID of the sandbox that should be deleted.

See Also:

• Import.importingSandboxId

tenantId

String tenantId

The ID of the tenant that owns the sandbox.

See Also:

• Import.tenantId

token

String token

Class com.broadleafcommerce.dataimport.messaging.ProcessImportRequest

class ProcessImportRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

importId

String importId

The ID of the Import that needs to be processed.

See Also:

• Import.id

token

String token

Package com.broadleafcommerce.dataimport.processor

Exception com.broadleafcommerce.dataimport.processor.ImportProcessingException

class ImportProcessingException extends RuntimeException implements Serializable

Package com.broadleafcommerce.dataimport.provider.jpa.domain

Class com.broadleafcommerce.dataimport.provider.jpa.domain.JpaBatch

class JpaBatch extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_items

String _items

The items that should be inserted within this batch.

Stores a List of JpaBatchItem serialized as a JSON in the data store.

Generally speaking, callers should use JpaBatch.getItems() and JpaBatch.setItems(List) and not directly deal with this field. In rare circumstances (such as update queries like JpaCustomizedImportBatchRepository.replaceContainedItems(JpaBatch)), it may make sense to directly modify this value.

Rather than simply annotating the column with the @Convert annotation, we have different methods that manually invoke the BatchItemListConverter. This is because the automatic-conversion does not work properly when using CriteriaUpdate. Hibernate would forcefully attempt to split the list into multiple query parameters and convert the elements individually (in QueryParameterBindingsImpl.expandListValuedParameters(java.lang.String, org.hibernate.engine.spi.SharedSessionContractImplementor)), which caused errors to be thrown.

See Also:

• Batch.items
• JpaBatch.getItems()
• JpaBatch.setItems(List)

completed

Instant completed

created

Instant created

id

String id

importId

String importId

The import that this batch request is associated with

notificationStates

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

status

String status

The overall status of the batch.

This field is persisted as a String to enable flexibility with RSQL filtration.

See Also:

• Batch.status
• JpaBatch.getStatus()
• JpaBatch.setStatus(BatchStatus)

Class com.broadleafcommerce.dataimport.provider.jpa.domain.JpaBatchItemCompletion

class JpaBatchItemCompletion extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

correlationId

String correlationId

Identifier that allows the resource tier to map back responses to a record within the batch.

Intentionally not using the UlidConverter here, since the value may just be the string version of the line number.

errorMessage

String errorMessage

See Also:

• BatchItemCompletion.errorMessage

id

String id

See Also:

• BatchItemCompletion.id

importId

String importId

See Also:

• BatchItemCompletion.importId

lineNumber

long lineNumber

See Also:

• BatchItemCompletion.lineNumber

notificationStates

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

operation

String operation

This field is persisted as a String to enable flexibility with RSQL filtration.

See Also:

• BatchItemCompletion.operation
• JpaBatchItemCompletion.getOperation()
• JpaBatchItemCompletion.setOperation(OperationType)

recordType

String recordType

See Also:

• BatchItemCompletion.recordType

resourceTierIdentifier

String resourceTierIdentifier

Identifier for the record at the resource tier which is associated after the record is persisted

row

Map<String,String> row

See Also:

• BatchItemCompletion.row

status

String status

This field is persisted as a String to enable flexibility with RSQL filtration.

See Also:

• BatchItemCompletion.status
• JpaBatchItemCompletion.getStatus()
• JpaBatchItemCompletion.setStatus(BatchItemStatus)

topLevelParentCorrelationId

String topLevelParentCorrelationId

Intentionally not using the UlidConverter here, since the value may just be the string version of the line number.

See Also:

• BatchItemCompletion.topLevelParentCorrelationId

Class com.broadleafcommerce.dataimport.provider.jpa.domain.JpaImport

class JpaImport extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

See Also:

• Import.applicationId

author

String author

See Also:

• Import.author

changeContainer

com.broadleafcommerce.data.tracking.core.filtering.domain.ChangeContainer changeContainer

See Also:

• Import.changeContainer

errorCount

long errorCount

See Also:

• Import.errorCount

errorMessage

String errorMessage

See Also:

• Import.errorMessage

fileLocation

String fileLocation

See Also:

• Import.fileLocation

fileType

String fileType

See Also:

• Import.fileType

id

String id

See Also:

• Import.id

importingApplicationId

String importingApplicationId

See Also:

• Import.importingApplicationId

importingCatalogId

String importingCatalogId

See Also:

• Import.importingCatalogId

importingCustomerContextId

String importingCustomerContextId

See Also:

• Import.importingCustomerContextId

importingSandboxId

String importingSandboxId

See Also:

• Import.importingSandboxId

importingSandboxNameToCreate

String importingSandboxNameToCreate

See Also:

• Import.importingSandboxNameToCreate

includedHeaders

Set<String> includedHeaders

See Also:

• Import.includedHeaders

lastUpdated

Instant lastUpdated

See Also:

• Import.lastUpdated

name

String name

See Also:

• Import.name

notificationStates

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

parameters

Map<String,Object> parameters

parentEntityId

String parentEntityId

In some import scenarios, the imported entities cannot exist without a parent entity. This field is intended to hold the id of the parent entity common to all of the imported entities. For example: campaign id for campaign codes

See Also:

• Import.parentEntityId

productionImport

boolean productionImport

See Also:

• Import.productionImport

specificationRef

String specificationRef

See Also:

• Import.specificationRef

started

Instant started

See Also:

• Import.started

status

String status

This field is persisted as a String to enable flexibility with RSQL filtration.

See Also:

• Import.status
• JpaImport.getStatus()
• JpaImport.setStatus(ImportStatus)

stopped

Instant stopped

See Also:

• Import.stopped

successCount

long successCount

See Also:

• Import.successCount

tenantId

String tenantId

See Also:

• Import.tenantId

totalItems

long totalItems

See Also:

• Import.totalItems

type

String type

See Also:

• Import.type

vendorRef

String vendorRef

See Also:

• Import.vendorRef

Class com.broadleafcommerce.dataimport.provider.jpa.domain.JpaImportLob

class JpaImportLob extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

id

String id

path

String path

Package com.broadleafcommerce.dataimport.service

Exception com.broadleafcommerce.dataimport.service.ErrorsReportException

class ErrorsReportException extends RuntimeException implements Serializable

Package com.broadleafcommerce.dataimport.web.endpoint

Exception com.broadleafcommerce.dataimport.web.endpoint.ImportEndpoint.IneligibleForErrorsReportException

class IneligibleForErrorsReportException extends RuntimeException implements Serializable

Package com.broadleafcommerce.dataimport.web.endpoint.exception

Exception com.broadleafcommerce.dataimport.web.endpoint.exception.ImportValidationException

class ImportValidationException extends RuntimeException implements Serializable

Serialized Fields

errorResponse

ImportValidationResponse errorResponse

Exception com.broadleafcommerce.dataimport.web.endpoint.exception.ReadOriginalImportFileException

class ReadOriginalImportFileException extends RuntimeException implements Serializable