Interface UrlEncoderService

  • All Known Implementing Classes:
    DefaultUrlEncoderService

    public interface UrlEncoderService
    Service class that to have centralized access to encoding attribute values
    • Method Detail

      • isUrlEncodingEnabledForCurrentSite

        boolean isUrlEncodingEnabledForCurrentSite()
        Checks if UrlEncoding for SEO is enabled
        Returns:
        boolean
      • getUrlEncodingPattern

        java.lang.String getUrlEncodingPattern()
        Returns the url pattern for encoding
        Returns:
        urlPattern for encoding
      • isLanguageEncodingEnabled

        boolean isLanguageEncodingEnabled()
        Checks if store language is one of the attributes for url encoding
        Returns:
        if language is enabled for encoding
      • isCurrencyEncodingEnabled

        boolean isCurrencyEncodingEnabled()
        Check if store currency is one of the attributes for url encoding
        Returns:
        if currency is enabled for encoding
      • getEncodingAttributesForSite

        java.util.Collection<java.lang.String> getEncodingAttributesForSite()
        Returns:
        collection of attributes/properties to encode
      • getUrlEncodingPatternForEmail

        java.lang.String getUrlEncodingPatternForEmail​(BusinessProcessModel businessProcessModel)
        Determines the url encoding pattern for email flows.
        Parameters:
        businessProcessModel -
        Returns:
        the url pattern to encode for email links
      • getCurrentUrlEncodingPattern

        java.lang.String getCurrentUrlEncodingPattern()
        Returns the url pattern for encoding
        Returns:
        urlPattern for encoding
      • getUrlEncodingAttrManagerMap

        java.util.Map<java.lang.String,​UrlEncodingAttributeManager> getUrlEncodingAttrManagerMap()
        Collection of attributes and attributemanages to determine the encoding pattern
        Returns:
        urlEncodingAttrManagerMap