Package com.broadleafcommerce.orderoperation.service.provider.external

Class ExternalResourceLockProvider

java.lang.Object
com.broadleafcommerce.orderoperation.service.provider.external.AbstractExternalProvider
com.broadleafcommerce.orderoperation.service.provider.external.ExternalResourceLockProvider
All Implemented Interfaces:
ResourceLockProvider
public class ExternalResourceLockProvider extends AbstractExternalProvider implements ResourceLockProvider
Obtains and releases locks in an external service (cart services over HTTP).
Author:
Jacob Mitash

  • Constructor Details

    • ExternalResourceLockProvider

      public ExternalResourceLockProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalOrderProperties properties)

  • Method Details

    • obtainLock

      public String obtainLock(@NonNull @NonNull String contextId, @NonNull @NonNull String conceptKey, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ResourceLockProvider
      Obtains a permanent resource lock, typically used for idempotency messages.
      Specified by:
      obtainLock in interface ResourceLockProvider
      Parameters:
      contextId - the context ID of the entity to lock
      conceptKey - some key indicating what is being locked or by who
      contextInfo - the context of the request
      Returns:
      a token that can be used to release the lock

    • obtainTemporalLock

      public String obtainTemporalLock(@NonNull @NonNull String contextId, @NonNull @NonNull String conceptKey, @Nullable Duration lockTtl, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ResourceLockProvider
      Obtains a temporal resource lock. This lock is automatically released after lockTtl if specified. By default, if the lockTtl is null, the duration configured via the "broadleaf.order.web.order-lock-ttl" property will be used.
      Specified by:
      obtainTemporalLock in interface ResourceLockProvider
      Parameters:
      contextId - the context ID of the entity to lock
      conceptKey - some key indicating what is being locked or by who
      lockTtl - amount of time that an order lock is held, before it expires
      contextInfo - the context of the request
      Returns:
      a token that can be used to release the lock

    • releaseLock

      public void releaseLock(@NonNull @NonNull String token, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ResourceLockProvider
      Releases a resource lock using a token. The token should be obtained via ResourceLockProvider.obtainLock(String, String, ContextInfo).
      Specified by:
      releaseLock in interface ResourceLockProvider
      Parameters:
      token - the token tied to the lock which should be released
      contextInfo - the context of the request

    • finishLock

      public void finishLock(@NonNull @NonNull String token, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ResourceLockProvider
      Update the status of the lock to indicate the associated process is complete.
      Specified by:
      finishLock in interface ResourceLockProvider
      Parameters:
      token - The unique token that was provided when the lock was obtained
      contextInfo - the context of the request

    • executeRequest

      protected <T> T executeRequest(Supplier<T> request)
      Description copied from class: AbstractExternalProvider
      Executes a request with default Web Client error handling.
      Overrides:
      executeRequest in class AbstractExternalProvider
      Type Parameters:
      T - the return type of the request operation
      Parameters:
      request - the request to execute
      Returns:
      the value generated by the supplier

    • obtainLock

      protected String obtainLock(@NonNull @NonNull String contextId, @NonNull @NonNull String conceptKey, @NonNull @NonNull String url, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • getStringMapType

      protected org.springframework.core.ParameterizedTypeReference<Map<String,String>> getStringMapType()

    • getServiceClient

      protected String getServiceClient()

    • getProperties

      protected ExternalOrderProperties getProperties()