Java Portlet API V3.0 3.0.1 · javax.portlet

Interface Summary

Modifier and Type	Interface and Description
public interface	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.
public interface	ActionRequest The `ActionRequest` represents the request sent to the portlet to handle an action.
public interface	ActionResponse The `ActionResponse` interface represents the portlet response to an action request.
public interface	ActionURL An action URL is created with `MimeResponse#createActionURL()`.
public interface	BaseURL The `BaseURL` defines the basic capabilities of a portlet URL pointing back to the portlet.
public interface	CacheControl The `CacheControl` interface represents cache settings for a piece of markup.
public interface	ClientDataRequest The `ClientDataRequest` represents the request information of the HTTP request issued from the client to the portal.
public interface	Event The `Event` interface represents an event that the portlet has received in the event processing phase.
public interface	EventPortlet The `EventPortlet` interface allows portlets receiving events.
public interface	EventRequest The `EventRequest` represents the request sent to the portlet to handle an event.
public interface	EventResponse The `EventResponse` interface represents the portlet response to an event request.
public interface	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.
public interface	HeaderRequest Tag interface designating a header request object.
public interface	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.
public interface	MimeResponse The `MimeResponse` defines the base interface to assist a portlet in returning MIME content.
public interface	Mutable This is a marker interface indicating that the implementing object contains methods for updating portelt state information.
public interface	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.
public interface	MutablePortletParameters The `MutablePortletParameters` provides methods that allow setting parameters to define a potential future render state.
public interface	MutableRenderParameters Provides methods that allow setting parameters to define a potential future render state.
public interface	MutableRenderState Provides read-write access to the render state.
public interface	MutableResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
public interface	PortalContext The `PortalContext` interface gives the portlet the ability to retrieve information about the portal calling this portlet.
public interface	Portlet The `Portlet` interface is used by the portlet container to invoke the portlets.
public interface	PortletAsyncContext Class representing the execution context for an asynchronous operation that was initiated on a ResourceRequest.
public interface	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.
public interface	PortletConfig The `PortletConfig` interface provides the portlet with its configuration.
public interface	PortletContext The `PortletContext` interface defines a portlet view of the portlet container.
public interface	PortletParameters The `PortletParameters` interface defines the API for accessing the parameters that are set for the portlet or on a portlet URL.
public interface	PortletPreferences The `PortletPreferences` interface allows the portlet to store configuration data.
public interface	PortletRequest The `PortletRequest` defines the base interface to provide client request information to a portlet.
public interface	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.
public interface	PortletResponse The `PortletResponse` defines the base interface to assist a portlet in creating and sending a response to the client.
public interface	PortletSession The `PortletSession` interface provides a way to identify a user across more than one request and to store transient information about that user.
public interface	PortletURL The `PortletURL` interface represents a URL that reference the portlet itself.
public interface	PortletURLGenerationListener<T extends PortletURL & RenderURL, U extends PortletURL & ActionURL> Portlet applications can register portlet URL listeners in order to filter URLs before they get generated.
public interface	PreferencesValidator The `PreferencesValidator` allows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.
public interface	RenderParameters Provides access to render parameters, which make up part of the render state.
public interface	RenderRequest The `RenderRequest` represents the request sent to the portlet to handle a render.
public interface	RenderResponse The `RenderResponse` defines an object to assist a portlet in sending a response to the portal.
public interface	RenderState Provides read-only access to the render state.
public interface	RenderURL This is a marker interface for a render URL.
public interface	ResourceParameters Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
public interface	ResourceRequest The `ResourceRequest` interface represents the request send to the portlet for rendering resources.
public interface	ResourceResponse The `ResourceResponse` defines an object to assist a portlet for rendering a resource.
public interface	ResourceServingPortlet The `ResourceServingPortlet` interface allows serving resources through the portlet.
public interface	ResourceURL The `ResourceURL` defines a resource URL that when clicked will result in a `serveResource` call of the `ResourceServingPortlet` interface.
public interface	StateAwareResponse The `StateAwareResponse` represents a response that can modify render state information or send events.

Modifier and Type	Annotation and Description
public @interface	ProcessAction Annotation for marking a method for processing a specific action.
public @interface	ProcessEvent Annotation for marking a method for handling a specific event.
public @interface	RenderMode Annotation for marking a method for handling a specific portlet mode in the render phase.

Class Summary

Modifier and Type	Class and Description
public abstract class	GenericPortlet The `GenericPortlet` class provides a default implementation for the `Portlet` interface.
public class	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.
public class	PortletException The `PortletException` class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.
public class	PortletMode The `PortletMode` class represents the possible modes that a portlet can assume.
public class	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.
public class	PortletSecurityException A portlet should throw a `PortletSecurityException` when a call fails because of security reasons.
public class	PortletSessionUtil The `PortletSessionUtil` class helps identify and decode attributes in the `PORTLET_SCOPE` scope of the PortletSession when accessed through the HttpSession an from within calls to methods of the HttpSessionBindingListener interface.
public class	ReadOnlyException The `ReadOnlyException` is thrown when a portlet tries to change the value for a read-only preference attribute.
public class	UnavailableException The portlet should throw the `UnavailableException` when the portlet is either temporarily or permanently unavailable to handle requests.
public class	ValidatorException The `ValidatorException` is thrown by the `validate` method of a PreferencesValidator when the validation of a preference failed.
public class	WindowState The `WindowState` class represents the possible window states that a portlet window can assume.
public class	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.

Package javax.portlet

Interface Summary

Annotation Summary

Class Summary