Interface SiteBaseUrlResolutionService

All Known Implementing Classes:
DefaultSiteBaseUrlResolutionService, WsSiteBaseUrlResolutionService, WsSiteBaseUrlResolutionService

public interface SiteBaseUrlResolutionService
CMS Site URL resolution service interface. This service is used to lookup the fully qualified URL to the root of the website for a Site. Supports separate URLs for the website and for the media root. Supports secure and insecure URLs.
Spring Bean ID:
siteBaseUrlResolutionService
  • Method Details

    • getWebsiteUrlForSite

      String getWebsiteUrlForSite(BaseSiteModel site, boolean secure, String path)
      Resolves website base url for the given site.
      Parameters:
      site - the base site
      secure - flag to indicate is HTTPS url is required
      path - the path to include in the url
      Returns:
      The URL for the website
    • getMediaUrlForSite

      String getMediaUrlForSite(BaseSiteModel site, boolean secure)
      Resolves media base url for the given site.
      Parameters:
      site - the base site
      secure - flag to indicate is HTTPS url is required
      Returns:
      The URL for the media root
    • getMediaUrlForSite

      String getMediaUrlForSite(BaseSiteModel site, boolean secure, String path)
      Resolves media base url for the given site.
      Parameters:
      site - the base site
      secure - flag to indicate is HTTPS url is required
      path - the path to include in the url
      Returns:
      The URL for the media root
    • getWebsiteUrlForSite

      String getWebsiteUrlForSite(BaseSiteModel site, boolean secure, String path, String queryParams)
      Parameters:
      site -
      secure -
      path -
      queryParams -
      Returns:
      URL for the base site
    • getWebsiteUrlForSite

      String getWebsiteUrlForSite(BaseSiteModel site, String encodingAttributes, boolean secure, String path)
      Parameters:
      site -
      encodingAttributes -
      secure -
      path -
      Returns:
      URL for the base site
    • getWebsiteUrlForSite

      String getWebsiteUrlForSite(BaseSiteModel site, String encodingAtrributes, boolean secure, String path, String queryParams)
      Parameters:
      site -
      encodingAtrributes -
      secure -
      path -
      queryParams -
      Returns:
      URL for the base site