|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.util.bridges.wai.WAIFriendlyURLMapper
public class WAIFriendlyURLMapper
| Field Summary | |
|---|---|
protected Router |
router
|
| Constructor Summary | |
|---|---|
WAIFriendlyURLMapper()
|
|
| Method Summary | |
|---|---|
String |
buildPath(LiferayPortletURL liferayPortletURL)
Generates a friendly URL path from the portlet URL object. |
String |
getMapping()
Returns the friendly URL mapping for this portlet. |
String |
getPortletId()
Returns the ID of this portlet |
Router |
getRouter()
Returns the router for this friendly URL mapper |
protected boolean |
hasBinaryExtension(String friendlyURLPath)
|
boolean |
isCheckMappingWithPrefix()
Returns true if the friendly URLs for this mapper should
include the friendly URL separator. |
boolean |
isPortletInstanceable()
Returns true if this portlet is instanceable. |
void |
populateParams(String friendlyURLPath,
Map<String,String[]> parameterMap,
Map<String,Object> requestContext)
Populates the parameter map with values parsed from the friendly URL path. |
void |
setMapping(String mapping)
Sets the friendly URL mapping for this portlet. |
void |
setPortletId(String portletId)
Sets the ID of this portlet. |
void |
setPortletInstanceable(boolean portletInstanceable)
Sets whether this portlet is instanceable. |
void |
setRouter(Router router)
Sets the router for this friendly URL mapper. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Router router
| Constructor Detail |
|---|
public WAIFriendlyURLMapper()
| Method Detail |
|---|
public String buildPath(LiferayPortletURL liferayPortletURL)
FriendlyURLMapper
buildPath in interface FriendlyURLMapperliferayPortletURL - the portlet URL object to generate a friendly
URL for
null if one cannot be
built. Returning null will cause a normal portlet
URL to be generated.public String getMapping()
FriendlyURLMapper
The friendly URL mapping is used by Liferay to identify the portlet a
friendly URL refers to. It generally appears directly after the
/-/ in the URL.
For instance, the blogs portlet mapping is "blogs". This
produces friendly URLs similar to
http://www.liferay.com/web/guest/blog/-/blogs/example-post
getMapping in interface FriendlyURLMapperpublic String getPortletId()
FriendlyURLMapper
getPortletId in interface FriendlyURLMapperpublic Router getRouter()
FriendlyURLMapper
getRouter in interface FriendlyURLMappernull if one has not been setpublic boolean isCheckMappingWithPrefix()
FriendlyURLMappertrue 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.
isCheckMappingWithPrefix in interface FriendlyURLMappertrue if the "/-/" separator should be
included in friendly URLs, or false if only a
"/" should be usedpublic boolean isPortletInstanceable()
FriendlyURLMappertrue if this portlet is instanceable.
The value returned from this method has no effect on whether a portlet is instanceable, it is a helper method used to determine if the instance ID should be included in the URL.
isPortletInstanceable in interface FriendlyURLMappertrue if the portlet is instanceable;
false otherwise
public void populateParams(String friendlyURLPath,
Map<String,String[]> parameterMap,
Map<String,Object> requestContext)
FriendlyURLMapper
This method is called by PortalImpl when
a friendly URL is processed.
populateParams in interface FriendlyURLMapperfriendlyURLPath - the friendly URL path, including a leading slash
and the friendly URL mapping. For example:
/blogs/example-postparameterMap - the parameter map. Entries added to this map must be
namespaced.requestContext - the request contextBaseFriendlyURLMapper.addParameter(Map, String, String),
BaseFriendlyURLMapper.addParameter(String, Map, String, String)public void setMapping(String mapping)
FriendlyURLMapper
This method is automatically called by PortletBagFactory with the friendly URL mapping
defined in liferay-portlet.xml.
setMapping in interface FriendlyURLMappermapping - the friendly URL mapping for this portletpublic void setPortletId(String portletId)
FriendlyURLMapper
This method is automatically called by PortletBagFactory with the portlet ID defined in
liferay-portlet.xml.
setPortletId in interface FriendlyURLMapperportletId - the ID of this portlet.public void setPortletInstanceable(boolean portletInstanceable)
FriendlyURLMapper
setPortletInstanceable in interface FriendlyURLMapperportletInstanceable - whether this portlet is instanceablepublic void setRouter(Router router)
FriendlyURLMapper
This method is automatically called by PortletBagFactory with a router populated with the
routes defined in this portlet's friendly-url-routes.xml file. The location of this file is defined
in this portlet's liferay-portlet.xml file.
setRouter in interface FriendlyURLMapperrouter - the router for this friendly URL mapperprotected boolean hasBinaryExtension(String friendlyURLPath)
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||