Serialized Form
-
Package com.broadleafcommerce.bulk.domain
-
Class com.broadleafcommerce.bulk.domain.BulkUpdate extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
applicationId
String applicationId
The context ID of the application that this bulk update operation was initiated from. -
author
String author
The email address of the author that initiated this bulk update operation. Derived from the current security principal when receiving aBulkUpdateRequest
. -
created
Instant created
The timestamp at which this operation was first created. -
errors
List<BulkUpdateError> errors
When theBulkUpdate.status
is determined to beBulkUpdateStatus.ERROR
, this field should be set to contain the reasoning for the failure.- See Also:
BulkUpdate.status
-
exclusions
List<String> exclusions
A list of context IDs of the entities which should not receive updates. This would be a filter to exclude any entities that are targeted for updating byBulkUpdate.filterString
/BulkUpdate.inclusions
.Note: how to interpret
BulkUpdate.filterString
,BulkUpdate.inclusions
, andBulkUpdate.exclusions
is entirely left toBulkUpdateProcessor
implementations. -
filterString
String filterString
The (by default, RSQL) filter string that should be used to find the records to update.Note: how to interpret
BulkUpdate.filterString
,BulkUpdate.inclusions
, andBulkUpdate.exclusions
is entirely left toBulkUpdateProcessor
implementations. -
id
String id
The unique identifier of the bulk update operation. -
inclusions
List<String> inclusions
A list of (additional) context IDs of specific entities which should receive updates.Note: how to interpret
BulkUpdate.filterString
,BulkUpdate.inclusions
, andBulkUpdate.exclusions
is entirely left toBulkUpdateProcessor
implementations. -
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 updates. The value of this field will be compared against a timeout for operations that are marked asBulkUpdateStatus.REQUESTED
orBulkUpdateStatus.PROCESSING
in order to determine whether an operation is hanging or failed. -
name
String name
The name of the bulk update operation. -
numberOfRecordsProcessed
long numberOfRecordsProcessed
The number of records that have been successfully processed thus far. This value should be updated as progress is made. -
productionBulkUpdate
boolean productionBulkUpdate
Set to true if the bulk update changes should go directly to production. This is primarily intended for non-sandboxable entities. -
serializedPayload
String serializedPayload
The serialized representation of the requested changes to be made. This can vary greatly in structure - based on the value ofBulkUpdate.type
, the proper understanding and application of these changes is left to the logic that will actually apply the updates. -
status
BulkUpdateStatus status
The overall status of the bulk update. This value should be updated as progress is made.- See Also:
BulkUpdateStatus
,BulkUpdate.errors
-
target
String target
The target of the bulk update. This is some value that can be mapped to a particular domain by the logic performing an update, rather than requiring explicit persistence of the fully qualified classname. An example of a value would be"PRODUCT"
or"CATEGORY"
- See Also:
BulkUpdateTarget
-
tenantId
String tenantId
The context ID of the tenant that this bulk update operation was initiated from. -
totalRecordsToProcess
long totalRecordsToProcess
The total number of records that should be processed. This can be used in conjunction withBulkUpdate.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 update). -
type
String type
The type of change that this update will be performing. This will be used by the logic that applies the updates to determine what needs to be done withBulkUpdate.serializedPayload
. -
updatingApplicationId
String updatingApplicationId
The ID of the application in which the update will be applied. -
updatingCatalogId
String updatingCatalogId
The ID of the catalog in which the update will be applied. -
updatingCustomerContextId
String updatingCustomerContextId
The ID of the customer context in which the update will be applied. -
updatingSandboxId
String updatingSandboxId
The ID of the sandbox in which the update will be applied.- See Also:
BulkUpdate.updatingSandboxName
-
updatingSandboxName
String updatingSandboxName
The name of the new sandbox to create in which the update will be applied. Ignored ifBulkUpdate.productionBulkUpdate
is true.- See Also:
BulkUpdate.updatingSandboxId
-
-
Class com.broadleafcommerce.bulk.domain.BulkUpdateError extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
description
String description
A message describing the error encountered. -
recordId
String recordId
IfBulkUpdateError.type
isBulkUpdateErrorType.RECORD
, this value should hold the ID of the record that experienced the error. -
recordType
String recordType
IfBulkUpdateError.type
isBulkUpdateErrorType.RECORD
, this value should hold the domain/type of the record that experienced the error. -
stackTrace
String stackTrace
The string representation of the stacktrace. -
type
String type
The type of error that was encountered.- See Also:
BulkUpdateErrorType
-
-
Class com.broadleafcommerce.bulk.domain.BulkUpdateRequest extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
exclusions
List<String> exclusions
- See Also:
BulkUpdate.exclusions
-
inclusions
List<String> inclusions
- See Also:
BulkUpdate.inclusions
-
name
String name
- See Also:
BulkUpdate.name
-
payload
String payload
-
productionBulkUpdate
boolean productionBulkUpdate
- See Also:
BulkUpdate.isProductionBulkUpdate()
-
type
String type
- See Also:
BulkUpdate.type
-
updatingApplicationId
String updatingApplicationId
The ID of the application in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
. -
updatingCatalogId
String updatingCatalogId
The ID of the catalog in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
. -
updatingCustomerContextId
String updatingCustomerContextId
The ID of the customer context in which the update will be applied.If not supplied, the value will be sourced from the request's
ContextInfo
. -
updatingSandboxName
String updatingSandboxName
- See Also:
BulkUpdate.getUpdatingSandboxName()
-
-
-
Package com.broadleafcommerce.bulk.messaging
-
Class com.broadleafcommerce.bulk.messaging.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.- See Also:
BulkUpdate.updatingApplicationId
-
description
String description
The description for the sandbox that should be created. -
sandboxId
String sandboxId
The ID of the sandbox that should be created.- See Also:
BulkUpdate.updatingSandboxId
-
sandboxName
String sandboxName
The name of the sandbox that should be created.- See Also:
BulkUpdate.updatingSandboxName
-
tenantId
String tenantId
The ID of the tenant that should be set as the owning tenant of the sandbox.- See Also:
BulkUpdate.tenantId
-
token
String token
-
-
Class com.broadleafcommerce.bulk.messaging.DeleteSandboxRequest extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
applicationId
String applicationId
The ID of the application that owns the sandbox.- See Also:
BulkUpdate.updatingApplicationId
-
author
String author
The author of the bulk update (and thus the author who created the sandbox).- See Also:
BulkUpdate.author
-
sandboxId
String sandboxId
The ID of the sandbox that should be deleted.- See Also:
BulkUpdate.updatingSandboxId
-
tenantId
String tenantId
The ID of the tenant that owns the sandbox.- See Also:
BulkUpdate.tenantId
-
token
String token
-
-
Class com.broadleafcommerce.bulk.messaging.ProcessBulkUpdateRequest extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
bulkUpdateId
String bulkUpdateId
The ID of theBulkUpdate
that needs to be processed.- See Also:
BulkUpdate.id
-
token
String token
-
-
-
Package com.broadleafcommerce.bulk.provider.jpa.domain
-
Class com.broadleafcommerce.bulk.provider.jpa.domain.JpaBulkUpdate extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
_errors
String _errors
Stores aList
ofJpaBulkUpdateError
serialized as a JSON in the data store.Generally speaking, callers should use
JpaBulkUpdate.getErrors()
andJpaBulkUpdate.setErrors(List)
and not directly deal with this field. In rare circumstances (such as update queries likeJpaCustomizedBulkUpdateRepository.setContainedErrors(JpaBulkUpdate)
), 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 theBulkUpdateErrorListConverter
. This is because the automatic-conversion does not work properly when usingCriteriaUpdate
. Hibernate would forcefully attempt to split the list into multiple query parameters and convert the elements individually (inQueryParameterBindingsImpl.expandListValuedParameters(java.lang.String, org.hibernate.engine.spi.SharedSessionContractImplementor)
), which caused errors to be thrown. -
applicationId
String applicationId
- See Also:
BulkUpdate.getApplicationId()
-
author
String author
- See Also:
BulkUpdate.getAuthor()
-
created
Instant created
- See Also:
BulkUpdate.getCreated()
-
exclusions
List<String> exclusions
- See Also:
BulkUpdate.getExclusions()
-
filterString
String filterString
- See Also:
BulkUpdate.getFilterString()
-
id
String id
- See Also:
BulkUpdate.getId()
-
inclusions
List<String> inclusions
- See Also:
BulkUpdate.getInclusions()
-
lastUpdated
Instant lastUpdated
- See Also:
BulkUpdate.getLastUpdated()
-
name
String name
- See Also:
BulkUpdate.getName()
-
notificationStates
List<? super com.broadleafcommerce.data.tracking.jpa.filtering.domain.JpaNotificationState> notificationStates
- See Also:
NotificationStateAware.getNotificationStates()
-
numberOfRecordsProcessed
long numberOfRecordsProcessed
- See Also:
BulkUpdate.getNumberOfRecordsProcessed()
-
productionBulkUpdate
boolean productionBulkUpdate
-
serializedPayload
String serializedPayload
- See Also:
BulkUpdate.getSerializedPayload()
-
status
String status
This field is persisted as aString
to enable flexibility with RSQL filtration. -
target
String target
- See Also:
BulkUpdate.getTarget()
-
tenantId
String tenantId
- See Also:
BulkUpdate.getTenantId()
-
totalRecordsToProcess
long totalRecordsToProcess
- See Also:
BulkUpdate.getTotalRecordsToProcess()
-
type
String type
- See Also:
BulkUpdate.getType()
-
updatingApplicationId
String updatingApplicationId
- See Also:
BulkUpdate.getUpdatingApplicationId()
-
updatingCatalogId
String updatingCatalogId
- See Also:
BulkUpdate.getUpdatingCatalogId()
-
updatingCustomerContextId
String updatingCustomerContextId
-
updatingSandboxId
String updatingSandboxId
- See Also:
BulkUpdate.getUpdatingSandboxId()
-
updatingSandboxName
String updatingSandboxName
- See Also:
BulkUpdate.getUpdatingSandboxName()
-
-
Class com.broadleafcommerce.bulk.provider.jpa.domain.JpaBulkUpdateError extends Object implements Serializable
- serialVersionUID:
- 1L
-
Serialized Fields
-
description
String description
- See Also:
BulkUpdateError.description
-
recordId
String recordId
- See Also:
BulkUpdateError.recordId
-
recordType
String recordType
- See Also:
BulkUpdateError.recordType
-
stackTrace
String stackTrace
- See Also:
BulkUpdateError.stackTrace
-
type
String type
- See Also:
BulkUpdateError.type
-
-