Package javax.portlet
package javax.portlet
-
ClassDescriptionThe
ActionRequestrepresents the request sent to the portlet to handle an action.TheActionResponseinterface represents the portlet response to an action request.TheGenericPortletclass provides a default implementation for thePortletinterface.ThePortalContextinterface gives the portlet the ability to retrieve information about the portal calling this portlet.ThePortletinterface is used by the portlet container to invoke the portlets.ThePortletConfiginterface provides the portlet with its configuration.ThePortletContextinterface defines a portlet view of the portlet container.ThePortletExceptionclass defines a general exception that a portlet can throw when it is unable to perform its operation successfully.ThePortletModeclass represents the possible modes that a portlet can assume.ThePortletModeExceptionis thrown when a portlet tries to use or set a portlet mode that is not supported by the current runtime environment or the portlet.ThePortletPreferencesinterface allows the portlet to store configuration data.ThePortletRequestdefines the base interface to provide client request information to a portlet.ThePortletRequestDispatcherinterface 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.ThePortletResponsedefines the base interface to assist a portlet in creating and sending a response to the client.A portlet should throw aPortletSecurityExceptionwhen a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.ThePortletSessioninterface provides a way to identify a user across more than one request and to store transient information about that user.ThePortletSessionUtilclass helps identify and decode attributes in thePORTLET_SCOPEscope of the PortletSession when accessed through the HttpSession an from within calls to methods of the HttpSessionBindingListener interface.ThePortletURLinterface represents a URL that reference the portlet itself.ThePreferencesValidatorallows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.TheReadOnlyExceptionis thrown when a portlet tries to change the value for a read-only preference attribute.TheRenderRequestrepresents the request sent to the portlet to handle a render.TheRenderResponsedefines an object to assist a portlet in sending a response to the portal.The portlet should throw theUnavailableExceptionwhen the portlet is either temporarily or permanently unavailable to handle requests.TheValidatorExceptionis thrown by thevalidatemethod of a PreferencesValidator when the validation of a preference failed.TheWindowStateclass represents the possible window states that a portlet window can assume.TheWindowStateExceptionis thrown when a portlet tries to use a window state that is not supported by the current runtime environment or the portlet.