All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description ActionFilter TheActionFilter
is 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 TheActionRequest
represents the request sent to the portlet to handle an action.
It extends the ClientDataRequest interface and provides action request information to portlets.ActionRequestWrapper TheActionRequestWrapper
provides a convenient implementation of theActionRequest
interface that can be subclassed by developers wishing to adapt the request.ActionResponse TheActionResponse
interface represents the portlet response to an action request.ActionResponseWrapper TheActionResponseWrapper
provides a convenient implementation of theActionResponse
interface that can be subclassed by developers wishing to adapt the response.BaseURL TheBaseURL
defines the basic capabilities of a portlet URL pointing back to the portlet.CacheControl TheCacheControl
interface represents cache settings for a piece of markup.ClientDataRequest TheClientDataRequest
represents the request information of the HTTP request issued from the client to the portal.
It extends the PortletRequest interface.Event TheEvent
interface represents an event that the portlet has received in the event processing phase.EventFilter TheEventFilter
is 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 TheEventPortlet
interface allows portlets receiving events.EventRequest TheEventRequest
represents the request sent to the portlet to handle an event.EventRequestWrapper TheEventRequestWrapper
provides a convenient implementation of theEventRequest
interface that can be subclassed by developers wishing to adapt the request.EventResponse TheEventResponse
interface represents the portlet response to an event request.EventResponseWrapper TheEventResponseWrapper
provides a convenient implementation of theEventResponse
interface that can be subclassed by developers wishing to adapt the response.FilterChain AFilterChain
is 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 TheGenericPortlet
class provides a default implementation for thePortlet
interface.MimeResponse TheMimeResponse
defines the base interface to assist a portlet in returning MIME content.PortalContext ThePortalContext
interface gives the portlet the ability to retrieve information about the portal calling this portlet.Portlet ThePortlet
interface is used by the portlet container to invoke the portlets.PortletConfig ThePortletConfig
interface provides the portlet with its configuration.PortletContext ThePortletContext
interface defines a portlet view of the portlet container.PortletException ThePortletException
class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.PortletFilter ThePortletFilter
is the base interface for all portlet filters.PortletMode ThePortletMode
class represents the possible modes that a portlet can assume.PortletModeException ThePortletModeException
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.PortletPreferences ThePortletPreferences
interface allows the portlet to store configuration data.PortletRequest ThePortletRequest
defines the base interface to provide client request information to a portlet.PortletRequest.P3PUserInfos P3P user information constants.PortletRequestDispatcher ThePortletRequestDispatcher
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.PortletRequestWrapper ThePortletRequestWrapper
provides a convenient implementation of thePortletRequest
interface and is extended by other request wrappers.PortletResponse ThePortletResponse
defines the base interface to assist a portlet in creating and sending a response to the client.PortletResponseWrapper ThePortletResponseWrapper
provides a convenient implementation of thePortletResponse
interface and is extended by other response wrappers.PortletSecurityException A portlet should throw aPortletSecurityException
when a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.PortletSession ThePortletSession
interface provides a way to identify a user across more than one request and to store transient information about that user.PortletSessionUtil ThePortletSessionUtil
class helps identify and decode attributes in thePORTLET_SCOPE
scope of the PortletSession when accessed through the HttpSession an from within calls to methods of the HttpSessionBindingListener interface.PortletURL ThePortletURL
interface 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 ThePreferencesValidator
allows 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 TheReadOnlyException
is thrown when a portlet tries to change the value for a read-only preference attribute.RenderFilter TheRenderFilter
is 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 TheRenderRequest
represents the request sent to the portlet to handle a render.RenderRequestWrapper TheRenderRequestWrapper
provides a convenient implementation of theRenderRequest
interface that can be subclassed by developers wishing to adapt the request.RenderResponse TheRenderResponse
defines an object to assist a portlet in sending a response to the portal.RenderResponseWrapper TheRenderResponseWrapper
provides a convenient implementation of theRenderResponse
interface that can be subclassed by developers wishing to adapt the response.ResourceFilter TheResourceFilter
is 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 TheResourceRequest
interface represents the request send to the portlet for rendering resources.ResourceRequestWrapper TheResourceRequestWrapper
provides a convenient implementation of theResourceRequest
interface that can be subclassed by developers wishing to adapt the request.ResourceResponse TheResourceResponse
defines an object to assist a portlet for rendering a resource.ResourceResponseWrapper TheResourceResponseWrapper
provides a convenient implementation of theResourceResponse
interface that can be subclassed by developers wishing to adapt the response.ResourceServingPortlet TheResourceServingPortlet
interface allows serving resources through the portlet.ResourceURL TheResourceURL
defines a resource URL that when clicked will result in aserveResource
call of theResourceServingPortlet
interface.StateAwareResponse TheStateAwareResponse
represents a response that can modify state information or send events.
It extends the PortletResponse interface.UnavailableException The portlet should throw theUnavailableException
when the portlet is either temporarily or permanently unavailable to handle requests.ValidatorException TheValidatorException
is thrown by thevalidate
method of a PreferencesValidator when the validation of a preference failed.WindowState TheWindowState
class represents the possible window states that a portlet window can assume.WindowStateException TheWindowStateException
is thrown when a portlet tries to use a window state that is not supported by the current runtime environment or the portlet.