All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description ActionFilter TheActionFilteris an object that performs filtering tasks on either the action request to a portlet, or on the action response from a portlet, or both.ActionRequest TheActionRequestrepresents the request sent to the portlet to handle an action.
It extends the ClientDataRequest interface and provides action request information to portlets.ActionRequestWrapper TheActionRequestWrapperprovides a convenient implementation of theActionRequestinterface that can be subclassed by developers wishing to adapt the request.ActionResponse TheActionResponseinterface represents the portlet response to an action request.ActionResponseWrapper TheActionResponseWrapperprovides a convenient implementation of theActionResponseinterface that can be subclassed by developers wishing to adapt the response.BaseURL TheBaseURLdefines the basic capabilities of a portlet URL pointing back to the portlet.CacheControl TheCacheControlinterface represents cache settings for a piece of markup.ClientDataRequest TheClientDataRequestrepresents the request information of the HTTP request issued from the client to the portal.
It extends the PortletRequest interface.Event TheEventinterface represents an event that the portlet has received in the event processing phase.EventFilter TheEventFilteris an object that performs filtering tasks on either the event request to a portlet, or on the event response from a portlet, or both.EventPortlet TheEventPortletinterface allows portlets receiving events.EventRequest TheEventRequestrepresents the request sent to the portlet to handle an event.EventRequestWrapper TheEventRequestWrapperprovides a convenient implementation of theEventRequestinterface that can be subclassed by developers wishing to adapt the request.EventResponse TheEventResponseinterface represents the portlet response to an event request.EventResponseWrapper TheEventResponseWrapperprovides a convenient implementation of theEventResponseinterface that can be subclassed by developers wishing to adapt the response.FilterChain AFilterChainis an object provided by the portlet container to the developer giving a view into the invocation chain of a filtered request for a portlet.FilterConfig A filter configuration object used by a portlet container to pass information to a filter during initialization.GenericPortlet TheGenericPortletclass provides a default implementation for thePortletinterface.MimeResponse TheMimeResponsedefines the base interface to assist a portlet in returning MIME content.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.PortletException ThePortletExceptionclass defines a general exception that a portlet can throw when it is unable to perform its operation successfully.PortletFilter ThePortletFilteris the base interface for all portlet filters.PortletMode ThePortletModeclass represents the possible modes that a portlet can assume.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.PortletPreferences ThePortletPreferencesinterface allows the portlet to store configuration data.PortletRequest ThePortletRequestdefines the base interface to provide client request information to a portlet.PortletRequest.P3PUserInfos P3P user information constants.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.PortletRequestWrapper ThePortletRequestWrapperprovides a convenient implementation of thePortletRequestinterface and is extended by other request wrappers.PortletResponse ThePortletResponsedefines the base interface to assist a portlet in creating and sending a response to the client.PortletResponseWrapper ThePortletResponseWrapperprovides a convenient implementation of thePortletResponseinterface and is extended by other response wrappers.PortletSecurityException A portlet should throw aPortletSecurityExceptionwhen a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.PortletSession ThePortletSessioninterface provides a way to identify a user across more than one request and to store transient information about that user.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.PortletURL ThePortletURLinterface represents a URL that reference the portlet itself.PortletURLGenerationListener Portlet applications can register portlet URL listeners in order to filter URLs before they get generated.PreferencesValidator ThePreferencesValidatorallows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.ProcessAction Annotation for marking a method for processing a specific action.ProcessEvent Annotation for marking a method for handling a specific event.ReadOnlyException TheReadOnlyExceptionis thrown when a portlet tries to change the value for a read-only preference attribute.RenderFilter TheRenderFilteris an object that performs filtering tasks on either the render request to a portlet, or on the render response from a portlet, or both.RenderMode Annotation for marking a method for handling a specific portlet mode in the render phase.RenderRequest TheRenderRequestrepresents the request sent to the portlet to handle a render.RenderRequestWrapper TheRenderRequestWrapperprovides a convenient implementation of theRenderRequestinterface that can be subclassed by developers wishing to adapt the request.RenderResponse TheRenderResponsedefines an object to assist a portlet in sending a response to the portal.RenderResponseWrapper TheRenderResponseWrapperprovides a convenient implementation of theRenderResponseinterface that can be subclassed by developers wishing to adapt the response.ResourceFilter TheResourceFilteris an object that performs filtering tasks on either the resource request to a portlet, or on the resource response from a portlet, or both.ResourceRequest TheResourceRequestinterface represents the request send to the portlet for rendering resources.ResourceRequestWrapper TheResourceRequestWrapperprovides a convenient implementation of theResourceRequestinterface that can be subclassed by developers wishing to adapt the request.ResourceResponse TheResourceResponsedefines an object to assist a portlet for rendering a resource.ResourceResponseWrapper TheResourceResponseWrapperprovides a convenient implementation of theResourceResponseinterface that can be subclassed by developers wishing to adapt the response.ResourceServingPortlet TheResourceServingPortletinterface allows serving resources through the portlet.ResourceURL TheResourceURLdefines a resource URL that when clicked will result in aserveResourcecall of theResourceServingPortletinterface.StateAwareResponse TheStateAwareResponserepresents a response that can modify state information or send events.
It extends the PortletResponse interface.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.WindowState TheWindowStateclass represents the possible window states that a portlet window can assume.WindowStateException TheWindowStateExceptionis thrown when a portlet tries to use a window state that is not supported by the current runtime environment or the portlet.