Package | Description |
---|---|
javax.portlet |
The javax.portlet package defines the API
for the Java Portlet Specification V3.0.
|
javax.portlet.filter |
The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.
|
Modifier and Type | Interface and Description |
---|---|
interface |
HeaderRequest
Tag interface designating a header request object.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
GenericPortlet.dispatchAnnotatedRenderMethod(String name,
RenderRequest request,
RenderResponse response)
Dispatches an render request to an annotated render method.
|
protected void |
GenericPortlet.doDispatch(RenderRequest request,
RenderResponse response)
The default implementation of this method routes the render request to:
method annotated with
@RenderMode and the name of the portlet mode
a set of helper methods depending on the current portlet mode the portlet
is currently in. |
protected void |
GenericPortlet.doEdit(RenderRequest request,
RenderResponse response)
Helper method to serve up the
edit mode. |
protected void |
GenericPortlet.doHeaders(RenderRequest request,
RenderResponse response)
Used
by the render method to set the response properties and headers.
|
protected void |
GenericPortlet.doHelp(RenderRequest request,
RenderResponse response)
Helper method to serve up the
help mode. |
protected void |
GenericPortlet.doView(RenderRequest request,
RenderResponse response)
Helper method to serve up the mandatory
view mode. |
protected Collection<PortletMode> |
GenericPortlet.getNextPossiblePortletModes(RenderRequest request)
Used by the render method to set the next possible portlet modes.
|
protected String |
GenericPortlet.getTitle(RenderRequest request)
Used by the render method to get the title.
|
void |
PortletRequestDispatcher.include(RenderRequest request,
RenderResponse response)
Includes the content of a resource (servlet, JSP page, HTML file) in the
response.
|
void |
GenericPortlet.render(RenderRequest request,
RenderResponse response)
The default implementation of this method sets the headers using the
doHeaders method, sets the title using the
getTitle method and invokes the doDispatch
method. |
void |
Portlet.render(RenderRequest request,
RenderResponse response)
Called by the portlet container to allow the portlet to generate
the content of the response based on its current state.
|
Modifier and Type | Class and Description |
---|---|
class |
HeaderRequestWrapper
The
HeaderRequestWrapper provides a convenient
implementation of the HeaderRequest interface
that can be subclassed by developers. |
class |
RenderRequestWrapper
The
RenderRequestWrapper provides a convenient
implementation of the RenderRequest interface
that can be subclassed by developers. |
Modifier and Type | Method and Description |
---|---|
RenderRequest |
RenderRequestWrapper.getRequest()
Return the wrapped request object.
|
Modifier and Type | Method and Description |
---|---|
void |
FilterChain.doFilter(RenderRequest request,
RenderResponse response)
Causes the next filter in the chain to be invoked,
or if the calling filter is the last filter in the chain,
causes the portlet at the end of the chain to be invoked.
|
void |
RenderFilter.doFilter(RenderRequest request,
RenderResponse response,
FilterChain chain)
The
doFilter method of the Filter is called by the
portlet container each time a render request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain. |
void |
PortletRequestDispatcherWrapper.include(RenderRequest request,
RenderResponse response) |
void |
RenderRequestWrapper.setRequest(RenderRequest request)
Sets the request object being wrapped.
|
Constructor and Description |
---|
RenderRequestWrapper(RenderRequest request)
Creates an
RenderRequest adaptor
wrapping the given request object. |
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.