Package com.broadleafcommerce.catalogbrowse.domain

Class ContentResolverRequest

java.lang.Object
com.broadleafcommerce.catalogbrowse.domain.ContentResolverRequest
All Implemented Interfaces:
Serializable
public class ContentResolverRequest extends Object implements Serializable
Represents a request to the to fetch CMS content to retrieve ContentItems from a commerce-facing context.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContentResolverRequest()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAttribute(String name, Object value)
    Takes in any additional attributes passed in the request not matching any defined properties.
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    Map<String,Object>
    getAttribute()
    Return any additional attributes passed in the request not matching any defined properties.
    Map<String,Object>
    getAttributes()
    Map holding any additional attributes passed in the request not matching any defined properties.
    ContentContext
    getContentContext()
    Any contextual information needed to resolve targeted content.
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
    The ContextInfo derived from the original request containing tenant and sandbox info.
    org.springframework.util.MultiValueMap<String,String>
    getParameters()
    The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    String
    getRequestId()
    The id of this content resolver request.
    int
    hashCode()
     
    boolean
    isHydrateCategoryProducts()
    If any content items reference categories, this flag indicates that the categories' products should be hydrated.
    boolean
    isHydrateProductAssets()
    If any content items reference products, this flag indicates that the products' non-primary assets should be hydrated.
    void
    setAttributes(Map<String,Object> attributes)
    Map holding any additional attributes passed in the request not matching any defined properties.
    void
    setContentContext(ContentContext contentContext)
    Any contextual information needed to resolve targeted content.
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setHydrateCategoryProducts(boolean hydrateCategoryProducts)
    If any content items reference categories, this flag indicates that the categories' products should be hydrated.
    void
    setHydrateProductAssets(boolean hydrateProductAssets)
    If any content items reference products, this flag indicates that the products' non-primary assets should be hydrated.
    void
    setParameters(org.springframework.util.MultiValueMap<String,String> parameters)
    The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    void
    setRequestId(String requestId)
    The id of this content resolver request.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ContentResolverRequest

      public ContentResolverRequest()

  • Method Details

    • addAttribute

      public void addAttribute(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute

    • getAttribute

      public Map<String,Object> getAttribute()
      Return any additional attributes passed in the request not matching any defined properties.
      Returns:
      any additional attributes passed in the request not matching any defined properties.

    • getRequestId

      public String getRequestId()
      The id of this content resolver request.

    • isHydrateCategoryProducts

      public boolean isHydrateCategoryProducts()
      If any content items reference categories, this flag indicates that the categories' products should be hydrated.

      This is only used in Catalog Browse Service and not passed downstream as a parameter, instead it will be translated in the appropriate pagination params or trigger relevant business logic.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • isHydrateProductAssets

      public boolean isHydrateProductAssets()
      If any content items reference products, this flag indicates that the products' non-primary assets should be hydrated.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • getContentContext

      public ContentContext getContentContext()
      Any contextual information needed to resolve targeted content.

      If present, this information is used during content zone resolution.

    • getParameters

      public org.springframework.util.MultiValueMap<String,String> getParameters()
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
      Returns:
      The parameters included in the original request

    • getContextInfo

      public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()
      The ContextInfo derived from the original request containing tenant and sandbox info.
      Returns:
      The ContextInfo derived from the original request

    • getAttributes

      public Map<String,Object> getAttributes()
      Map holding any additional attributes passed in the request not matching any defined properties.

    • setRequestId

      public void setRequestId(String requestId)
      The id of this content resolver request.

    • setHydrateCategoryProducts

      public void setHydrateCategoryProducts(boolean hydrateCategoryProducts)
      If any content items reference categories, this flag indicates that the categories' products should be hydrated.

      This is only used in Catalog Browse Service and not passed downstream as a parameter, instead it will be translated in the appropriate pagination params or trigger relevant business logic.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • setHydrateProductAssets

      public void setHydrateProductAssets(boolean hydrateProductAssets)
      If any content items reference products, this flag indicates that the products' non-primary assets should be hydrated.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • setContentContext

      public void setContentContext(ContentContext contentContext)
      Any contextual information needed to resolve targeted content.

      If present, this information is used during content zone resolution.

    • setParameters

      public void setParameters(org.springframework.util.MultiValueMap<String,String> parameters)
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.

    • setContextInfo

      public void setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      The ContextInfo derived from the original request containing tenant and sandbox info.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object