com.liferay.portlet.tagscompiler
Class TagsCompilerFriendlyURLMapper

java.lang.Object
  com.liferay.portal.kernel.portlet.BaseFriendlyURLMapper
      com.liferay.portlet.tagscompiler.TagsCompilerFriendlyURLMapper

All Implemented Interfaces:

FriendlyURLMapper

public class TagsCompilerFriendlyURLMapper
extends BaseFriendlyURLMapper

Field Summary

Fields inherited from class com.liferay.portal.kernel.portlet.BaseFriendlyURLMapper

router

Constructor Summary

TagsCompilerFriendlyURLMapper()

Method Summary

String	buildPath(LiferayPortletURL liferayPortletURL) Generates a friendly URL path from the portlet URL object.
boolean	isCheckMappingWithPrefix() Returns true if the friendly URLs for this mapper should include the friendly URL separator.
void	populateParams(String friendlyURLPath, Map<String,String[]> parameterMap, Map<String,Object> requestContext) Populates the parameter map with values parsed from the friendly URL path.

Methods inherited from class com.liferay.portal.kernel.portlet.BaseFriendlyURLMapper

addParam, addParam, addParameter, addParameter, addParameter, addParameter, getMapping, getNamespace, getPortletId, getRouter, isPortletInstanceable, setMapping, setPortletId, setPortletInstanceable, setRouter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagsCompilerFriendlyURLMapper

public TagsCompilerFriendlyURLMapper()

Method Detail

buildPath

public String buildPath(LiferayPortletURL liferayPortletURL)

Description copied from interface: FriendlyURLMapper

Generates a friendly URL path from the portlet URL object.

Parameters:

liferayPortletURL - the portlet URL object to generate a friendly URL for

Returns:

the generated friendly URL, or null if one cannot be built. Returning null will cause a normal portlet URL to be generated.

isCheckMappingWithPrefix

public boolean isCheckMappingWithPrefix()

Description copied from interface: FriendlyURLMapper

Returns true if the friendly URLs for this mapper should include the friendly URL separator.

Typically, friendly URLs will include the separator "/-/" before the friendly URL mapping. If this method returns false, a single slash will be used instead.

This method is called by PortalImpl when a friendly URL is processed.

It is strongly recommended that this method always return true.

Specified by:

isCheckMappingWithPrefix in interface FriendlyURLMapper

Overrides:

isCheckMappingWithPrefix in class BaseFriendlyURLMapper

Returns:

true if the "/-/" separator should be included in friendly URLs, or false if only a "/" should be used

populateParams

public void populateParams(String friendlyURLPath,
                           Map<String,String[]> parameterMap,
                           Map<String,Object> requestContext)

Description copied from interface: FriendlyURLMapper

Populates the parameter map with values parsed from the friendly URL path.

This method is called by PortalImpl when a friendly URL is processed.

Parameters:

friendlyURLPath - the friendly URL path, including a leading slash and the friendly URL mapping. For example: /blogs/example-post

parameterMap - the parameter map. Entries added to this map must be namespaced.

requestContext - the request context

See Also:

BaseFriendlyURLMapper.addParameter(Map, String, String), BaseFriendlyURLMapper.addParameter(String, Map, String, String)