Package com.broadleafcommerce.dataexchange.service

Class BatchContext<T extends ExchangeObject>

java.lang.Object
com.broadleafcommerce.dataexchange.service.BatchContext<T>
Type Parameters:
T -
public class BatchContext<T extends ExchangeObject> extends Object
Container for holding important data that is relevant to the overall processing of a batch of ExchangeObjects. This is thread safe and is expected to share state between multiple threads for a given batch.
Author:
Kelly Tisdell (ktisdell)

  • Constructor Details

    • BatchContext

      public BatchContext(@Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Constructor, which takes in an optional ContextInfo.
      Parameters:
      contextInfo -

  • Method Details

    • getContextInfo

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo(@NonNull com.broadleafcommerce.data.tracking.core.type.OperationType operationType)
      Convenience method to allow us to return a cached ContextInfo for this batch. This is helpful when we need to do more than one operation (e.g. read, create. update, delete) and need multiple contexts. Returns null if getInitialContextInfo() is null.
      Parameters:
      operationType - OperationType for which to provide a ContextInfo
      Returns:
      a ContextInfo with the requested OperationType
      See Also:

    • getReadContext

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getReadContext()

    • getCreateContext

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getCreateContext()

    • getUpdateContext

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getUpdateContext()

    • getDeleteContext

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getDeleteContext()

    • getElapsedTimeMillis

      public long getElapsedTimeMillis()
      Provides the time in millis since this object was created, which is usually when a batch stars.
      Returns:
      returns the time, in millis, since this BatchContext was created

    • registerException

      public void registerException(String key, Throwable ex)
      Method to allow us to track more than one exception per entity that we are tracking. The key is the ExchangeObject.getCorrelationId().
      Parameters:
      key - the correlationId of the entity
      ex - an exception that was encountered saving or processing the entity

    • registerException

      public void registerException(ExchangeObject exchangeObject, Throwable ex)
      Adds an Exception reference to the ExchangeObject. These can be aggregated at the end of a process.
      Parameters:
      exchangeObject - any ExchangeObject in the object graph that may have an exception that needs to be tracked and reported
      ex - an exception that was caught processing the given ExchangeObject

    • getThrowables

      public Map<String,List<Throwable>> getThrowables()
      Returns an immutable Map, keyed by ExchangeObject.getCorrelationId() and containing a list of exceptions that may have been encountered. This should only be used during the aggregation phase.
      Returns:
      immutable Map, keyed by ExchangeObject.getCorrelationId() containing one or more Exceptions
      See Also:

    • hasException

      public boolean hasException(String key)
      Indicates if anything associated with this key has an exception associated with it for this batch.
      Parameters:
      key - any arbitrary string, but typically ExchangeObject.getCorrelationId()
      Returns:
      true if the provided key has an associated exception

    • hasException

      public boolean hasException(ExchangeObject exchangeObject)
      Indicates if the provided ExchangeObject has a registered exception with this batch.
      Parameters:
      exchangeObject - any ExchangeObject in the object graph that may have an exception that needs to be tracked and reported
      Returns:
      true if the provided object has an associated exception

    • getExceptions

      public List<Throwable> getExceptions(ExchangeObject exchangeObject)

    • addAttribute

      public <V> void addAttribute(String key, V value)

    • getAttribute

      @Nullable public <V> V getAttribute(String key)

    • getAttribute

      public <V> V getAttribute(String key, V defaultValue)
      Returns the value in the additionalAttributes Map, or the default value if no entry is available for the provided key. This is essentially the same is as Map.getOrDefault(Object, Object).
      Type Parameters:
      V -
      Parameters:
      key -
      defaultValue -
      Returns:

    • findOriginalEntityExchangeObject

      @Nullable public <V extends ExchangeObject> V findOriginalEntityExchangeObject(String correlationId, Class<V> type)
      Utility method to iterate over the getFlattenedHierarchy() Map and find the ExchangeObject that has the provided correlationId and whose type matches the provided Class type.
      Parameters:
      correlationId -
      type -
      Returns:

    • findOriginalEntityExchangeObject

      @Nullable public <V extends ExchangeObject> V findOriginalEntityExchangeObject(String correlationId)
      Utility method to iterate over the getFlattenedHierarchy() Map and find the ExchangeObject that has the provided correlationId.
      Parameters:
      correlationId -
      Returns:

    • findAllOriginalChildrenOfTypeForCorrelationId

      public <V extends ExchangeObject> List<V> findAllOriginalChildrenOfTypeForCorrelationId(String correlationId, Class<V> type)

    • findOriginalChildrenForParent

      public List<ExchangeObject> findOriginalChildrenForParent(@Nullable String correlationId)

    • findOriginalChildrenForParent

      public List<ExchangeObject> findOriginalChildrenForParent(@Nullable ExchangeObject exchangeObject)

    • findTopLevelEntitiesOfType

      public <V extends ExchangeObject> List<V> findTopLevelEntitiesOfType(Class<V> type)

    • addSavedTopLevelEntity

      public void addSavedTopLevelEntity(T exchangeObject)
      Adds a saved entity to the savedEntitiesMap and savedTopLevelEntities. This should be called after the primary ExchangeObject (e.g. a product) has been saved. It is not necessary to call addSavedEntity(ExchangeObject) if this method is used.
      Parameters:
      exchangeObject -

    • addSavedEntity

      public void addSavedEntity(ExchangeObject exchangeObject)
      Adds a saved entity to the savedEntitiesMap. If this is the primary ExchangeObject that is being saved, this method should not be used. Instead, use addSavedTopLevelEntity(ExchangeObject).
      Parameters:
      exchangeObject - the ExchangeObject to add to the saved entities map

    • getSavedEntity

      public <R extends ExchangeObject> R getSavedEntity(String correlationId)
      Returns a saved ExchangeObject based on the provided correlationId. This method will throw a CorrelationIdException if no entity is found with the provided correlationId, as it's generally expected that this method will only be called for entities that have been saved. If validation isn't desired, use getSavedEntityUnsafe(String) instead.
      Parameters:
      correlationId - the correlationId of the saved entity
      Returns:
      the saved entity

    • getSavedEntity

      @Nullable public <R extends ExchangeObject> R getSavedEntity(@Nullable ExchangeObject exchangeObject)
      Returns a saved ExchangeObject based on the provided correlationId. This method will throw a CorrelationIdException if no entity is found with the provided correlationId, as it's generally expected that this method will only be called for entities that have been saved. If validation isn't desired, use getSavedEntityUnsafe(String) instead.
      Parameters:
      exchangeObject - the ExchangeObject to get the saved entity
      Returns:
      the saved entity

    • getParentSavedEntity

      public ExchangeObject getParentSavedEntity(ExchangeObject exchangeObject)
      Returns the saved parent ExchangeObject of the provided ExchangeObject.
      Parameters:
      exchangeObject - the ExchangeObject to get the parent of
      Returns:
      the saved parent

    • getSavedEntityUnsafe

      @Nullable public ExchangeObject getSavedEntityUnsafe(String correlationId)
      Returns a saved ExchangeObject based on the provided correlationId. This method does not validate the entity exists, which is generally desired. Most use cases should use getSavedEntity(String) instead.
      Parameters:
      correlationId - the correlationId of the saved entity
      Returns:
      the saved entity

    • validateCorrelationId

      protected void validateCorrelationId(ExchangeObject exchangeObject)

    • getBatchStartTimeMillis

      public long getBatchStartTimeMillis()
      Time in millis that this BatchContext was created and therefore when the processing of the batch started. This can be used to determine elapsed time.

    • getSavedTopLevelEntities

      public List<T> getSavedTopLevelEntities()
      Top level entities that are saved, to be returned. May also contain the original requested entity (not saved) if that entity has an error.
      See Also:

    • getResponseErrors

      public List<DataExchangeError> getResponseErrors()
      Error details to return to the caller. These are usually derived from hasException(ExchangeObject) after processing of all entities and immediately prior to returning the response to the client.

    • getSavedEntitiesMap

      public Map<String,ExchangeObject> getSavedEntitiesMap()
      The saved entities, keyed by their correlationId.

    • getFlattenedHierarchy

      public Map<String,ExchangeObject> getFlattenedHierarchy()
      Represents a Map of the entire object graph provided by a caller, flattened so that the ExchangeObject.getCorrelationId() is the key.

    • getChildrenMap

      public Map<String,List<ExchangeObject>> getChildrenMap()
      The children of entities, keyed by their parent correlationId.

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      Arbitrary additional state that can be stored for batch processing or to be shared between threads.

    • getInitialContextInfo

      public com.broadleafcommerce.data.tracking.core.context.ContextInfo getInitialContextInfo()
      The ContextInfo provided when the request was made to this service.

    • getCtxInfoMap

      public Map<com.broadleafcommerce.data.tracking.core.type.OperationType,com.broadleafcommerce.data.tracking.core.context.ContextInfo> getCtxInfoMap()
      Map of ContextInfo instances based on the initial value passed to the constructor. This is keyed by OperationType.