Package com.broadleafcommerce.cartoperation.service.provider.external

Class ExternalInventoryProperties

java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.external.ExternalInventoryProperties
@ConfigurationProperties("broadleaf.cartoperation.inventoryprovider") public class ExternalInventoryProperties extends Object
Properties for interacting with an external Inventory system.
Author:
Kelly Tisdell (ktisdell)

  • Constructor Details

    • ExternalInventoryProperties

      public ExternalInventoryProperties()

  • Method Details

    • getUrl

      public String getUrl()
      The base url for an external inventory service.

    • getReserveUri

      public String getReserveUri()
      URI for reserving inventory

    • getReleaseReservationUri

      public String getReleaseReservationUri()
      URI for releasing inventory reservations

    • getCheckAvailabilityUri

      public String getCheckAvailabilityUri()
      URI for checking inventory for a particular SKU

    • getBulkCheckAvailabilityUri

      public String getBulkCheckAvailabilityUri()
      URI for checking inventory for a list of SKUs

    • getServiceClient

      public String getServiceClient()
      The service client to use when calling inventory services. Default is "cartopsclient".

    • isThrowIsInventoryAvailableExceptions

      public boolean isThrowIsInventoryAvailableExceptions()
      If true, exceptions from ExternalInventoryProvider.isInventoryAvailable(String, int, ContextInfo) and all other methods named isInventoryAvailable are thrown. Prior versions caught all exceptions and returned false for availability. Default is false.
      Since:
      3.0.0

    • isThrowGetInventorySummariesExceptions

      public boolean isThrowGetInventorySummariesExceptions()
      If true, exceptions from ExternalInventoryProvider.getInventorySummaries(Map, ContextInfo) and other methods that return inventory summaries, are thrown. Prior versions caught all exceptions and return empty collections/maps. Default is false.
      Since:
      3.0.0

    • isMessageKeysForAvailabilityErrors

      public boolean isMessageKeysForAvailabilityErrors()
      If set to true, message keys are returned for quantity availability errors instead of human readable messages. Default is false.
      Since:
      3.0.0

    • setUrl

      public void setUrl(String url)
      The base url for an external inventory service.

    • setReserveUri

      public void setReserveUri(String reserveUri)
      URI for reserving inventory

    • setReleaseReservationUri

      public void setReleaseReservationUri(String releaseReservationUri)
      URI for releasing inventory reservations

    • setCheckAvailabilityUri

      public void setCheckAvailabilityUri(String checkAvailabilityUri)
      URI for checking inventory for a particular SKU

    • setBulkCheckAvailabilityUri

      public void setBulkCheckAvailabilityUri(String bulkCheckAvailabilityUri)
      URI for checking inventory for a list of SKUs

    • setServiceClient

      public void setServiceClient(String serviceClient)
      The service client to use when calling inventory services. Default is "cartopsclient".

    • setThrowIsInventoryAvailableExceptions

      public void setThrowIsInventoryAvailableExceptions(boolean throwIsInventoryAvailableExceptions)
      If true, exceptions from ExternalInventoryProvider.isInventoryAvailable(String, int, ContextInfo) and all other methods named isInventoryAvailable are thrown. Prior versions caught all exceptions and returned false for availability. Default is false.
      Since:
      3.0.0

    • setThrowGetInventorySummariesExceptions

      public void setThrowGetInventorySummariesExceptions(boolean throwGetInventorySummariesExceptions)
      If true, exceptions from ExternalInventoryProvider.getInventorySummaries(Map, ContextInfo) and other methods that return inventory summaries, are thrown. Prior versions caught all exceptions and return empty collections/maps. Default is false.
      Since:
      3.0.0

    • setMessageKeysForAvailabilityErrors

      public void setMessageKeysForAvailabilityErrors(boolean messageKeysForAvailabilityErrors)
      If set to true, message keys are returned for quantity availability errors instead of human readable messages. Default is false.
      Since:
      3.0.0