lumis.portal.url

Interface IWebResourceFactory

All Known Implementing Classes:

ChannelManager, PageManager

public interface IWebResourceFactory

Interface implemented by factories of WebResource. These factories are responsible for generating transient WebResource instances as demanded, but have no direct responsibility over their life-cycle.

Since:

5.0.0

Version:

$Revision: 19381 $ $Date: 2016-09-09 00:02:01 +0000 (Fri, 09 Sep 2016) $

Method Summary

Modifier and Type	Method and Description
String	adjustFriendlyPathForClash(String originalFriendlyPath, String clashedFriendlyPath, String suffix) Adjusts a friendly path due to clash.
String	adjustResolvedFriendlyPath(WebResource webResource, String friendlyPath) Adjusts a friendly path that has been resolved for a web resource.
WebResource	createWebResourceByDynamicPath(String dynamicPath) Creates a WebResource instance based on a dynamic path.
boolean	isCacheEnabled(WebResource webResource) Returns if the cache is enabled for a web resource.
boolean	requiresFriendlyPathUpdate(WebResource webResource) Returns whether the friendly path for the given web resource requires updating.
void	setPageCacheFilePath(PageCacheConfig pageCache) Sets the file path for a PageCacheConfig.
void	setWebResourcesMissingData(String resourceId, boolean processChildren) Sets missing data in the web resources of the specified resource.

Method Detail

createWebResourceByDynamicPath

WebResource createWebResourceByDynamicPath(String dynamicPath)
                                    throws PortalException

Creates a WebResource instance based on a dynamic path.

Parameters:

dynamicPath - the dynamic path.

Returns:

the web resource.

Throws:

IllegalArgumentException - if dynamicPath is not a valid web resource dynamic path for this factory.

PortalException

Since:

5.0.0

setPageCacheFilePath

void setPageCacheFilePath(PageCacheConfig pageCache)
                   throws PortalException

Sets the file path for a PageCacheConfig.

Parameters:

pageCache - the page cache.

Throws:

PortalException

Since:

5.0.0

isCacheEnabled

boolean isCacheEnabled(WebResource webResource)
                throws PortalException

Returns if the cache is enabled for a web resource.

Parameters:

webResource - the web resource.

Returns:

true if the cache is enabled, false otherwise.

Throws:

PortalException

Since:

5.0.0

setWebResourcesMissingData

void setWebResourcesMissingData(String resourceId,
                                boolean processChildren)
                         throws PortalException

Sets missing data in the web resources of the specified resource.

Parameters:

resourceId - the resource owner of the web resources.

processChildren - indicates if web resources of children resources should also be processed.

Throws:

PortalException

Since:

5.0.0

adjustResolvedFriendlyPath

String adjustResolvedFriendlyPath(WebResource webResource,
                                  String friendlyPath)

Adjusts a friendly path that has been resolved for a web resource.

Parameters:

webResource - the web resource.

friendlyPath - the resolved friendly path.

Returns:

the adjusted friendly path value.

Since:

5.0.0

adjustFriendlyPathForClash

String adjustFriendlyPathForClash(String originalFriendlyPath,
                                  String clashedFriendlyPath,
                                  String suffix)

Adjusts a friendly path due to clash.

Parameters:

originalFriendlyPath - the original friendly path resolved.

clashedFriendlyPath - the last clashed friendly path value.

numRetry - the number of retry for adjust clashing for this friendly path. In each call to this method for resolving a single friendly path this value is incremented.

Returns:

the adjusted friendly path value.

Since:

5.0.0

requiresFriendlyPathUpdate

boolean requiresFriendlyPathUpdate(WebResource webResource)

Returns whether the friendly path for the given web resource requires updating.

Parameters:

webResource - the web resource.

Returns:

true if update is required, false otherwise.

Since:

7.0.0