com.liferay.portal.url.builder

Interface AbsolutePortalURLBuilder

@ProviderType
public interface AbsolutePortalURLBuilder

Provides builders for constructing absolute URLs pointing to portal resources.

Each for[Resource] method returns a URL builder for the named resource. Algorithms may differ between builders. In general, the builders construct URLs that honor existing proxy paths unless a CDN host is being used.

See Also:

BuildableAbsolutePortalURLBuilder

Method Summary

Modifier and Type	Method and Description
ImageAbsolutePortalURLBuilder	forImage(java.lang.String relativeURL) Returns a URL builder for Portal images.
MainAbsolutePortalURLBuilder	forMain(java.lang.String relativeURL) Returns a URL builder for Portal's main resources.
ModuleAbsolutePortalURLBuilder	forModule(org.osgi.framework.Bundle bundle, java.lang.String relativeURL) Returns a URL builder for module resources.
ModuleAbsolutePortalURLBuilder	forModuleScript(org.osgi.framework.Bundle bundle, java.lang.String relativeURL) Returns a URL builder for module JavaScript files.
ModuleAbsolutePortalURLBuilder	forModuleStylesheet(org.osgi.framework.Bundle bundle, java.lang.String relativeURL) Returns a URL builder for module stylesheets.
PortletDependencyAbsolutePortalURLBuilder	forPortletDependency(com.liferay.portal.kernel.model.portlet.PortletDependency portletDependency, java.lang.String cssURN, java.lang.String javaScriptURN) Returns a URL builder for portlet dependency resources.
ResourceAbsolutePortalURLBuilder	forResource(java.lang.String relativeURL) Returns a URL builder for arbitrary resources.
WhiteboardAbsolutePortalURLBuilder	forWhiteboard(java.lang.String servletPattern) Returns a URL builder for OSGi whiteboard servlet instances.
AbsolutePortalURLBuilder	ignoreCDNHost() Returns a version of this URL builder that ignores the CDN part.
AbsolutePortalURLBuilder	ignorePathProxy() Returns a version of this URL builder that ignores the path proxy part.

Method Detail

forImage

ImageAbsolutePortalURLBuilder forImage(java.lang.String relativeURL)

Returns a URL builder for Portal images. Image resources live in com.liferay.portal.kernel.util.Portal#PATH_IMAGE.

Image resources are retrieved from a CDN host if present or from Portal otherwise.

Parameters:

relativeURL - the image's relative URL

Returns:

a URL builder for Portal images

forMain

MainAbsolutePortalURLBuilder forMain(java.lang.String relativeURL)

Returns a URL builder for Portal's main resources. Main resources live in com.liferay.portal.kernel.util.Portal#PATH_MAIN.

Main resources are always retrieved from the Portal, even if a CDN host is present.

Parameters:

relativeURL - the resource's relative URL

Returns:

a URL builder for Portal's main resources

forModule

ModuleAbsolutePortalURLBuilder forModule(org.osgi.framework.Bundle bundle,
                                         java.lang.String relativeURL)

Returns a URL builder for module resources. Module resources live in com.liferay.portal.kernel.util.Portal#PATH_MODULE + the bundle's web context path.

If the requested module resource is a JavaScript file or a stylesheet, use forModuleScript(Bundle, String) or forModuleStylesheet(Bundle, String) instead.

Module resources are retrieved from a CDN host if present or from the Portal otherwise.

Parameters:

bundle - the bundle that contains the resource

relativeURL - the resource's relative URL

Returns:

a URL builder for module resources

forModuleScript

ModuleAbsolutePortalURLBuilder forModuleScript(org.osgi.framework.Bundle bundle,
                                               java.lang.String relativeURL)

Returns a URL builder for module JavaScript files. Module scripts live in com.liferay.portal.kernel.util.Portal#PATH_MODULE + the bundle's web context path.

Module scripts are retrieved from a CDN host if present or from the Portal otherwise.

Parameters:

bundle - the bundle that contains the resource

relativeURL - the JavaScript file relative URL

Returns:

a URL builder for module scripts

forModuleStylesheet

ModuleAbsolutePortalURLBuilder forModuleStylesheet(org.osgi.framework.Bundle bundle,
                                                   java.lang.String relativeURL)

Returns a URL builder for module stylesheets. Module stylesheets live in com.liferay.portal.kernel.util.Portal#PATH_MODULE + the bundle's web context path.

Module stylesheets are retrieved from a CDN host if present or from the Portal otherwise.

Module stylesheets are retrieved as standard module resources, but additional parameters to account for RTL support, cache, etc. are added to the request.

Parameters:

bundle - the bundle that contains the resource

relativeURL - the stylesheets relative URL

Returns:

a URL builder for module stylesheets

forPortletDependency

PortletDependencyAbsolutePortalURLBuilder forPortletDependency(com.liferay.portal.kernel.model.portlet.PortletDependency portletDependency,
                                                               java.lang.String cssURN,
                                                               java.lang.String javaScriptURN)

Returns a URL builder for portlet dependency resources. Portlet dependency resources live in the portal's root path.

Portlet dependency resources are retrieved from a configured CSS URN or JS URN if present. (See com.liferay.portal.kernel.util.PropsKeys#PORTLET_DEPENDENCY_CSS_URN and PropsKeys#PORTLET_DEPENDENCY_JAVASCRIPT_URN).

If neither are present, the resource is retrieved from a CDN host if present, or Portal otherwise.

Parameters:

portletDependency - the portlet dependency resource

cssURN - the URN for CSS portlet dependency resources

javaScriptURN - the URN for JavaScript portlet dependency resources

Returns:

a URL builder for portlet dependency resources

forResource

ResourceAbsolutePortalURLBuilder forResource(java.lang.String relativeURL)

Returns a URL builder for arbitrary resources. Arbitrary resources live in Portal's root path. It can be / if Portal installed as the root web app, or /some-other-path based on its context). See com.liferay.portal.spring.context.PortalContextLoaderListener#getPortalServletContextPath( ) for more details.

Warning: Only use this method if none of the other methods meet your needs. Otherwise, you may end up hard coding configurable paths.

Arbitrary resources are retrieved from a CDN host if present or from the Portal otherwise.

Parameters:

relativeURL - the resource's relative URL

Returns:

a URL builder for arbitrary resources

forWhiteboard

WhiteboardAbsolutePortalURLBuilder forWhiteboard(java.lang.String servletPattern)

Returns a URL builder for OSGi whiteboard servlet instances. This method requires the servlet class to be annotated with the OSGi {@code

Parameters:

servletPattern - the value of the osgi.http.whiteboard.servlet.pattern property

Returns:

a URL builder for OSGi whiteboard servlet instances

ignoreCDNHost

AbsolutePortalURLBuilder ignoreCDNHost()

Returns a version of this URL builder that ignores the CDN part. See com.liferay.portal.kernel.util.Portal#getCDNHost( javax.servlet.http.HttpServletRequest) for details.

Returns:

a version of this URL builder that ignores the CDN part

ignorePathProxy

AbsolutePortalURLBuilder ignorePathProxy()

Returns a version of this URL builder that ignores the path proxy part. See com.liferay.portal.kernel.util.Portal#getPathProxy() for details.

Returns:

a version of this URL builder that ignores the path proxy part