Package 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).
-
ClassDescriptionThe
ActionRequest
represents the request sent to the portlet to handle an action.TheActionResponse
interface represents the portlet response to an action request.TheGenericPortlet
class provides a default implementation for thePortlet
interface.ThePortalContext
interface gives the portlet the ability to retrieve information about the portal calling this portlet.ThePortlet
interface is used by the portlet container to invoke the portlets.ThePortletConfig
interface provides the portlet with its configuration.ThePortletContext
interface defines a portlet view of the portlet container.ThePortletException
class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.ThePortletMode
class represents the possible modes that a portlet can assume.ThePortletModeException
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.ThePortletPreferences
interface allows the portlet to store configuration data.ThePortletRequest
defines the base interface to provide client request information to a portlet.ThePortletRequestDispatcher
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.ThePortletResponse
defines the base interface to assist a portlet in creating and sending a response to the client.A portlet should throw aPortletSecurityException
when a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.ThePortletSession
interface provides a way to identify a user across more than one request and to store transient information about that user.ThePortletSessionUtil
class helps identify and decode attributes in thePORTLET_SCOPE
scope of the PortletSession when accessed through the HttpSession an from within calls to methods of the HttpSessionBindingListener interface.ThePortletURL
interface represents a URL that reference the portlet itself.ThePreferencesValidator
allows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.TheReadOnlyException
is thrown when a portlet tries to change the value for a read-only preference attribute.TheRenderRequest
represents the request sent to the portlet to handle a render.TheRenderResponse
defines an object to assist a portlet in sending a response to the portal.The portlet should throw theUnavailableException
when the portlet is either temporarily or permanently unavailable to handle requests.TheUnmodifiableException
is thrown when a portlet tries to change the value for a preference attribute, marked as unmodifiable in the deployment descriptor with thenon-modifiable
tag, without the needed permissions.TheValidatorException
is thrown by thevalidate
method of a PreferencesValidator when the validation of a preference failed.TheWindowState
class represents the possible window states that a portlet window can assume.TheWindowStateException
is thrown when a portlet tries to use a window state that is not supported by the current runtime environment or the portlet.