Interface MVCRenderCommand
- All Superinterfaces:
MVCCommand
Provides an interface to handle the render phase of the portlet. This
interface can only be used when the portlet is based on
MVCPortlet
.
The render command that to be invoked is determined by two factors:
- The portlet name that the render URL is referring to.
-
The parameter value
mvcRenderCommandName
of the render URL.
Implementations of this interface must be OSGi components that are registered in the OSGi Registry with the following properties:
-
javax.portlet.name
: The portlet name associated to this render command. -
mvc.command.name
: the command name that matches the parameter valuemvcRenderCommandName
. This name cannot contain any comma (,
).
The method MVCPortlet.render(RenderRequest, RenderResponse)
searches
the OSGi Registry for the render command that matches both the portlet name
with the property javax.portlet.name
and the parameter value
mvc.command.name
with the property
mvc.command.name
.
When there are multiple render commands registered for the same portlet name and with the same command name, only the render command with the highest service ranking is invoked.
- Author:
- Sergio González
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionrender
(RenderRequest renderRequest, RenderResponse renderResponse) Invoked byMVCPortlet
to handle the render phase of the portlet.
-
Field Details
-
EMPTY
-
-
Method Details
-
render
Invoked byMVCPortlet
to handle the render phase of the portlet.- Parameters:
renderRequest
- the render requestrenderResponse
- the render response- Returns:
- the path that should be dispatched
- Throws:
PortletException
-