Uses of Interface
com.broadleafcommerce.dataexchange.domain.ExchangeObject

Packages that use ExchangeObject

Package	Description
com.broadleafcommerce.dataexchange.domain
com.broadleafcommerce.dataexchange.domain.asset
com.broadleafcommerce.dataexchange.domain.catalog.product
com.broadleafcommerce.dataexchange.domain.catalog.tag
com.broadleafcommerce.dataexchange.domain.translation
com.broadleafcommerce.dataexchange.domain.util
com.broadleafcommerce.dataexchange.service
com.broadleafcommerce.dataexchange.service.catalog.product
com.broadleafcommerce.dataexchange.service.error
com.broadleafcommerce.dataexchange.service.provider.external

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain

Classes in com.broadleafcommerce.dataexchange.domain that implement ExchangeObject

Modifier and Type	Class	Description
class	AbstractExchangeObject	Parent class that contains correlation Ids to re-create the structure.
class	EntityExchangeObject	Entity representation of an exchange object.

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain.asset

Classes in com.broadleafcommerce.dataexchange.domain.asset that implement ExchangeObject

Modifier and Type	Class	Description
class	ExchangeEntityAsset

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain.catalog.product

Classes in com.broadleafcommerce.dataexchange.domain.catalog.product that implement ExchangeObject

Modifier and Type	Class	Description
class	Attribute
class	CategoryRef
class	ComprehensiveProduct
class	DataDrivenEnum	Represents a data driven enum from the catalog service.
class	Prices
class	ProductAsset
class	ProductOption
class	SkuInventory
class	Variant

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain.catalog.tag

Classes in com.broadleafcommerce.dataexchange.domain.catalog.tag that implement ExchangeObject

Modifier and Type	Class	Description
class	ProductTag

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain.translation

Classes in com.broadleafcommerce.dataexchange.domain.translation that implement ExchangeObject

Modifier and Type	Class	Description
class	Translation

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.domain.util

Methods in com.broadleafcommerce.dataexchange.domain.util that return types with arguments of type ExchangeObject

Modifier and Type	Method	Description
static Map<String,ExchangeObject>	ReflectionUtils.flattenCorrelationHierarchy(List<? extends ExchangeObject> entities)

Methods in com.broadleafcommerce.dataexchange.domain.util with parameters of type ExchangeObject

Modifier and Type	Method	Description
static List<Class<?>>	ReflectionUtils.findSuperClasses(ExchangeObject entity)	Finds all superclasses but excludes Object.
static void	ReflectionUtils.flattenCorrelationHierarchy(ExchangeObject entity, Map<String,ExchangeObject> result, String path)	Recursively iterates over the properties of the entity and if they are instances of ExchangeObject this extracts them into a Map keyed by their getCorrelationId().
Retryable.RetryableBuilder<X>	Retryable.RetryableBuilder.withExceptionConsumer(ExchangeObject exchangeObject, BatchContext<?> batchContext)	Creates a Consumer that calls BatchContext.registerException(String, Throwable) using the getCorrelationId() as the key and logs the exception.

Method parameters in com.broadleafcommerce.dataexchange.domain.util with type arguments of type ExchangeObject

Modifier and Type	Method	Description
static void	ReflectionUtils.flattenCorrelationHierarchy(ExchangeObject entity, Map<String,ExchangeObject> result, String path)	Recursively iterates over the properties of the entity and if they are instances of ExchangeObject this extracts them into a Map keyed by their getCorrelationId().
static Map<String,ExchangeObject>	ReflectionUtils.flattenCorrelationHierarchy(List<? extends ExchangeObject> entities)
static void	ReflectionUtils.flattenCorrelationHierarchy(List<? extends ExchangeObject> entities, Map<String,ExchangeObject> flattened)
static void	ReflectionUtils.flattenCorrelationHierarchy(List<? extends ExchangeObject> entities, Map<String,ExchangeObject> flattened)

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.service

Classes in com.broadleafcommerce.dataexchange.service with type parameters of type ExchangeObject

Modifier and Type	Class	Description
class	AbstractBatchItemHandler<T1 extends ExchangeObject,T2 extends ExchangeObject>
class	AbstractBatchItemHandler<T1 extends ExchangeObject,T2 extends ExchangeObject>
class	AbstractDataExchangeService<T extends ExchangeObject>	Abstract base implementation for handling the orchestration of the requisite calls to multiple services and/or service API endpoints.
class	BatchContext<T extends ExchangeObject>	Container for holding important data that is relevant to the overall processing of a batch of ExchangeObjects.
interface	BatchItemHandler<T1 extends ExchangeObject,T2 extends ExchangeObject>	Implementations of this interface are responsible for handling items in a batch.
interface	BatchItemHandler<T1 extends ExchangeObject,T2 extends ExchangeObject>	Implementations of this interface are responsible for handling items in a batch.
interface	DataExchangeService<T extends ExchangeObject>	Service whose job it is to orchestrate an exchange of data between services, usually on behalf of an external system.
class	HandlerArgs<T1 extends ExchangeObject,T2 extends ExchangeObject>	DTO for passing arguments to BatchItemHandler.handle(HandlerArgs).
class	HandlerArgs<T1 extends ExchangeObject,T2 extends ExchangeObject>	DTO for passing arguments to BatchItemHandler.handle(HandlerArgs).

Methods in com.broadleafcommerce.dataexchange.service with type parameters of type ExchangeObject

Modifier and Type	Method	Description
static <T extends ExchangeObject, R> R	LockService.doSynchronized(T exchangeObject, String lockName, Function<T,R> function)	Makes use of a LRUMap to store mutex objects for synchronization.
<V extends ExchangeObject> List<V>	BatchContext.findAllOriginalChildrenOfTypeForCorrelationId(String correlationId, Class<V> type)
<V extends ExchangeObject> V	BatchContext.findOriginalEntityExchangeObject(String correlationId)	Utility method to iterate over the BatchContext.getFlattenedHierarchy() Map and find the ExchangeObject that has the provided correlationId.
<V extends ExchangeObject> V	BatchContext.findOriginalEntityExchangeObject(String correlationId, Class<V> type)	Utility method to iterate over the BatchContext.getFlattenedHierarchy() Map and find the ExchangeObject that has the provided correlationId and whose type matches the provided Class type.
<V extends ExchangeObject> List<V>	BatchContext.findTopLevelEntitiesOfType(Class<V> type)
<R extends ExchangeObject> R	BatchContext.getSavedEntity(ExchangeObject exchangeObject)	Returns a saved ExchangeObject based on the provided correlationId.
<R extends ExchangeObject> R	BatchContext.getSavedEntity(String correlationId)	Returns a saved ExchangeObject based on the provided correlationId.
protected <C extends ExchangeObject> Runnable	AbstractDataExchangeService.retryableRunnable(C payload, BatchContext<T> batchContext, Callable<Void> supplier)
protected <R, C extends ExchangeObject> Supplier<R>	AbstractDataExchangeService.retryableSupplier(C payload, BatchContext<T> batchContext, Callable<R> supplier)
protected <R, C extends ExchangeObject> Supplier<List<R>>	AbstractDataExchangeService.retryableSupplier(List<C> payload, BatchContext<T> batchContext, Callable<List<R>> supplier)

Methods in com.broadleafcommerce.dataexchange.service that return ExchangeObject

Modifier and Type	Method	Description
ExchangeObject	BatchContext.getParentSavedEntity(ExchangeObject exchangeObject)	Returns the saved parent ExchangeObject of the provided ExchangeObject.
ExchangeObject	BatchContext.getSavedEntityUnsafe(String correlationId)	Returns a saved ExchangeObject based on the provided correlationId.

Methods in com.broadleafcommerce.dataexchange.service that return types with arguments of type ExchangeObject

Modifier and Type	Method	Description
List<ExchangeObject>	BatchContext.findOriginalChildrenForParent(ExchangeObject exchangeObject)
List<ExchangeObject>	BatchContext.findOriginalChildrenForParent(String correlationId)
Map<String,List<ExchangeObject>>	BatchContext.getChildrenMap()	The children of entities, keyed by their parent correlationId.
Map<String,ExchangeObject>	BatchContext.getFlattenedHierarchy()	Represents a Map of the entire object graph provided by a caller, flattened so that the getCorrelationId() is the key.
Map<String,ExchangeObject>	BatchContext.getSavedEntitiesMap()	The saved entities, keyed by their correlationId.

Methods in com.broadleafcommerce.dataexchange.service with parameters of type ExchangeObject

Modifier and Type	Method	Description
void	BatchContext.addSavedEntity(ExchangeObject exchangeObject)	Adds a saved entity to the BatchContext.savedEntitiesMap.
boolean	BatchItemHandler.canHandle(ExchangeObject exchangeObject)	Determines if this handler can handle the given exchange object.
CompletableFuture<Void>	AbstractBatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate)
CompletableFuture<Void>	AbstractBatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, BatchItemOperationType operationType)
CompletableFuture<Void>	AbstractBatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, BatchItemOperationType operationType, Map<String,Object> additionalArgs)
CompletableFuture<Void>	AbstractBatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, Map<String,Object> additionalArgs)
CompletableFuture<Void>	BatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate)	The entry point for the handler.
CompletableFuture<Void>	BatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, BatchItemOperationType operationType)	The entry point for the handler.
CompletableFuture<Void>	BatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, BatchItemOperationType operationType, Map<String,Object> additionalArgs)	The entry point for the handler.
CompletableFuture<Void>	BatchItemHandler.execute(T1 parent, ExchangeObject exchangeObject, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, Map<String,Object> additionalArgs)	The entry point for the handler.
List<ExchangeObject>	BatchContext.findOriginalChildrenForParent(ExchangeObject exchangeObject)
List<Throwable>	BatchContext.getExceptions(ExchangeObject exchangeObject)
static Object	LockService.getLock(ExchangeObject exchangeObject, String key)	To be used in places where synchronization is needed.
ExchangeObject	BatchContext.getParentSavedEntity(ExchangeObject exchangeObject)	Returns the saved parent ExchangeObject of the provided ExchangeObject.
<R extends ExchangeObject> R	BatchContext.getSavedEntity(ExchangeObject exchangeObject)	Returns a saved ExchangeObject based on the provided correlationId.
boolean	BatchContext.hasException(ExchangeObject exchangeObject)	Indicates if the provided ExchangeObject has a registered exception with this batch.
void	BatchContext.registerException(ExchangeObject exchangeObject, Throwable ex)	Adds an Exception reference to the ExchangeObject.
protected void	BatchContext.validateCorrelationId(ExchangeObject exchangeObject)

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.service.catalog.product

Classes in com.broadleafcommerce.dataexchange.service.catalog.product with type parameters of type ExchangeObject

Modifier and Type	Class	Description
class	ProductRelatedBatchItemHandler<T1 extends ComprehensiveProduct,T2 extends ExchangeObject>	Marker class to indicate that a handler is responsible for processing product related children.
class	VariantRelatedBatchItemHandler<T1 extends ComprehensiveProduct,T2 extends ExchangeObject>	Marker class to indicate that a handler is responsible for processing children of a variant.

Methods in com.broadleafcommerce.dataexchange.service.catalog.product with parameters of type ExchangeObject

Modifier and Type	Method	Description
protected void	DefaultPriceDataPreloadProcessor.addPriceDataTargetIds(ExchangeObject obj, Set<String> pricingKeys, Map<String,PriceList> priceListMap, BatchContext<ComprehensiveProduct> batch)
boolean	InventoryBatchItemHandler.canHandle(ExchangeObject exchangeObject)
boolean	PriceDataBatchItemHandler.canHandle(ExchangeObject exchangeObject)
boolean	ProductAssetBatchItemHandler.canHandle(ExchangeObject exchangeObject)
boolean	ProductBatchItemHandler.canHandle(ExchangeObject exchangeObject)
boolean	ProductTagBatchItemHandler.canHandle(ExchangeObject exchangeObject)
boolean	VariantBatchItemHandler.canHandle(ExchangeObject exchangeObject)
protected BatchItemOperationType	ProductBatchItemHandler.findVariantOperationType(HandlerArgs<T,T> args, ExchangeObject exchangeObject)

Method parameters in com.broadleafcommerce.dataexchange.service.catalog.product with type arguments of type ExchangeObject

Modifier and Type	Method	Description
protected Set<String>	ProductBatchItemHandlerHelper.mapToCorrelationId(Collection<? extends ExchangeObject> exchangeObjects)

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.service.error

Classes in com.broadleafcommerce.dataexchange.service.error that implement ExchangeObject

Modifier and Type	Class	Description
static class	DefaultBatchItemErrorHandler.ErrorExchangeObject	An exchange object to represent an error that occurred outside the processing of individual exchange objects.

Methods in com.broadleafcommerce.dataexchange.service.error with parameters of type ExchangeObject

Modifier and Type	Method	Description
protected DataExchangeError	DefaultBatchItemErrorHandler.initError(ExchangeObject exchangeObject, Throwable throwable)

Method parameters in com.broadleafcommerce.dataexchange.service.error with type arguments of type ExchangeObject

Modifier and Type	Method	Description
void	BatchItemErrorHandler.handleErrors(List<ExchangeObject> exchangeObjects, BatchContext<?> batchContext)	Handles errors for the given exchange objects.
void	DefaultBatchItemErrorHandler.handleErrors(List<ExchangeObject> exchangeObjects, BatchContext<?> batchContext)	Handles errors for the given exchange objects.

Uses of ExchangeObject in com.broadleafcommerce.dataexchange.service.provider.external

Methods in com.broadleafcommerce.dataexchange.service.provider.external with type parameters of type ExchangeObject

Modifier and Type	Method	Description
protected <T extends ExchangeObject> T	AbstractRestApiExternalProvider.setCorrelationIds(T beforeSave, T afterSave)	Set the correlation ids on created/updated entities after saving.