Serialized Form

Package com.broadleafcommerce.bulk.domain

Class com.broadleafcommerce.bulk.domain.BulkUpdate

class 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 a BulkUpdateRequest.

created

Instant created

The timestamp at which this operation was first created.

errors

List<BulkUpdateError> errors

When the BulkUpdate.status is determined to be BulkUpdateStatus.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 by BulkUpdate.filterString/BulkUpdate.inclusions.

Note: how to interpret BulkUpdate.filterString, BulkUpdate.inclusions, and BulkUpdate.exclusions is entirely left to BulkUpdateProcessor implementations.

See Also:

• BulkUpdate.filterString
• BulkUpdate.inclusions
• BulkUpdateProcessor.readRecordsToProcess(BulkUpdate)

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, and BulkUpdate.exclusions is entirely left to BulkUpdateProcessor implementations.

See Also:

• BulkUpdate.exclusions
• BulkUpdate.inclusions
• BulkUpdateProcessor.readRecordsToProcess(BulkUpdate)

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, and BulkUpdate.exclusions is entirely left to BulkUpdateProcessor implementations.

See Also:

• BulkUpdate.filterString
• BulkUpdate.exclusions
• BulkUpdateProcessor.readRecordsToProcess(BulkUpdate)

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 as BulkUpdateStatus.REQUESTED or BulkUpdateStatus.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 of BulkUpdate.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 with BulkUpdate.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 with BulkUpdate.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 if BulkUpdate.productionBulkUpdate is true.

See Also:

• BulkUpdate.updatingSandboxId

Class com.broadleafcommerce.bulk.domain.BulkUpdateError

class BulkUpdateError extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

A message describing the error encountered.

recordId

String recordId

If BulkUpdateError.type is BulkUpdateErrorType.RECORD, this value should hold the ID of the record that experienced the error.

recordType

String recordType

If BulkUpdateError.type is BulkUpdateErrorType.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

class 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

See Also:

• BulkUpdate.serializedPayload
• JsonToStringDeserializer

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.

See Also:

• BulkUpdate.getUpdatingApplicationId()
• DefaultBulkUpdateManager.initiateBulkUpdate(BulkUpdateRequest, String, String, 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.

See Also:

• BulkUpdate.getUpdatingCatalogId()
• DefaultBulkUpdateManager.initiateBulkUpdate(BulkUpdateRequest, String, String, 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.

See Also:

• BulkUpdate.getUpdatingCustomerContextId()
• DefaultBulkUpdateManager.initiateBulkUpdate(BulkUpdateRequest, String, String, ContextInfo)

updatingSandboxName

String updatingSandboxName

See Also:

• BulkUpdate.getUpdatingSandboxName()

Package com.broadleafcommerce.bulk.messaging

Class com.broadleafcommerce.bulk.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.

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

class 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

class ProcessBulkUpdateRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bulkUpdateId

String bulkUpdateId

The ID of the BulkUpdate 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

class JpaBulkUpdate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_errors

String _errors

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

Generally speaking, callers should use JpaBulkUpdate.getErrors() and JpaBulkUpdate.setErrors(List) and not directly deal with this field. In rare circumstances (such as update queries like JpaCustomizedBulkUpdateRepository.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 the BulkUpdateErrorListConverter. 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:

• BulkUpdate.getErrors()
• JpaBulkUpdate.getErrors()
• JpaBulkUpdate.setErrors(List)

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 a String to enable flexibility with RSQL filtration.

See Also:

• BulkUpdate.getStatus()
• JpaBulkUpdate.getStatus()
• JpaBulkUpdate.setStatus(BulkUpdateStatus)

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

See Also:

• BulkUpdate.getUpdatingCustomerContextId()

updatingSandboxId

String updatingSandboxId

See Also:

• BulkUpdate.getUpdatingSandboxId()

updatingSandboxName

String updatingSandboxName

See Also:

• BulkUpdate.getUpdatingSandboxName()

Class com.broadleafcommerce.bulk.provider.jpa.domain.JpaBulkUpdateError

class 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

Package com.broadleafcommerce.bulk.v2.domain

Class com.broadleafcommerce.bulk.v2.domain.BulkOperationItemResponse

class BulkOperationItemResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bulkOperationId

String bulkOperationId

The unique identifier of the bulk operation.

entityContextId

String entityContextId

The context ID of the entity for this item.

errorDetail

String errorDetail

Details on the error(s) encountered during processing.

errorMessage

String errorMessage

The error message if this item failed processing.

id

String id

The unique identifier of the bulk operation item.

processingAttributes

Map<String,Object> processingAttributes

Miscellaneous attributes for the processing of this item.

state

String state

The current state of this item.

Class com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest

class BulkOperationRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

The author of these bulk operation changes.

entityType

String entityType

The type of entity to operate on. Optional.

exclusions

List<String> exclusions

A list of entity context IDs which should not receive updates. The entities for these IDs will be filtered out after performing a search based on the query & filters.

filters

List<SearchFilter> filters

A list of search filters to identify the entities to operate on.

inclusions

List<String> inclusions

A list of entity context IDs which should receive updates. If this list is populated, the search filters & query are ignored in favor of this list.

isTemporarySandbox

boolean isTemporarySandbox

Whether the sandbox is temporary and should be deleted after the bulk operation is complete.

name

String name

The friendly name of the bulk operation.

operationData

Map<String,Object> operationData

Map holding any additional attributes passed in the request not matching any defined properties.

operationType

String operationType

The type of bulk operation to perform.

query

String query

The search query string to lookup searchable entities to operate on. Optional.

sandboxId

String sandboxId

The ID of the sandbox these changes should be contained within.

Class com.broadleafcommerce.bulk.v2.domain.BulkOperationResponse

class BulkOperationResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The id of the application this bulk operation was initiated from, if any. Note that if this id is not supplied then that implies a tenant-level operation and a catalog ID is required.

attributes

Map<String,Object> attributes

Miscellaneous attributes for this bulk operation.

catalogId

String catalogId

The id of the catalog this bulk operation is scoped within, if any.

createDate

Instant createDate

The timestamp when this bulk operation was created.

creatingUser

String creatingUser

The identity of the creator of this bulk operation. See ContextInfo.getAuthor().

entityType

String entityType

The type of entity that is associated with the bulk operation.

errorCount

long errorCount

The number of records that had errors during processing.

id

String id

The unique identifier of the bulk operation.

name

String name

The friendly name of the bulk operation.

operationContext

String operationContext

The context provided with the bulk operation.

operationData

Map<String,Object> operationData

Additional data to be passed for performing this bulk operation.

operationStatus

String operationStatus

The current status of the bulk operation.

operationStatusHistory

List<OperationStatusHistoryResponse> operationStatusHistory

A detailed historical list of statuses for this bulk operation.

operationSubStatus

String operationSubStatus

The current sub-status of the bulk operation.

operationType

String operationType

The type of operation being performed during the bulk operation.

sandboxId

String sandboxId

The id of the sandbox this bulk operation is executed within.

successCount

long successCount

The number of records that were successfully processed.

tenantId

String tenantId

The id of the tenant this bulk operation was initiated from.

totalRecords

long totalRecords

The total records to be processed by this bulk operation.

updateDate

Instant updateDate

The timestamp when this bulk operation was last updated.

Class com.broadleafcommerce.bulk.v2.domain.BulkOperationTotalRecordCountRequest

class BulkOperationTotalRecordCountRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

totalRecordCount

long totalRecordCount

The total record count for the bulk operation.

Class com.broadleafcommerce.bulk.v2.domain.InitializeItemRequest

class InitializeItemRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Miscellaneous attributes for this request.

entityContextIds

List<String> entityContextIds

The list of entity context IDs to initialize the bulk operation items.

Class com.broadleafcommerce.bulk.v2.domain.InitializeItemResponse

class InitializeItemResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bulkOperation

BulkOperationResponse bulkOperation

The bulk operation that the items were created for.

itemResponses

List<BulkOperationItemResponse> itemResponses

The list of items that were initialized.

Class com.broadleafcommerce.bulk.v2.domain.OperationStatusHistoryResponse

class OperationStatusHistoryResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

operationStatus

String operationStatus

What the operation status was for this update.

operationSubStatus

String operationSubStatus

What the operation sub-status was for this update.

updateDate

Instant updateDate

When this operation was updated.

Class com.broadleafcommerce.bulk.v2.domain.SearchFilter

class SearchFilter extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

The name of the property to filter on, e.g. "color","price", etc.

ranges

List<SearchFilterRangeValue> ranges

The ranged values of this filter. This will contain pairs of minimum and maximum values to create ranges to filter on. Cannot be used in combination with filter values.

values

List<String> values

The values of the filter. For example, if name is "color", this could be "red","black","blue"

Class com.broadleafcommerce.bulk.v2.domain.SearchFilterRangeValue

class SearchFilterRangeValue extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

maxValue

String maxValue

The maximum value to be applied on this filter. Cannot be used in combination with filter values.

minValue

String minValue

The minimum value to be applied on this filter value. Cannot be used in combination with filter values.

Class com.broadleafcommerce.bulk.v2.domain.SupportedBulkOperation

class SupportedBulkOperation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Miscellaneous attributes for this request.

operationType

String operationType

The operation type that is supported.

Package com.broadleafcommerce.bulk.v2.messaging

Class com.broadleafcommerce.bulk.v2.messaging.BulkOpsInitializeItemsRequest

class BulkOpsInitializeItemsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bulkOperationRequest

BulkOperationRequest bulkOperationRequest

The request DTO to create a bulk operation.

bulkOperationResponse

BulkOperationResponse bulkOperationResponse

The response DTO from the creation of a bulk operation.

contextInfo

com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo

The ContextInfo derived from the original request containing tenant and sandbox info.

token

String token

Class com.broadleafcommerce.bulk.v2.messaging.BulkOpsProcessRequest

class BulkOpsProcessRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bulkOperationId

String bulkOperationId

The ID of the bulk operation that needs to be processed.

entityType

String entityType

The type of entity that is associated with the bulk operation.

isTemporarySandbox

boolean isTemporarySandbox

Whether the sandbox is temporary and should be deleted after the bulk operation is complete.

operationType

String operationType

The type of bulk operation to be performed.

token

String token

Package com.broadleafcommerce.bulk.v2.messaging.sandbox

Class com.broadleafcommerce.bulk.v2.messaging.sandbox.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.

color

String color

The color of the sandbox that should be created.

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.bulk.v2.messaging.sandbox.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:

• 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.v2.messaging.sandbox.UpdateSandboxRequest

class UpdateSandboxRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The ID of the application for the sandbox.

author

String author

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

description

String description

The updated description for the sandbox.

sandboxId

String sandboxId

The ID of the sandbox to update.

sandboxName

String sandboxName

The updated name of the sandbox.

temporarySandbox

boolean temporarySandbox

Whether or not the sandbox should be automatically removed by the system when all associated change summaries are reverted or deployed.

tenantId

String tenantId

The ID of the tenant for the sandbox.

token

String token