Index (Broadleaf Import Services Consumer 2.0.1-GA API)

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

A

AbstractImportBatchHandler - Class in com.broadleafcommerce.common.dataimport: Intended to provide a commonly useful starting point for ImportBatchHandler implementations.
AbstractImportBatchHandler(ContextRequestHydrator) - Constructor for class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
AbstractRowConverter<P> - Class in com.broadleafcommerce.common.dataimport.conversion: Simple starting point for a 'converter' that can convert a BatchRecord.getRow() into a meaningful entity instance.
AbstractRowConverter() - Constructor for class com.broadleafcommerce.common.dataimport.conversion.AbstractRowConverter
addDependent(BatchRecord) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: Adds a new dependent to this record
addFailedConversionCompletions(BatchRecord, ConversionUtils.ConversionResponse<T>, List<BatchCompletionRecord>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Creates a BatchCompletionRecord for the given failedToConvert batch record, and then creates BatchCompletionRecords for all of its nested dependents.
addFailedConversionCompletions(BatchRecord, ConversionUtils.ConversionResponse<T>, List<BatchCompletionRecord>) - Static method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils: Creates a BatchCompletionRecord for the given failedToConvert batch record, and then creates BatchCompletionRecords for all of its nested dependents.
allErrored(List<BatchRecord>, String) - Static method in class com.broadleafcommerce.common.dataimport.util.BatchCompletionRecordUtils: Converts all of the given BatchRecords and dependents to errorred completions
allSuccess(List<BatchRecord>) - Static method in class com.broadleafcommerce.common.dataimport.util.BatchCompletionRecordUtils: Converts all of the given BatchRecords and dependents to successful completions

B

BatchCompletion - Class in com.broadleafcommerce.common.dataimport.messaging: Event domain sent across the BatchCompletionProducer channel
BatchCompletion(String, String, List<BatchCompletionRecord>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion
batchCompletionOutput() - Method in interface com.broadleafcommerce.common.dataimport.messaging.BatchCompletionProducer
BatchCompletionProducer - Interface in com.broadleafcommerce.common.dataimport.messaging: Emits success messages for items that were handled within batch
BatchCompletionRecord - Class in com.broadleafcommerce.common.dataimport.messaging
BatchCompletionRecord(String, BatchCompletionRecordStatus) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord: Creates a record that does not have a dedicated identifier within the resource tier (e.g.
BatchCompletionRecord(String, BatchCompletionRecordStatus, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
BatchCompletionRecord(String, BatchCompletionRecordStatus, String, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
BatchCompletionRecordStatus - Enum Class in com.broadleafcommerce.common.dataimport.messaging
BatchCompletionRecordUtils - Class in com.broadleafcommerce.common.dataimport.util
BatchContext(String, String, String, String, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
BatchContext(String, String, String, String, String, Map<String, Object>, ChangeContainer, String, String, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
BatchContext(String, String, String, String, String, Map<String, Object>, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
batchContextHelper(ContextRequestHydrator) - Method in class com.broadleafcommerce.common.dataimport.configuration.DataImportConsumerAutoConfiguration
BatchContextHelper - Class in com.broadleafcommerce.common.dataimport.context: Intended to help with common batch context setup actions.
BatchContextHelper(ContextRequestHydrator) - Constructor for class com.broadleafcommerce.common.dataimport.context.BatchContextHelper
BatchCreator<T> - Interface in com.broadleafcommerce.common.dataimport.util: Utilized in ImportBatchHandler to perform the creation and persistence of entities.
BatchListener - Class in com.broadleafcommerce.common.dataimport.messaging: Message handler for receiving batch requests
BatchListener(List<ImportBatchHandler>, IdempotentMessageConsumptionService, DataRouteReference) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchListener
BatchRecord - Class in com.broadleafcommerce.common.dataimport.messaging: A logical record from the a flat file.
BatchRecord(long, String, OperationType, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
BatchRecord(long, String, String, OperationType, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
BatchRecord(long, String, String, OperationType, String, Map<String, String>, List<BatchRecord>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
BatchRecord(long, String, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
BatchRecord(long, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
BatchRequest - Class in com.broadleafcommerce.common.dataimport.messaging: Event domain sent across the BatchRequestConsumer channel
BatchRequest() - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
BatchRequest(String, String, String, String, BatchRequest.BatchContext, List<BatchRecord>) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
BatchRequest.BatchContext - Class in com.broadleafcommerce.common.dataimport.messaging
BatchRequestConsumer - Interface in com.broadleafcommerce.common.dataimport.messaging: Message channel that receives a batch processing event from the import process
batchRequestInput() - Method in interface com.broadleafcommerce.common.dataimport.messaging.BatchRequestConsumer
BatchUpdater<T> - Interface in com.broadleafcommerce.common.dataimport.util: Utilized in ImportBatchHandler to perform and persist updates of entities.
buildAndAddCompletionRecords(BulkPersistenceResponse<T>, List<BatchCompletionRecord>, Map<String, PersistenceRequest<T>>, Function<T, String>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildContextInfo(BatchRequest.BatchContext, OperationType) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Creates a hydrated ContextInfo with data matching values from context.
buildContextInfoForBatchContext(BatchRequest.BatchContext, OperationType) - Method in class com.broadleafcommerce.common.dataimport.context.BatchContextHelper: Creates a hydrated ContextInfo with data matching values from context.
buildCreateContextInfo(BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildErrorCompletionsForUnacknowledgedRecords(BatchCompletion, BatchRequest) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener
buildNonValidationErrorCompletions(String, PersistenceRequest<T>, BulkPersistenceResponse.PersistenceFailure<T>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildReadContextInfo(BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildSuccessfulCompletionsForRequest(String, PersistenceRequest<T>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildUpdateContextInfo(BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
buildValidationErrorCompletions(String, PersistenceRequest<T>, BulkPersistenceResponse.PersistenceFailure<T>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler

C

canConvert(BatchRecord, BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.conversion.AbstractRowConverter: Indicates if this converter can parse the provided record into an entity.
canEqual(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion
canEqual(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
canEqual(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
canEqual(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
canHandle(BatchRequest) - Method in interface com.broadleafcommerce.common.dataimport.ImportBatchHandler: Whether or not this handler can actually deal with the given batch.
CHANNEL - Static variable in interface com.broadleafcommerce.common.dataimport.messaging.BatchCompletionProducer
CHANNEL - Static variable in interface com.broadleafcommerce.common.dataimport.messaging.BatchRequestConsumer
com.broadleafcommerce.common.dataimport - package com.broadleafcommerce.common.dataimport
com.broadleafcommerce.common.dataimport.configuration - package com.broadleafcommerce.common.dataimport.configuration
com.broadleafcommerce.common.dataimport.context - package com.broadleafcommerce.common.dataimport.context
com.broadleafcommerce.common.dataimport.conversion - package com.broadleafcommerce.common.dataimport.conversion
com.broadleafcommerce.common.dataimport.data - package com.broadleafcommerce.common.dataimport.data
com.broadleafcommerce.common.dataimport.messaging - package com.broadleafcommerce.common.dataimport.messaging
com.broadleafcommerce.common.dataimport.util - package com.broadleafcommerce.common.dataimport.util
COMPLEX_COLUMN_HEADER_PREFIX_DELIMITER - Static variable in class com.broadleafcommerce.common.dataimport.conversion.AbstractRowConverter: This arbitrarily indicates that a particular column requires special treatment or processing.
ContextUtil - Class in com.broadleafcommerce.common.dataimport.util: Provides common functionality for processing tracking and context related data on an import.
ConversionResponse(boolean, T, String) - Constructor for class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
ConversionResponse(boolean, T, String, OperationType) - Constructor for class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
ConversionUtils - Class in com.broadleafcommerce.common.dataimport.util: Helper class for converting BatchRecord to target types.
ConversionUtils.ConversionResponse<T> - Class in com.broadleafcommerce.common.dataimport.util: A response indicating the results of attempting to convert a BatchRecord to a target type.
convert(BatchRecord, Converter<BatchRecord, T>) - Static method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils: Convert the given BatchRecord using the given converter.
convert(Object, BatchRecord, BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.conversion.AbstractRowConverter: Converts the provided record into the required result(s).
copyRecordToEntity(Map<String, String>, ObjectMapper, E, boolean) - Static method in class com.broadleafcommerce.common.dataimport.util.RowUtils: This method takes the row data, typically from the BatchRecord, and calls the RowUtils.unflatten(Map) method.
CORRELATIONID_POSTFIX - Static variable in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil
CORRELATIONID_REGEX - Static variable in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil
CorrelationIdMapping - Class in com.broadleafcommerce.common.dataimport.messaging: Holds a mapping of a correlation id (identifier in the import service) with the resolved value at the resource tier
CorrelationIdMapping(String, String) - Constructor for class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping
correlationIdsFor(Map<String, String>) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil
CorrelationIdUtil - Class in com.broadleafcommerce.common.dataimport.util: By default, this detects correlation id values that ends with () and optionally tokenized by | for columns that can contain multiple correlation ids
CREATE - Enum constant in enum class com.broadleafcommerce.common.dataimport.messaging.OperationType
createAllAllowingPartialSuccess(List<T>, ContextInfo) - Method in interface com.broadleafcommerce.common.dataimport.util.BatchCreator

D

DataImportConsumerAutoConfiguration - Class in com.broadleafcommerce.common.dataimport.configuration
DataImportConsumerAutoConfiguration() - Constructor for class com.broadleafcommerce.common.dataimport.configuration.DataImportConsumerAutoConfiguration
DataImportConsumerMessagingConfiguration - Class in com.broadleafcommerce.common.dataimport.configuration: The main configuration for consuming an import at a resource tier
DataImportConsumerMessagingConfiguration() - Constructor for class com.broadleafcommerce.common.dataimport.configuration.DataImportConsumerMessagingConfiguration
DEFAULT_MULTIVALUE_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil
DefaultOperationResolver - Class in com.broadleafcommerce.common.dataimport.util
DefaultOperationResolver() - Constructor for class com.broadleafcommerce.common.dataimport.util.DefaultOperationResolver
DefaultsInitializer<T> - Interface in com.broadleafcommerce.common.dataimport.util: Can be used in ImportBatchHandler implementations to initialize default values for fields on an entity that have a null value (meaning their value was not found in the original row).
DefaultUlidIdGenerator - Class in com.broadleafcommerce.common.dataimport.util: If no id was generated, generates a new one based on a ULID
DefaultUlidIdGenerator() - Constructor for class com.broadleafcommerce.common.dataimport.util.DefaultUlidIdGenerator
DELETE - Enum constant in enum class com.broadleafcommerce.common.dataimport.messaging.OperationType
doImport(Message<BatchRequest>) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener

E

EmbeddedItemRequest(String, String) - Constructor for class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
EmbeddedItemRequest(String, String, List<PersistenceRequest.EmbeddedItemRequest>) - Constructor for class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
empty() - Static method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
EnableDataImportMessagingConfiguration - Annotation Interface in com.broadleafcommerce.common.dataimport.configuration: Enables the message channels to receive batch import requests
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
equals(Object) - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest
error(BatchRecord, String) - Static method in class com.broadleafcommerce.common.dataimport.util.BatchCompletionRecordUtils: Creates a successful completion from the original record.
error(String) - Static method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
ERROR - Enum constant in enum class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecordStatus
extractSpecialColumns(Map<String, String>, BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.conversion.AbstractRowConverter: Used to remove columns that require special processing, or that cannot be set using reflection.

F

failRecordAndDependentsEarly(BatchRecord, String, String, List<BatchCompletionRecord>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Intended for use in scenarios where a record and its dependents need to be marked as failed in an early (pre-persistence) stage (no resource tier ID is available), such as failed conversions.
finalizeContextForBatch(BatchRequest) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Method to clear any state after processing a batch.
finalizeContextForBatch(BatchRequest) - Method in interface com.broadleafcommerce.common.dataimport.ImportBatchHandler
findCurrencyForContextRequest(ContextRequest) - Method in class com.broadleafcommerce.common.dataimport.context.BatchContextHelper: Finds the currency to use for the request context.
findLocaleForContextRequest(ContextRequest) - Method in class com.broadleafcommerce.common.dataimport.context.BatchContextHelper: Finds the locale to use for the request context.

G

generateAndAddCompletions(BatchRecord, BatchCompletionRecordStatus, String, List<BatchCompletionRecord>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
generateAndAddCompletions(PersistenceRequest.EmbeddedItemRequest, BatchCompletionRecordStatus, String, List<BatchCompletionRecord>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
generateAndAddValidationErrorCompletions(PersistenceRequest.EmbeddedItemRequest, String, Map<String, FieldError>, String, List<BatchCompletionRecord>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getAdditionalContextMap() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getApplicationId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getAuthor() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getBaseContextInfo() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getBatchContextHelper() - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getBatchId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion: Identifier for this batch
getCatalogId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getChangeContainer() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getCompletionError(BatchRecord, String) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getContext() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
getConverted() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
getCorrelationId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord: Which record was actually completed to map back to a record in the sent batch from the import process
getCorrelationId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: Identifier that allows the resource tier to map back responses to a record within the batch
getCorrelationId() - Method in class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping: Identifier for the record at the import tier
getCorrelationId() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
getCorrelationId() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest: The correlation ID from the original record, will ultimately be set on the BatchCompletionRecord.correlationId.
getCustomerContextId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getDataRouteKey() - Method in interface com.broadleafcommerce.common.dataimport.ImportBatchHandler: The data route key that is relevant to the import process
getDependents() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: Items that should be conceptually linked to the parent record that represents this item
getDependents() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
getEmbeddedItemRequests() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest
getErrorMessage() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord: If BatchCompletionRecord.status is BatchCompletionRecordStatus.ERROR, then this contains a message detailing what the problem was.
getErrorMessage() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
getFileType() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The original specification that this import comes from, like CSV, EXCEL, etc
getFormattedEmbeddedValidationErrorString(List<FieldError>, String, String) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getFormattedValidationErrorString(Collection<ObjectError>, Collection<FieldError>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getHandlers() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener
getHydrator() - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Deprecated.
No longer needed. Deferring to BatchContextHelper for context request hydration.
getHydrator() - Method in class com.broadleafcommerce.common.dataimport.context.BatchContextHelper
getId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: Unique identifier for this batch
getIdempotentConsumptionService() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener
getImportContextConfigurationProperties() - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getImportContextProperties(BatchRequest) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
getImportId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion: The import that this batch request is associated with
getImportId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The import that this batch request is associated with
getLineNumber() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: The line number in the original data file that this item appears in.
getNestedPathInParent() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
getOperation() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: What operation should be performed on this record.
getOperation() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest: The type of operation to perform for this object.
getOperationType() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
getParameters() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getParentEntityId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getRandom() - Static method in class com.broadleafcommerce.common.dataimport.util.DefaultUlidIdGenerator: This provides subclasses the ability to access the shared SecureRandom instance.
getRecords() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion: The records that should be inserted within this batch
getRecords() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The records that should be inserted within this batch
getRecordType() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: In a multi-typed record file this holds the specific information of what was parsed out from the line in the file.
getReference() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener
getResourceTierIdentifier() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord: Gives the ability to, from the import service, map back a resource tier identifier from an item in the batch that was successfully (or unsuccessfully) persisted.
getResourceTierIdentifier() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: The identifier for this record at the resource tier In the case of an OperationType.UPDATE or OperationType.DELETE then this is supplied up front within the original upload.
getResourceTierIdentifier() - Method in class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping: Identifier for the record at the resource tier which is associated after the record is persisted
getRow() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord: The row of data parsed out from the flat file.
getSandboxId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getStatus() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord: Status of the record
getTenantId() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
getToSave() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest: The actual entity to persist.
getType() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: Configurable type of this import, like PRODUCT, CATEGORY, etc
getVendorRef() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext

H

handle(BatchRequest) - Method in interface com.broadleafcommerce.common.dataimport.ImportBatchHandler: Handle the batch and emit completions for all items within the batch.
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
hashCode() - Method in class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping
hashCode() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
hashCode() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
hashCode() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest

I

IdResolver - Interface in com.broadleafcommerce.common.dataimport.util
ImportBatchHandler - Interface in com.broadleafcommerce.common.dataimport: The main extension point for responding to a batch coming in from import services.
importBatchListener(List<ImportBatchHandler>, IdempotentMessageConsumptionService, DataRouteReference) - Method in class com.broadleafcommerce.common.dataimport.configuration.DataImportConsumerMessagingConfiguration
ImportDataRouteSupporting - Interface in com.broadleafcommerce.common.dataimport.data
initializeContextForBatch(BatchRequest) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Method to initialize fields for a batch.
initializeContextForBatch(BatchRequest) - Method in interface com.broadleafcommerce.common.dataimport.ImportBatchHandler: Handles initializing some context state before handling this batch.
initializeDefaults(T) - Method in interface com.broadleafcommerce.common.dataimport.util.DefaultsInitializer: Initializes default values for null fields when applicable
isSuccessful() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse

L

LIST_VALUE_ELEMENT_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.RowUtils: Value separator (e.g.
listen(Message<BatchRequest>) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchListener: Channel consumption for a batch request

N

NESTED_FIELD_PATH_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.RowUtils: An object can have deeply nested properties - for example, you may have the following structure:
nextId() - Method in class com.broadleafcommerce.common.dataimport.util.DefaultUlidIdGenerator
nextId() - Method in interface com.broadleafcommerce.common.dataimport.util.IdResolver: Simply a method to return the next available ID if it can be determined.
nextUlid() - Static method in class com.broadleafcommerce.common.dataimport.util.DefaultUlidIdGenerator: Static method that allows direct access to generate a ULID.

O

OperationResolver - Interface in com.broadleafcommerce.common.dataimport.util
OperationType - Enum Class in com.broadleafcommerce.common.dataimport.messaging: For this record, what sort of operation is being performed from the import.
overrideChangeContainerForChildOfEntity(String, Class<?>, ChangeContainerOverridable, TypeFactory) - Static method in class com.broadleafcommerce.common.dataimport.util.ContextUtil: Overrides the ChangeContainer on the provided child to align with that of the parent, specified by the ID of the parent and the type (Class) of the parent.

P

PACKAGE_FRAGMENT - Static variable in interface com.broadleafcommerce.common.dataimport.data.ImportDataRouteSupporting
parseCorrelationIds(String) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil: Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column.
parseCorrelationIds(String, String) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil: Given a column that can contain correlation id references, returns only the correlation id(s) that are within the column.
persist(BatchRequest, List<PersistenceRequest<T>>, BatchCreator<T>, BatchUpdater<T>, Function<T, String>) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: Perform a persist of the parsed out domain specified as PersistenceRequests
persist(BatchRequest, List<PersistenceRequest<T>>, BatchCreator<T>, BatchUpdater<T>, Function<T, String>, int) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler: This is a convenience wrapper around AbstractImportBatchHandler.persist(BatchRequest, List, BatchCreator, BatchUpdater, Function) to submit the requests in chunks/smaller-batches.
PersistenceRequest<T> - Class in com.broadleafcommerce.common.dataimport.util: Intended for use by ImportBatchHandler implementations to capture all relevant information about a parsed/converted record such that it can be submitted for persistence and completion information can be produced for it.
PersistenceRequest(T, OperationType, String) - Constructor for class com.broadleafcommerce.common.dataimport.util.PersistenceRequest
PersistenceRequest(T, OperationType, String, List<PersistenceRequest.EmbeddedItemRequest>) - Constructor for class com.broadleafcommerce.common.dataimport.util.PersistenceRequest
PersistenceRequest.EmbeddedItemRequest - Class in com.broadleafcommerce.common.dataimport.util: Provides traceability in order to report success/failure of embedded items tied to a particular entity.
populateCorrelationIds(String, String, UnaryOperator<String>) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil: Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver.
populateCorrelationIds(String, UnaryOperator<String>) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil: Replaces the contents of value with the appropriate value from the result of correlationIdToIdentifierResolver.
PROPERTY_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.RowUtils: Constant to indicate separation between different properties.

R

removeAndReturnFieldErrorsUnderPath(Map<String, FieldError>, String) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
removeNullKeysAndValues(Map<K, V>) - Static method in class com.broadleafcommerce.common.dataimport.util.RowUtils: This basic utility simply removes all null values and keys from the Map.
replaceWithMappedCorrelationIds(Map<String, String>, UnaryOperator<String>) - Static method in class com.broadleafcommerce.common.dataimport.util.CorrelationIdUtil
resolveId(String, OperationType, String, Map<String, String>) - Method in class com.broadleafcommerce.common.dataimport.util.DefaultUlidIdGenerator
resolveId(String, OperationType, String, Map<String, String>) - Method in interface com.broadleafcommerce.common.dataimport.util.IdResolver: Determine the id that should be used for BatchRecord.getResourceTierIdentifier() for the parsed record from a file.
resolveOperation(String, OperationType, String, Map<String, String>) - Method in class com.broadleafcommerce.common.dataimport.util.DefaultOperationResolver
resolveOperation(String, OperationType, String, Map<String, String>) - Method in interface com.broadleafcommerce.common.dataimport.util.OperationResolver: Determine the id that should be used for BatchRecord.getResourceTierIdentifier() for the parsed record from a file
RowUtils - Class in com.broadleafcommerce.common.dataimport.util: Convenience methods pertaining to processing BatchRecord.getRow().

S

setBaseContextInfo(ContextInfo) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
setBatchContextHelper(BatchContextHelper) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
setContext(BatchRequest.BatchContext) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
setFileType(String) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The original specification that this import comes from, like CSV, EXCEL, etc
setId(String) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: Unique identifier for this batch
setImportContextConfigurationProperties(ImportContextConfigurationProperties) - Method in class com.broadleafcommerce.common.dataimport.AbstractImportBatchHandler
setImportId(String) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The import that this batch request is associated with
setRecords(List<BatchRecord>) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: The records that should be inserted within this batch
setType(String) - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest: Configurable type of this import, like PRODUCT, CATEGORY, etc
success(BatchRecord) - Static method in class com.broadleafcommerce.common.dataimport.util.BatchCompletionRecordUtils: Creates a successful completion from the original record.
success(T) - Static method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
success(T, OperationType) - Static method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
SUCCESS - Enum constant in enum class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecordStatus

T

toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletion
toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecord
toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRecord
toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest.BatchContext
toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.BatchRequest
toString() - Method in class com.broadleafcommerce.common.dataimport.messaging.CorrelationIdMapping
toString() - Method in class com.broadleafcommerce.common.dataimport.util.ConversionUtils.ConversionResponse
toString() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest.EmbeddedItemRequest
toString() - Method in class com.broadleafcommerce.common.dataimport.util.PersistenceRequest
toTrackingOperation() - Method in enum class com.broadleafcommerce.common.dataimport.messaging.OperationType

U

unflatten(Map<String, String>) - Static method in class com.broadleafcommerce.common.dataimport.util.RowUtils: This method accepts a "flat" map of field names to field values, where the field names can be underscore-separated names to indicate a nested structure of complex object fields.
UPDATE - Enum constant in enum class com.broadleafcommerce.common.dataimport.messaging.OperationType
updateAllAllowingPartialSuccess(List<Update<T>>, ContextInfo) - Method in interface com.broadleafcommerce.common.dataimport.util.BatchUpdater

V

VALUE_ASSIGNMENT_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.RowUtils: Constant to allow the separation between key/value pairs (e.g.
VALUE_SEPARATOR - Static variable in class com.broadleafcommerce.common.dataimport.util.RowUtils: Constant to allow the separation between groups of properties (e.g.
valueOf(String) - Static method in enum class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecordStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.common.dataimport.messaging.OperationType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.common.dataimport.messaging.BatchCompletionRecordStatus: 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.dataimport.messaging.OperationType: Returns an array containing the constants of this enum class, in the order they are declared.

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