public interface MVCHeaderCommand extends MVCCommand
MVCPortlet
.
The header command that to be invoked is determined by two factors:
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 header
command.
mvc.command.name
: the command name that matches the
parameter value mvcRenderCommandName
. This name cannot contain
any comma (,
).
The method MVCPortlet.renderHeaders(HeaderRequest, HeaderResponse)
searches the OSGi Registry for the header 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 header commands registered for the same portlet name and with the same command name, only the header command with the highest service ranking is invoked.
Modifier and Type | Field and Description |
---|---|
static MVCHeaderCommand |
EMPTY |
Modifier and Type | Method and Description |
---|---|
String |
renderHeaders(javax.portlet.HeaderRequest headerRequest,
javax.portlet.HeaderResponse headerResponse)
Invoked by
MVCPortlet to handle the header phase of the portlet. |
static final MVCHeaderCommand EMPTY
String renderHeaders(javax.portlet.HeaderRequest headerRequest, javax.portlet.HeaderResponse headerResponse) throws javax.portlet.PortletException
MVCPortlet
to handle the header phase of the portlet.headerRequest
- the header requestheaderResponse
- the header responsejavax.portlet.PortletException