Package javax.portlet
-
Interface Summary Interface Description ActionRequest TheActionRequestrepresents the request sent to the portlet to handle an action.ActionResponse TheActionResponseinterface represents the portlet response to an action request.PortalContext ThePortalContextinterface gives the portlet the ability to retrieve information about the portal calling this portlet.Portlet ThePortletinterface is used by the portlet container to invoke the portlets.PortletConfig ThePortletConfiginterface provides the portlet with its configuration.PortletContext ThePortletContextinterface defines a portlet view of the portlet container.PortletPreferences ThePortletPreferencesinterface allows the portlet to store configuration data.PortletRequest ThePortletRequestdefines the base interface to provide client request information to a portlet.PortletRequestDispatcher 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.PortletResponse ThePortletResponsedefines the base interface to assist a portlet in creating and sending a response to the client.PortletSession ThePortletSessioninterface provides a way to identify a user across more than one request and to store transient information about that user.PortletURL ThePortletURLinterface represents a URL that reference the portlet itself.PreferencesValidator ThePreferencesValidatorallows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.RenderRequest TheRenderRequestrepresents the request sent to the portlet to handle a render.RenderResponse TheRenderResponsedefines an object to assist a portlet in sending a response to the portal. -
Class Summary Class Description GenericPortlet TheGenericPortletclass provides a default implementation for thePortletinterface.PortletMode ThePortletModeclass represents the possible modes that a portlet can assume.PortletSessionUtil 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.WindowState TheWindowStateclass represents the possible window states that a portlet window can assume. -
Exception Summary Exception Description PortletException ThePortletExceptionclass defines a general exception that a portlet can throw when it is unable to perform its operation successfully.PortletModeException 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.PortletSecurityException A portlet should throw aPortletSecurityExceptionwhen a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.ReadOnlyException TheReadOnlyExceptionis thrown when a portlet tries to change the value for a read-only preference attribute.UnavailableException The portlet should throw theUnavailableExceptionwhen the portlet is either temporarily or permanently unavailable to handle requests.ValidatorException TheValidatorExceptionis thrown by thevalidatemethod of a PreferencesValidator when the validation of a preference failed.WindowStateException TheWindowStateExceptionis thrown when a portlet tries to use a window state that is not supported by the current runtime environment or the portlet.