Package com.broadleafcommerce.shipping.service.integrations.fixed

Class FixedFulfillmentPricingProvider

java.lang.Object
com.broadleafcommerce.shipping.service.integrations.fixed.FixedFulfillmentPricingProvider
All Implemented Interfaces:
FulfillmentPricingProvider
public class FixedFulfillmentPricingProvider extends Object implements FulfillmentPricingProvider
Simple implementation of FulfillmentPricingProvider for implementations that require fixed shipping configuration for it's fulfillment options. For banded or tiered shipping, see BandedFulfillmentPricingProvider. Alternatively, a FulfillmentPricingProvider integrated with a 3rd party, such as ShipEngine, is preferred.

By default, FixedFulfillmentPricingProperties.getShipTables(ContextInfo) is used to retrieve the properties based on a given ContextInfo. If not found, FixedFulfillmentPricingConfig provided by FixedFulfillmentPricingProperties.getConfigPath() is used instead, which can be configured with Spring Config Server, including Broadleaf's own implementation. This will allow changes to the property value to be reinitialized by this provider, as long as the declaring bean for this provider is annotated with @RefreshScope.

Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • FixedFulfillmentPricingProvider

      public FixedFulfillmentPricingProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, FixedFulfillmentPricingProperties fixedShipProps)

  • Method Details

    • init

      @PostConstruct public void init()
      Reads in the configuration file defined by FixedFulfillmentPricingProperties.getConfigPath() and initializes fixedFulfillmentPricingConfig to the result.
      Throws:
      UncheckedIOException - Thrown when there is an error while reading the configuration file or converting its contents into a FixedFulfillmentPricingConfig.

    • calculateCostForFulfillmentGroup

      public com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse calculateCostForFulfillmentGroup(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: FulfillmentPricingProvider
      Calculate shipping for a request that includes a specified fulfillment option.
      Specified by:
      calculateCostForFulfillmentGroup in interface FulfillmentPricingProvider
      Parameters:
      request - The request for which to calculate shipping.
      contextInfo - context information around sandbox and multitenant state
      Returns:
      Response object with calculated shipping cost for the provided request.

    • canCalculateCostForOption

      public boolean canCalculateCostForOption(@NonNull @NonNull String fulfillmentOptionName, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: FulfillmentPricingProvider
      Whether this provider has knowledge of the provided option and thus can provide cost information for it.
      Specified by:
      canCalculateCostForOption in interface FulfillmentPricingProvider
      Parameters:
      fulfillmentOptionName - The option to consider whether this provider can calculate cost information.
      contextInfo - context information around sandbox and multitenant state
      Returns:
      Whether this provider has knowledge of the provided option and thus can provide cost information for it.

    • estimateCostForFulfillmentGroup

      public com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse estimateCostForFulfillmentGroup(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: FulfillmentPricingProvider
      Estimate shipping for a request that includes a specified fulfillment option.
      Specified by:
      estimateCostForFulfillmentGroup in interface FulfillmentPricingProvider
      Parameters:
      request - The request for which to estimate shipping.
      contextInfo - context information around sandbox and multitenant state
      Returns:
      Response object with estimated shipping cost for the provided request.

    • providePricedFulfillmentOptions

      public List<com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse> providePricedFulfillmentOptions(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: FulfillmentPricingProvider
      Retrieve all possible priced fulfillment options for the provided request. Intended to be used to display options to the customer for selection.
      Specified by:
      providePricedFulfillmentOptions in interface FulfillmentPricingProvider
      Parameters:
      request - The request for which to calculate shipping and return options.
      contextInfo - context information around sandbox and multitenant state
      Returns:
      All possible priced fulfillment options for the provided request.

    • canProvidePricedFulfillmentOptions

      public boolean canProvidePricedFulfillmentOptions(com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest fulfillmentPricingRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: FulfillmentPricingProvider
      Whether this provider can provide fulfillment options based on the "fulfillmentPricingRequest"
      Specified by:
      canProvidePricedFulfillmentOptions in interface FulfillmentPricingProvider
      Parameters:
      fulfillmentPricingRequest - The request used to identify relevant fulfillment options
      contextInfo - context information around sandbox and multitenant state
      Returns:
      Whether this provider can provide fulfillment options based on the "fulfillmentPricingRequest"

    • getShipTables

      protected List<FixedFulfillmentPricingOption> getShipTables(@Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Gets a list of FixedFulfillmentPricingOptions based on the given ContextInfo.

      If FixedFulfillmentPricingOptions cannot be found, fixedFulfillmentPricingConfig would be used as a fallback.

      Parameters:
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a list of FixedFulfillmentPricingOptions based on the given ContextInfo

    • buildItemToPriceMap

      protected Map<com.broadleafcommerce.shipping.domain.FulfillmentPricingItem,javax.money.MonetaryAmount> buildItemToPriceMap(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, @NonNull @NonNull FixedFulfillmentPricingOption option)
      Builds a map of FulfillmentPricingItems to the calculated prices.
      Parameters:
      request - The request for which to calculate shipping
      option - The fulfillment option to use to calculate pricing for the request
      Returns:
      a map of FulfillmentPricingItems to the calculated prices.

    • calculateCostForFulfillmentGroupInternal

      @Deprecated(since="1.1.0", forRemoval=true) protected com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse calculateCostForFulfillmentGroupInternal(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, boolean isEstimate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.1.0, in favor of calculateCostForFulfillmentGroupInternal(FulfillmentPricingRequest, boolean, ContextInfo)

    • calculateCostForFulfillmentGroupInternal

      protected com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse calculateCostForFulfillmentGroupInternal(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest request, boolean isEstimate, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Handles the shared logic of calculateCostForFulfillmentGroup(FulfillmentPricingRequest, ContextInfo) and estimateCostForFulfillmentGroup(FulfillmentPricingRequest, ContextInfo).

    • buildFulfillmentOptionPricedResponse

      protected com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse buildFulfillmentOptionPricedResponse(@NonNull @NonNull javax.money.MonetaryAmount price, @NonNull @NonNull Map<com.broadleafcommerce.shipping.domain.FulfillmentPricingItem,javax.money.MonetaryAmount> itemToPriceMap, @NonNull @NonNull FixedFulfillmentPricingOption fulfillmentOption, boolean isEstimate)
      Builds a FulfillmentOptionPricedResponse with the given inputs.
      Parameters:
      price - The value to set for FulfillmentOptionPricedResponse.getFulfillmentPriceCalculated().
      itemToPriceMap - Map of FulfillmentPricingItems to their fulfillment prices
      fulfillmentOption - The FulfillmentOption that forms the basis of the response
      isEstimate - Whether this is for estimating the fulfillment pricing
      Returns:
      a FulfillmentOptionPricedResponse for the given inputs.

    • calculateFulfillmentGroupPriceBeforeAdjustments

      protected javax.money.MonetaryAmount calculateFulfillmentGroupPriceBeforeAdjustments(@NonNull @NonNull FixedFulfillmentPricingOption option, javax.money.CurrencyUnit expectedCurrency)

    • getMonetaryAmount

      protected javax.money.MonetaryAmount getMonetaryAmount(javax.money.CurrencyUnit expectedCurrency, @Nullable Set<com.broadleafcommerce.shipping.domain.FulfillmentPriceAmount> fulfillmentPriceAmounts)
      Find the corresponding price for the expected currency, otherwise return zero.
      Parameters:
      expectedCurrency - The expected currency to find a price for
      fulfillmentPriceAmounts - The list of prices to search against
      Returns:
      the corresponding price for the expected currency, otherwise return zero

    • calculatePriceForItem

      @Deprecated protected javax.money.MonetaryAmount calculatePriceForItem(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem item, @NonNull @NonNull FixedFulfillmentPricingOption option, @NonNull @NonNull javax.money.CurrencyUnit currency)
      Deprecated.
      in favor of calculatePriceForItems(FulfillmentPricingItem, FixedFulfillmentPricingOption, CurrencyUnit)
      Calculates the price for a fulfillment item. By default this means the price for a single unit rather than all like units, i.e., FulfillmentPricingItem.getUnitPrice() is used not FulfillmentPricingItem.getSubtotal().
      Parameters:
      item - The FulfillmentPriceInfo item to be priced
      option - The applicable FixedFulfillmentPricingOption for the item
      Returns:
      the price for a fulfillment item.

    • calculatePriceForItems

      protected javax.money.MonetaryAmount calculatePriceForItems(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem item, @NonNull @NonNull FixedFulfillmentPricingOption option, @NonNull @NonNull javax.money.CurrencyUnit currency)
      Calculates the price for a fulfillment items. By default this means the price for all units, i.e., FulfillmentPricingItem.getMerchandiseTotalAmount().
      Parameters:
      item - The FulfillmentPriceInfo item to be priced
      option - The applicable FixedFulfillmentPricingOption for the item
      Returns:
      the price for a fulfillment items.

    • calculateFixedPriceForItem

      protected javax.money.MonetaryAmount calculateFixedPriceForItem(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem item, @NonNull @NonNull FixedFulfillmentPricingOption option, @NonNull @NonNull javax.money.CurrencyUnit currency)

    • calculatePercentageRateForItem

      @Deprecated protected javax.money.MonetaryAmount calculatePercentageRateForItem(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem item, @NonNull @NonNull FixedFulfillmentPricingOption option, @NonNull @NonNull javax.money.CurrencyUnit currency)
      Deprecated.

    • calculatePercentageRateForItems

      protected javax.money.MonetaryAmount calculatePercentageRateForItems(@NonNull @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem item, @NonNull @NonNull FixedFulfillmentPricingOption option, @NonNull @NonNull javax.money.CurrencyUnit currency)

    • getDefaultFixedFulfillmentPricingOption

      protected FixedFulfillmentPricingOption getDefaultFixedFulfillmentPricingOption(javax.money.CurrencyUnit expectedCurrency)
      Builds a FixedFulfillmentPricingOption with fields initialized to typical values.
      Returns:
      a FixedFulfillmentPricingOption with fields initialized to typical values.

    • preRequest

      protected void preRequest(com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest fulfillmentPricingRequest)

    • getObjectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

    • getFixedShipProps

      protected FixedFulfillmentPricingProperties getFixedShipProps()

    • getFixedFulfillmentPricingConfig

      @Deprecated protected FixedFulfillmentPricingConfig getFixedFulfillmentPricingConfig()
      Deprecated.
      since 1.1.0, in favor of FixedFulfillmentPricingProperties.getShipTables(ContextInfo)