Package com.broadleafcommerce.catalogbrowse.service.provider.external.catalog

Class ExternalCatalogProviderProperties

java.lang.Object
com.broadleafcommerce.catalogbrowse.service.provider.external.catalog.ExternalCatalogProviderProperties
@ConfigurationProperties("broadleaf.catalogbrowse.catalogprovider") public class ExternalCatalogProviderProperties extends Object
Author:
Nathan Moore (nathandmoore)

  • Constructor Details

    • ExternalCatalogProviderProperties

      public ExternalCatalogProviderProperties()

  • Method Details

    • getUrl

      public String getUrl()
      The base url for an external catalog service: https://localhost:8447/catalog.

    • getProductsUri

      public String getProductsUri()
      The URI path for retrieving products. This is appended to url.

    • getProductAssetsUri

      public String getProductAssetsUri()
      The URI path for retrieving product assets. This is appended to productsUri. Note that this is only necessary if assets are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of #fetchProductsWithDetails and #fetchCategoryWithDetails.

    • getCategoriesUri

      public String getCategoriesUri()
      The URI path for retrieving categories.

    • getBrowseEntitiesUri

      public String getBrowseEntitiesUri()
      The URI path for retrieving browse entities when the type is not known by the caller. This could be the case when the caller has a browser URL but does not know if it belongs to a Catalog or a Product.

    • getDataDrivenEnumsUri

      public String getDataDrivenEnumsUri()
      The URI path for retrieving data driven enums.

    • getCartFieldMappingsUri

      public String getCartFieldMappingsUri()
      The URI path for retrieving cart field mappings.

    • getProductTagsUri

      public String getProductTagsUri()
      The URI path for retrieving product tags. This is appended to productsUri. Note that this is only necessary if tags are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of #fetchProductsWithDetails and #fetchCategoryWithDetails.

    • getServiceClient

      public String getServiceClient()
      The service client to use when interacting with catalog. Default is "catalogbrowseclient"

    • isLoopbackOptimizationEnabled

      public boolean isLoopbackOptimizationEnabled()
      Where available, whether optimizing microservice interlink requests should be optimized with a direct method call when the targeted service is colocated in the same flexpackage. This saves on expenses related to socket creation, json serialization/deserialization, and SSL encryption and handshake. True by default. Note, this value is examined in concert with ExternalClientProperties.Client.isLoopbackOptimizationEnabled(). Both must be true, and the latter property is false by default.

    • isAssetMinificationEnabled

      public boolean isAssetMinificationEnabled()
      Whether to reduce the overall payload size of response by trimming typically unnecessary information from Assets such as ContextState.

    • setUrl

      public void setUrl(String url)
      The base url for an external catalog service: https://localhost:8447/catalog.

    • setProductsUri

      public void setProductsUri(String productsUri)
      The URI path for retrieving products. This is appended to url.

    • setProductAssetsUri

      public void setProductAssetsUri(String productAssetsUri)
      The URI path for retrieving product assets. This is appended to productsUri. Note that this is only necessary if assets are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of #fetchProductsWithDetails and #fetchCategoryWithDetails.

    • setCategoriesUri

      public void setCategoriesUri(String categoriesUri)
      The URI path for retrieving categories.

    • setBrowseEntitiesUri

      public void setBrowseEntitiesUri(String browseEntitiesUri)
      The URI path for retrieving browse entities when the type is not known by the caller. This could be the case when the caller has a browser URL but does not know if it belongs to a Catalog or a Product.

    • setDataDrivenEnumsUri

      public void setDataDrivenEnumsUri(String dataDrivenEnumsUri)
      The URI path for retrieving data driven enums.

    • setCartFieldMappingsUri

      public void setCartFieldMappingsUri(String cartFieldMappingsUri)
      The URI path for retrieving cart field mappings.

    • setProductTagsUri

      public void setProductTagsUri(String productTagsUri)
      The URI path for retrieving product tags. This is appended to productsUri. Note that this is only necessary if tags are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of #fetchProductsWithDetails and #fetchCategoryWithDetails.

    • setServiceClient

      public void setServiceClient(String serviceClient)
      The service client to use when interacting with catalog. Default is "catalogbrowseclient"

    • setLoopbackOptimizationEnabled

      public void setLoopbackOptimizationEnabled(boolean loopbackOptimizationEnabled)
      Where available, whether optimizing microservice interlink requests should be optimized with a direct method call when the targeted service is colocated in the same flexpackage. This saves on expenses related to socket creation, json serialization/deserialization, and SSL encryption and handshake. True by default. Note, this value is examined in concert with ExternalClientProperties.Client.isLoopbackOptimizationEnabled(). Both must be true, and the latter property is false by default.

    • setAssetMinificationEnabled

      public void setAssetMinificationEnabled(boolean assetMinificationEnabled)
      Whether to reduce the overall payload size of response by trimming typically unnecessary information from Assets such as ContextState.