| javax.portlet |
|
Portlet API Package description
The javax.portlet package defines the API for portlets.
A portlet is a Java technology based web component, managed by a portlet container,
that processes requests and generates dynamic content. Portlets provide a presentation
layer to Information Systems.
Portlets generate fragments of markup (e.g. HTML, XHTML, WML). A portal combines markup
fragments generated by different portlets into a portal page.
A portlet container manages the lifecyle of portlets. It also provides the required runtime environment.
Portlets are bundled in Portlet Applications as web applications using the WAR file format.
A portlet application consists of two deployment descriptors: one to specify
the web application resources (web.xml) and one to specify the portlet resources
(portlet.xml).
Click
here
for an example of a portlet resources deployment descriptor (portlet.xml).
|
| Java Source File Name | Type | Comment |
| ActionRequest.java | Interface | The ActionRequest represents the request sent to the portlet
to handle an action. |
| ActionResponse.java | Interface | The ActionResponse interface represents the portlet
response to an action request. |
| GenericPortlet.java | Class | The GenericPortlet class provides a default implementation
for the Portlet interface.
It provides an abstract class to be subclassed to create portlets. |
| PortalContext.java | Interface | The PortalContext interface gives the portlet
the ability to retrieve information about the portal calling this portlet. |
| Portlet.java | Interface | The Portlet interface is used by the portlet container to
invoke the portlets. |
| PortletConfig.java | Interface | The PortletConfig interface provides the portlet with
its configuration. |
| PortletContext.java | Interface | The PortletContext interface defines a portlet view
of the portlet container.
The PortletContext also makes resources available
to the portlet. |
| PortletException.java | Class | The PortletException class defines a general exception
that a portlet can throw when it is unable to perform its operation
successfully. |
| PortletMode.java | Class | The PortletMode class represents
the possible modes that a portlet can assume.
A portlet mode indicates the function a portlet is performing.
Normally, portlets perform different tasks and create different
content depending on the function they are currently performing.
When invoking a portlet, the portlet container provides the
current portlet mode to the portlet.
Portlets can programmatically change their portlet
mode when processing an action request.
This class defines the default portlet modes EDIT, HELP, VIEW.
Additional portlet modes may be defined by calling the constructor
of this class. |
| PortletModeException.java | Class | 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. |
| PortletPreferences.java | Interface | The PortletPreferences interface allows the portlet to store
configuration data. |
| PortletRequest.java | Interface | The PortletRequest defines the base interface to provide client
request information to a portlet. |
| PortletRequestDispatcher.java | Interface | The PortletRequestDispatcher interface
defines an object that receives requests from the client
and sends them to the specified resources (such as a servlet,
HTML file, or JSP file) on the server. |
| PortletResponse.java | Interface | The PortletResponse defines the base interface to assist a
portlet in creating and sending a response to the client.
The portlet container uses two specialized versions of this interface
when invoking a portlet, ActionResponse and
RenderResponse. |
| PortletSecurityException.java | Class | A portlet should throw a PortletSecurityException
when a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container. |
| PortletSession.java | Interface | The PortletSession interface provides a way to identify a user
across more than one request and to store transient information about that user.
A PortletSession is created per user client per portlet application.
A portlet can bind an object attribute into a PortletSession by name.
The PortletSession interface defines two scopes for storing objects:
APPLICATION_SCOPE
PORTLET_SCOPE
All objects stored in the session using the APPLICATION_SCOPE
must be available to all the portlets, servlets and
JSPs that belongs to the same portlet application and that handles a
request identified as being a part of the same session.
Objects stored in the session using the PORTLET_SCOPE must be
available to the portlet during requests for the same portlet window
that the objects where stored from. |
| PortletSessionUtil.java | Class | The PortletSessionUtil class helps identify and decode
attributes in the PORTLET_SCOPE scope of the PortletSession
when accessed through the HttpSession an from within calls to methods
of the HttpSessionBindingListener interface. |
| PortletURL.java | Interface | The PortletURL interface represents a URL
that reference the portlet itself.
A PortletURL is created through the RenderResponse.
Parameters, a portlet mode, a window state and a security level
can be added to PortletURL objects. |
| PreferencesValidator.java | Interface | The PreferencesValidator allows to validate the set of
preferences of the associated portlet just before they are
stored in the persistent store. |
| ReadOnlyException.java | Class | The ReadOnlyException is thrown when a portlet tries
to change the value for a read-only preference attribute. |
| RenderRequest.java | Interface | The RenderRequest represents the request sent to the portlet
to handle a render. |
| RenderResponse.java | Interface | The RenderResponse defines an object to assist a portlet in
sending a response to the portal. |
| UnavailableException.java | Class | The portlet should throw the UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests. |
| ValidatorException.java | Class | The ValidatorException is thrown by the
validate method of a PreferencesValidator when
the validation of a preference failed. |
| WindowState.java | Class | The WindowState class represents
the possible window states that a portlet window can assume.
This class defines a standard set of the most basic portlet window states.
Additional window states may be defined by calling the constructor of
this class. |
| WindowStateException.java | Class | 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. |