lumis.portal.url

Interface IURLResolver

All Known Implementing Classes:

FriendlyUrlResolver, GenericURLResolver

@StableMinor(version="12.4",
             sinceVersion="5.0")
public interface IURLResolver

Defines methods used for resolving portal web resource URLs. This interface may be implemented to customize how the URLs are resolved.

The methods of this interface are always called inside a transactional context.

Since:

5.0.0

Version:

$Revision: 23904 $ $Date: 2020-06-16 15:23:44 +0000 (Tue, 16 Jun 2020) $

See Also:

lumis.portal.url

Method Summary

Modifier and Type	Method and Description
String	resolveFriendlyPath(WebResource resource, String currentPath) Resolves the friendly path for a web resource.

Method Detail

resolveFriendlyPath

String resolveFriendlyPath(WebResource resource,
                           String currentPath)
                    throws PortalException

Resolves the friendly path for a web resource.

Parameters:

resource - the web resource.

currentPath - the path value resolved by previous IURLResolver in the resolution pipeline, or an empty String if this is the first resolver in the pipeline.

Returns:

the resolved friendly path value. The final friendly path for the resolution pipeline must one of the following alternatives:

• "/" for the root web resource for its website
• a string value that starts with '/'. If it is a path for a ChannelWebResource, it must not end with '/'. If it is a path for a PageWebResource, it may end with '/', and in this case the friendly path will be a directory and any corresponding HTML cache will be generated as a index file inside such directory.
• an empty string for no friendly path

Throws:

PortalException

Since:

5.0.0