Interface UrlEncoderFacade

All Known Implementing Classes:
DefaultUrlEncoderFacade

public interface UrlEncoderFacade
This facade will be used by UrlEncoderFilter to process the URL for UrlEncoding.
  • Method Details

    • isValid

      boolean isValid(String attributeName, String value)
      Checks if the given urlEncodingAttribute holds a valid value for injection into the URL.
      Parameters:
      attributeName - encodoing attribute name to check
      value - encoding attribute value to check
      Returns:
      boolean
    • getCurrentUrlEncodingData

      List<UrlEncoderData> getCurrentUrlEncodingData()
      Gets the list of attributes and it's values that has to be encoded in the url. The list of attributes for each site will be configured in CMSSiteModel and the data objects that holds the attributes and it's values will be set in SessionService attributes.
      Returns:
      List of UrlEncoderData objects that holds the encoding attribute's values.
    • updateSiteFromUrlEncodingData

      void updateSiteFromUrlEncodingData()
      Updates the Store/Site based on the change in value of the urlEncodingAttributes. Only specific encoding attributes are allowed to change the site.
    • calculateAndUpdateUrlEncodingData

      String calculateAndUpdateUrlEncodingData(String url, String contextPath)
      Gets the urlEncoding pattern that has to be injected into the URL. This pattern is calculated based on the input URL and encoding attributes configured for specific site. This method will also update the url encoding values stored in the session.
      Parameters:
      url - input URL to build pattern
      contextPath - context with encoding attributes
      Returns:
      the pattern