Uses of Package
javax.portlet

Packages that use javax.portlet

Package	Description
javax.portlet	The javax.portlet package defines the API for the Java Portlet Specification V3.0.
javax.portlet.filter	The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.

Classes in javax.portlet used by javax.portlet

Class and Description
ActionParameters Action parameters are additional portlet parameters added to the portlet URL or provided by the client that extend the state information provided by the render parameters.
ActionRequest The ActionRequest represents the request sent to the portlet to handle an action. It extends the ClientDataRequest interface and provides action request information to portlets.
ActionResponse The ActionResponse interface represents the portlet response to an action request.
ActionURL An action URL is created with MimeResponse.createActionURL().
BaseURL The BaseURL defines the basic capabilities of a portlet URL pointing back to the portlet.
CacheControl The CacheControl interface represents cache settings for a piece of markup.
ClientDataRequest The ClientDataRequest represents the request information of the HTTP request issued from the client to the portal. It extends the PortletRequest interface.
Event The Event interface represents an event that the portlet has received in the event processing phase.
EventPortlet The EventPortlet interface allows portlets receiving events.
EventRequest The EventRequest represents the request sent to the portlet to handle an event.
EventResponse The EventResponse interface represents the portlet response to an event request.
HeaderPortlet The HeaderPortlet interface provides portlets with the ability to add HTTP headers to the response, and to generate markup for aggregation into the portal response document head section.
HeaderRequest Tag interface designating a header request object.
HeaderResponse The portlet programming interface provides a mechanism to assist portlets when the aggregated portal markup is an HTML or similar document that requires markup for the document HEAD section to be written and HTTP headers to be set before the render markup for each individual portlet is aggregated.
MimeResponse The MimeResponse defines the base interface to assist a portlet in returning MIME content.
MimeResponse.Copy Specifies processing when a URL is created.
Mutable This is a marker interface indicating that the implementing object contains methods for updating portelt state information.
MutableActionParameters Action parameters are additional portlet parameters added to the portlet URL or provided by the client that extend the state information provided by the render parameters.
MutablePortletParameters The MutablePortletParameters provides methods that allow setting parameters to define a potential future render state.
MutableRenderParameters Provides methods that allow setting parameters to define a potential future render state.
MutableRenderState Provides read-write access to the render state.
MutableResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
PortalContext The PortalContext interface gives the portlet the ability to retrieve information about the portal calling this portlet.
Portlet The Portlet interface is used by the portlet container to invoke the portlets.
PortletAsyncContext Class representing the execution context for an asynchronous operation that was initiated on a ResourceRequest.
PortletAsyncEvent Event that gets fired when the asynchronous operation initiated on a ResourceRequest (via a call to ResourceRequest#startAsync or ResourceRequest#startAsync(ResourceRequest, ResouceResponse)) has completed, timed out, or produced an error.
PortletAsyncListener Listener that will be notified in the event that an asynchronous operation initiated on a ResourceRequest to which the listener had been added has completed, timed out, or resulted in an error.
PortletConfig The PortletConfig interface provides the portlet with its configuration.
PortletContext The PortletContext interface defines a portlet view of the portlet container.
PortletException The PortletException class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.
PortletMode The PortletMode class represents the possible modes that a portlet can assume.
PortletModeException 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.
PortletParameters The PortletParameters interface defines the API for accessing the parameters that are set for the portlet or on a portlet URL.
PortletPreferences The PortletPreferences interface allows the portlet to store configuration data.
PortletRequest The PortletRequest defines the base interface to provide client request information to a portlet.
PortletRequest.P3PUserInfos P3P user information constants.
PortletRequestDispatcher 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 The PortletResponse defines the base interface to assist a portlet in creating and sending a response to the client.
PortletSecurityException 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 The PortletSession interface provides a way to identify a user across more than one request and to store transient information about that user.
PortletURL The PortletURL interface represents a URL that reference the portlet itself.
ReadOnlyException The ReadOnlyException is thrown when a portlet tries to change the value for a read-only preference attribute.
RenderParameters Provides access to render parameters, which make up part of the render state.
RenderRequest The RenderRequest represents the request sent to the portlet to handle a render.
RenderResponse The RenderResponse defines an object to assist a portlet in sending a response to the portal.
RenderState Provides read-only access to the render state.
RenderURL This is a marker interface for a render URL.
ResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
ResourceRequest The ResourceRequest interface represents the request send to the portlet for rendering resources.
ResourceResponse The ResourceResponse defines an object to assist a portlet for rendering a resource.
ResourceServingPortlet The ResourceServingPortlet interface allows serving resources through the portlet.
ResourceURL The ResourceURL defines a resource URL that when clicked will result in a serveResource call of the ResourceServingPortlet interface.
StateAwareResponse The StateAwareResponse represents a response that can modify render state information or send events.
ValidatorException The ValidatorException is thrown by the validate method of a PreferencesValidator when the validation of a preference failed.
WindowState The WindowState class represents the possible window states that a portlet window can assume.
WindowStateException 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.

Classes in javax.portlet used by javax.portlet.filter

Class and Description
ActionParameters Action parameters are additional portlet parameters added to the portlet URL or provided by the client that extend the state information provided by the render parameters.
ActionRequest The ActionRequest represents the request sent to the portlet to handle an action. It extends the ClientDataRequest interface and provides action request information to portlets.
ActionResponse The ActionResponse interface represents the portlet response to an action request.
ActionURL An action URL is created with MimeResponse.createActionURL().
BaseURL The BaseURL defines the basic capabilities of a portlet URL pointing back to the portlet.
CacheControl The CacheControl interface represents cache settings for a piece of markup.
ClientDataRequest The ClientDataRequest represents the request information of the HTTP request issued from the client to the portal. It extends the PortletRequest interface.
Event The Event interface represents an event that the portlet has received in the event processing phase.
EventRequest The EventRequest represents the request sent to the portlet to handle an event.
EventResponse The EventResponse interface represents the portlet response to an event request.
HeaderRequest Tag interface designating a header request object.
HeaderResponse The portlet programming interface provides a mechanism to assist portlets when the aggregated portal markup is an HTML or similar document that requires markup for the document HEAD section to be written and HTTP headers to be set before the render markup for each individual portlet is aggregated.
MimeResponse The MimeResponse defines the base interface to assist a portlet in returning MIME content.
MimeResponse.Copy Specifies processing when a URL is created.
Mutable This is a marker interface indicating that the implementing object contains methods for updating portelt state information.
MutableActionParameters Action parameters are additional portlet parameters added to the portlet URL or provided by the client that extend the state information provided by the render parameters.
MutablePortletParameters The MutablePortletParameters provides methods that allow setting parameters to define a potential future render state.
MutableRenderParameters Provides methods that allow setting parameters to define a potential future render state.
MutableRenderState Provides read-write access to the render state.
MutableResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
PortalContext The PortalContext interface gives the portlet the ability to retrieve information about the portal calling this portlet.
PortletAsyncContext Class representing the execution context for an asynchronous operation that was initiated on a ResourceRequest.
PortletAsyncListener Listener that will be notified in the event that an asynchronous operation initiated on a ResourceRequest to which the listener had been added has completed, timed out, or resulted in an error.
PortletConfig The PortletConfig interface provides the portlet with its configuration.
PortletContext The PortletContext interface defines a portlet view of the portlet container.
PortletException The PortletException class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.
PortletMode The PortletMode class represents the possible modes that a portlet can assume.
PortletModeException 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.
PortletParameters The PortletParameters interface defines the API for accessing the parameters that are set for the portlet or on a portlet URL.
PortletPreferences The PortletPreferences interface allows the portlet to store configuration data.
PortletRequest The PortletRequest defines the base interface to provide client request information to a portlet.
PortletRequestDispatcher 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 The PortletResponse defines the base interface to assist a portlet in creating and sending a response to the client.
PortletSecurityException 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 The PortletSession interface provides a way to identify a user across more than one request and to store transient information about that user.
PortletURL The PortletURL interface represents a URL that reference the portlet itself.
RenderParameters Provides access to render parameters, which make up part of the render state.
RenderRequest The RenderRequest represents the request sent to the portlet to handle a render.
RenderResponse The RenderResponse defines an object to assist a portlet in sending a response to the portal.
RenderState Provides read-only access to the render state.
RenderURL This is a marker interface for a render URL.
ResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
ResourceRequest The ResourceRequest interface represents the request send to the portlet for rendering resources.
ResourceResponse The ResourceResponse defines an object to assist a portlet for rendering a resource.
ResourceURL The ResourceURL defines a resource URL that when clicked will result in a serveResource call of the ResourceServingPortlet interface.
StateAwareResponse The StateAwareResponse represents a response that can modify render state information or send events.
WindowState The WindowState class represents the possible window states that a portlet window can assume.
WindowStateException 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.