|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
String |
adjustFriendlyPathForClash(String originalFriendlyPath,
String clashedFriendlyPath,
int numRetry)
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. |
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 |
---|
WebResource createWebResourceByDynamicPath(String dynamicPath) throws PortalException
WebResource
instance based on a dynamic path.
dynamicPath
- the dynamic path.
IllegalArgumentException
- if dynamicPath
is not a
valid web resource dynamic path for this factory.
PortalException
void setPageCacheFilePath(PageCacheConfig pageCache) throws PortalException
PageCacheConfig
.
pageCache
- the page cache.
PortalException
boolean isCacheEnabled(WebResource webResource) throws PortalException
webResource
- the web resource.
true
if the cache is enabled, false
otherwise.
PortalException
void setWebResourcesMissingData(String resourceId, boolean processChildren) throws PortalException
resourceId
- the resource owner of the web resources.processChildren
- indicates if web resources of children resources
should also be processed.
PortalException
String adjustResolvedFriendlyPath(WebResource webResource, String friendlyPath)
webResource
- the web resource.friendlyPath
- the resolved friendly path.
String adjustFriendlyPathForClash(String originalFriendlyPath, String clashedFriendlyPath, int numRetry)
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |