de.hybris.platform.acceleratorservices.urlresolver

Interface SiteBaseUrlResolutionService

All Known Implementing Classes:

DefaultSiteBaseUrlResolutionService, 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 Summary

Modifier and Type	Method and Description
java.lang.String	getMediaUrlForSite(BaseSiteModel site, boolean secure) Resolves media base url for the given site.
java.lang.String	getMediaUrlForSite(BaseSiteModel site, boolean secure, java.lang.String path) Resolves media base url for the given site.
java.lang.String	getWebsiteUrlForSite(BaseSiteModel site, boolean secure, java.lang.String path) Resolves website base url for the given site.
java.lang.String	getWebsiteUrlForSite(BaseSiteModel site, boolean secure, java.lang.String path, java.lang.String queryParams)
java.lang.String	getWebsiteUrlForSite(BaseSiteModel site, java.lang.String encodingAttributes, boolean secure, java.lang.String path)
java.lang.String	getWebsiteUrlForSite(BaseSiteModel site, java.lang.String encodingAtrributes, boolean secure, java.lang.String path, java.lang.String queryParams)

Method Detail

getWebsiteUrlForSite

java.lang.String getWebsiteUrlForSite(BaseSiteModel site,
                                      boolean secure,
                                      java.lang.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

java.lang.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

java.lang.String getMediaUrlForSite(BaseSiteModel site,
                                    boolean secure,
                                    java.lang.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

java.lang.String getWebsiteUrlForSite(BaseSiteModel site,
                                      boolean secure,
                                      java.lang.String path,
                                      java.lang.String queryParams)

Parameters:

site -

secure -

path -

queryParams -

Returns:

URL for the base site

getWebsiteUrlForSite

java.lang.String getWebsiteUrlForSite(BaseSiteModel site,
                                      java.lang.String encodingAttributes,
                                      boolean secure,
                                      java.lang.String path)

Parameters:

site -

encodingAttributes -

secure -

path -

Returns:

URL for the base site

getWebsiteUrlForSite

java.lang.String getWebsiteUrlForSite(BaseSiteModel site,
                                      java.lang.String encodingAtrributes,
                                      boolean secure,
                                      java.lang.String path,
                                      java.lang.String queryParams)

Parameters:

site -

encodingAtrributes -

secure -

path -

queryParams -

Returns:

URL for the base site