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 | Class and Description |
---|---|
class |
PortletModeException
The
PortletModeException is thrown when a portlet
tries to use or set a portlet mode that is not supported by the current
runtime environment or the portlet. |
class |
PortletSecurityException
A portlet should throw a
PortletSecurityException
when a call fails because of security reasons.Additionally it can be thrown by the portal/portlet-container. |
class |
ReadOnlyException
The
ReadOnlyException is thrown when a portlet tries
to change the value for a read-only preference attribute. |
class |
UnavailableException
The portlet should throw the
UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests. |
class |
ValidatorException
The
ValidatorException is thrown by the
validate method of a PreferencesValidator when
the validation of a preference failed. |
class |
WindowStateException
The
WindowStateException is thrown when a portlet
tries to use a window state that is not supported by the current
runtime environment or the portlet. |
Modifier and Type | Method and Description |
---|---|
<T extends PortletAsyncListener> |
PortletAsyncContext.createPortletAsyncListener(Class<T> cls)
Instantiates the given
PortletAsyncListener class. |
protected boolean |
GenericPortlet.dispatchAnnotatedActionMethod(String name,
ActionRequest request,
ActionResponse response)
Dispatches an action request to an annotated action method.
|
protected boolean |
GenericPortlet.dispatchAnnotatedEventMethod(String name,
EventRequest request,
EventResponse response)
Dispatches an event request to an annotated event method.
|
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. |
void |
PortletRequestDispatcher.forward(PortletRequest request,
PortletResponse response)
Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file)
on the server.
|
javax.servlet.http.Part |
ClientDataRequest.getPart(String name)
Gets the Part with the given name.
|
Collection<javax.servlet.http.Part> |
ClientDataRequest.getParts()
Gets all the Part components of this request, provided that it is of type multipart/form-data.
|
void |
PortletRequestDispatcher.include(PortletRequest request,
PortletResponse response)
Includes the content of a resource (servlet, JSP page, HTML file) in the
response.
|
void |
PortletRequestDispatcher.include(RenderRequest request,
RenderResponse response)
Includes the content of a resource (servlet, JSP page, HTML file) in the
response.
|
void |
GenericPortlet.init()
A convenience method which can be overridden so that there's no need to
call
super.init(config) . |
void |
GenericPortlet.init(PortletConfig config)
Called by the portlet container to indicate to a portlet that the portlet
is being placed into service.
|
void |
Portlet.init(PortletConfig config)
Called by the portlet container to indicate to a portlet that the
portlet is being placed into service.
|
void |
GenericPortlet.processAction(ActionRequest request,
ActionResponse response)
Called by the portlet container to allow the portlet to process an action
request.
|
void |
Portlet.processAction(ActionRequest request,
ActionResponse response)
Called by the portlet container to allow the portlet to process
an action request.
|
void |
GenericPortlet.processEvent(EventRequest request,
EventResponse response)
The default implementation tries to dispatch to a method
annotated with
@ProcessEvent that matches the
event name or, if no
such method is found just sets the current render parameters on
the response.Note that the annotated methods needs to be public in order to be allowed to be called by GenericPortlet . |
void |
EventPortlet.processEvent(EventRequest request,
EventResponse response)
Called by the portlet container requesting the portlet
to process a specific event.
|
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.
|
void |
GenericPortlet.renderHeaders(HeaderRequest request,
HeaderResponse response)
V3 method implementing the headers stage within the render phase.
|
void |
HeaderPortlet.renderHeaders(HeaderRequest request,
HeaderResponse response)
Called by the portlet container to allow the portlet to set response
headers and generate markup for overall response document head section.
|
void |
GenericPortlet.serveResource(ResourceRequest request,
ResourceResponse response)
Default resource serving.
|
void |
ResourceServingPortlet.serveResource(ResourceRequest request,
ResourceResponse response)
Called by the portlet container to allow the portlet to generate
the resource content based on its current state.
|
Modifier and Type | Method and Description |
---|---|
<T extends PortletAsyncListener> |
PortletAsyncContextWrapper.createPortletAsyncListener(Class<T> cls) |
void |
FilterChain.doFilter(ActionRequest request,
ActionResponse 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 |
ActionFilter.doFilter(ActionRequest request,
ActionResponse response,
FilterChain chain)
The
doFilter method of the Filter is called by the
portlet container each time a action request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain. |
void |
FilterChain.doFilter(EventRequest request,
EventResponse 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 |
EventFilter.doFilter(EventRequest request,
EventResponse response,
FilterChain chain)
The
doFilter method of the Filter is called by the
portlet container each time a event request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain. |
void |
HeaderFilterChain.doFilter(HeaderRequest request,
HeaderResponse 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 |
HeaderFilter.doFilter(HeaderRequest request,
HeaderResponse response,
HeaderFilterChain chain)
The
doFilter method of the Filter is called by the
portlet container each time a header request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain. |
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 |
FilterChain.doFilter(ResourceRequest request,
ResourceResponse 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 |
ResourceFilter.doFilter(ResourceRequest request,
ResourceResponse response,
FilterChain chain)
The
doFilter method of the Filter is called by the
portlet container each time a resource 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.forward(PortletRequest request,
PortletResponse response) |
javax.servlet.http.Part |
ClientDataRequestWrapper.getPart(String name) |
Collection<javax.servlet.http.Part> |
ClientDataRequestWrapper.getParts() |
void |
PortletRequestDispatcherWrapper.include(PortletRequest request,
PortletResponse response) |
void |
PortletRequestDispatcherWrapper.include(RenderRequest request,
RenderResponse response) |
void |
PortletFilter.init(FilterConfig filterConfig)
Called by the portlet container to indicate to a filter
that it is being placed into service.
|
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.