All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| ActionFilter |
The ActionFilter 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.
|
| ActionMethod |
Designates a method corresponding to the portlet API processAction method.
|
| 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.
|
| ActionParametersWrapper |
The ActionParametersWrapper provides a convenient
implementation of the ActionParameters interface
that can be subclassed by developers.
|
| 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.
|
| ActionRequestWrapper |
The
ActionRequestWrapper provides a convenient
implementation of the ActionRequest interface
that can be subclassed by developers.
|
| ActionResponse |
The
ActionResponse interface represents the portlet
response to an action request.
|
| ActionResponseWrapper |
The
ActionResponseWrapper provides a convenient
implementation of the ActionResponse interface
that can be subclassed by developers.
|
| ActionURL |
|
| ActionURLWrapper |
The ActionURLWrapper provides a convenient
implementation of the ActionURL interface
that can be subclassed by developers.
|
| BaseURL |
The
BaseURL defines the basic capabilities of a portlet URL
pointing back to the portlet.
|
| BaseURLWrapper |
The BaseURLWrapper provides a convenient
implementation of the BaseURL interface
that can be subclassed by developers.
|
| 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.
|
| ClientDataRequestWrapper |
The ClientDataRequestWrapper
provides a convenient implementation of the ClientDataRequest
interface that can be subclassed by developers.
|
| ContextPath |
Qualifier that specifies the context root for injection.
|
| CustomPortletMode |
This annotation is used within composite portlet configuration annotations to
represent a custom portlet mode.
|
| CustomWindowState |
This annotation is used within composite portlet configuration annotations to
represent a custom window state.
|
| Dependency |
This annotation is used within composite portlet configuration annotations to
represent dependencies the portlet may have on external resources.
|
| DestroyMethod |
Designates a method corresponding to the portlet API destroy method.
|
| Event |
The Event interface represents an event that the portlet has received
in the event processing phase.
|
| EventDefinition |
This annotation is used within composite portlet configuration annotations to
represent a single event.
|
| EventFilter |
The EventFilter 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.
|
| EventMethod |
Designates a method corresponding to the portlet API processEvent method.
|
| EventPortlet |
The EventPortlet interface allows
portlets receiving events.
|
| EventRequest |
The EventRequest represents the request sent to the portlet
to handle an event.
|
| EventRequestWrapper |
The
EventRequestWrapper provides a convenient
implementation of the EventRequest interface
that can be subclassed by developers.
|
| EventResponse |
The
EventResponse interface represents the portlet
response to an event request.
|
| EventResponseWrapper |
The
EventResponseWrapper provides a convenient
implementation of the EventResponse interface
that can be subclassed by developers.
|
| FilterChain |
A FilterChain 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 |
The
GenericPortlet class provides a default implementation for
the Portlet interface.
|
| HeaderFilter |
The HeaderFilter is an object that performs filtering
tasks on either the header request to a portlet, or on the header response from
a portlet, or both.
|
| HeaderFilterChain |
A HeaderFilterChain object is provided by the portlet container
to give a view into the invocation chain of a
filtered header request for a portlet.
|
| HeaderMethod |
Designates a method corresponding to the renderHeaders method of
the HeaderPortlet 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.
|
| HeaderRequest |
Tag interface designating a header request object.
|
| HeaderRequestWrapper |
The HeaderRequestWrapper provides a convenient
implementation of the HeaderRequest interface
that can be subclassed by developers.
|
| 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.
|
| HeaderResponseWrapper |
The HeaderResponseWrapper
provides a convenient implementation of the HeaderResponse
interface that can be subclassed by developers.
|
| InitMethod |
Designates a method corresponding to the portlet API init method.
|
| InitParameter |
This annotation is used within composite portlet configuration annotations to
represent name-value pairs.
|
| LocaleString |
This annotation represents locale-specific strings used within composite portlet configuration annotations to
represent information describing the portlet.
|
| MimeResponse |
The
MimeResponse defines the base interface to assist a
portlet in returning MIME content.
|
| MimeResponse.Copy |
Specifies processing when a URL is created.
|
| MimeResponseWrapper |
The MimeResponseWrapper provides
a convenient implementation of the MimeResponse interface that
can be subclassed by developers.
|
| Multipart |
This annotation is used within composite portlet configuration annotations to
add multipart configuration information.
|
| 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.
|
| MutableActionParametersWrapper |
The MutableActionParametersWrapper provides a convenient
implementation of the MutableActionParameters interface
that can be subclassed by developers.
|
| MutablePortletParameters |
The MutablePortletParameters provides methods that allow
setting parameters to define a potential future render state.
|
| MutablePortletParametersWrapper |
The MutablePortletParametersWrapper provides a convenient
implementation of the MutablePortletParameters interface
that can be subclassed by developers.
|
| MutableRenderParameters |
Provides methods that allow
setting parameters to define a potential future render state.
|
| MutableRenderParametersWrapper |
The MutableRenderParametersWrapper provides a convenient
implementation of the MutableRenderParameters interface
that can be subclassed by developers.
|
| MutableRenderState |
Provides read-write access to the render state.
|
| MutableRenderStateWrapper |
The MutableRenderStateWrapper provides a convenient
implementation of the MutableRenderState interface
that can be subclassed by developers.
|
| MutableResourceParameters |
Resource parameters are additional portlet parameters added to the
URL that extend the state information provided by
the render parameters.
|
| MutableResourceParametersWrapper |
The MutableResourceParametersWrapper provides a convenient
implementation of the MutableResourceParameters interface
that can be subclassed by developers.
|
| Namespace |
Qualifier that specifies the namespace for injection.
|
| PortalContext |
The PortalContext interface gives the portlet
the ability to retrieve information about the portal calling this portlet.
|
| PortalContextWrapper |
The PortalContextWrapper provides a convenient
implementation of the PortalContext interface
that can be subclassed by developers.
|
| Portlet |
The Portlet interface is used by the portlet container to
invoke the portlets.
|
| PortletApplication |
Annotation for the portlet application configuration.
|
| PortletAsyncContext |
Class representing the execution context for an asynchronous operation that was
initiated on a ResourceRequest.
|
| PortletAsyncContextWrapper |
The PortletAsyncContextWrapper provides a convenient
implementation of the PortletAsyncContext interface
that can be subclassed by developers.
|
| 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.
|
| PortletConfiguration |
Annotation for the portlet configuration.
|
| PortletConfigurations |
Annotation for configuration of multiple portlets.
|
| PortletConfigWrapper |
The PortletConfigWrapper provides a convenient
implementation of the PortletConfig interface
that can be subclassed by developers.
|
| PortletContext |
The
PortletContext interface defines a portlet view
of the portlet container.
|
| PortletContextWrapper |
The PortletContextWrapper provides a convenient
implementation of the PortletContext interface
that can be subclassed by developers.
|
| PortletException |
The PortletException class defines a general exception
that a portlet can throw when it is unable to perform its operation
successfully.
|
| PortletFilter |
The PortletFilter is the base interface for all portlet filters.
|
| PortletLifecycleFilter |
Designates a portlet request filter class.
|
| PortletListener |
Designates a portlet URL generation listener class.
|
| 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.
|
| PortletName |
Qualifier that specifies the portlet name for injection.
|
| PortletParameters |
The PortletParameters interface defines the API
for accessing the parameters that are set for the portlet or on a portlet URL.
|
| PortletParametersWrapper |
The PortletParametersWrapper provides a convenient
implementation of the PortletParameters interface
that can be subclassed by developers.
|
| PortletPreferences |
The
PortletPreferences interface allows the portlet to store
configuration data.
|
| PortletPreferencesValidator |
Designates a preferences validator class.
|
| PortletQName |
This annotation is used within composite portlet configuration annotations to
represent a QName for use in portlet event and public render parameter definitions.
|
| 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.
|
| PortletRequestDispatcherWrapper |
The PortletRequestDispatcherWrapper provides a convenient
implementation of the PortletRequestDispatcher interface
that can be subclassed by developers.
|
| PortletRequestScoped |
Provides a CDI custom scope for the portlet request.
|
| PortletRequestWrapper |
The
PortletRequestWrapper provides a convenient
implementation of the PortletRequest interface
and is extended by other request wrappers.
|
| PortletResponse |
The
PortletResponse defines the base interface to assist a
portlet in creating and sending a response to the client.
|
| PortletResponseWrapper |
The PortletResponseWrapper provides a convenient
implementation of the PortletResponse interface and is extended by other response wrappers.
|
| 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.
|
| PortletSerializable |
This interface must be implemented by RenderStateScoped beans
in order to allow the bean portlet container to intialize the bean at the
beginning of a request and passivate the bean at the end of the request. |
| PortletSession |
The
PortletSession interface provides a way to identify a user
across more than one request and to store transient information about that user.
|
| PortletSessionScoped |
Provides a CDI custom scope that is scoped to the portlet session rather than to the
servlet session.
|
| 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.
|
| PortletSessionWrapper |
The PortletSessionWrapper provides a convenient
implementation of the PortletSession interface
that can be subclassed by developers.
|
| PortletURL |
The
PortletURL interface represents a URL
that reference the portlet itself.
|
| 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.
|
| PortletURLWrapper |
The PortletURLWrapper provides a convenient
implementation of the PortletURL interface
that can be subclassed by developers.
|
| Preference |
This annotation is used within composite portlet configuration annotations to
represent a single portlet preference.
|
| PreferencesValidator |
The PreferencesValidator 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.
|
| PublicRenderParameterDefinition |
This annotation is used within composite portlet configuration annotations to
represent a single public render parameter.
|
| ReadOnlyException |
The ReadOnlyException is thrown when a portlet tries
to change the value for a read-only preference attribute.
|
| RenderFilter |
The RenderFilter 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.
|
| RenderMethod |
Designates a method corresponding to the portlet API render method.
|
| RenderMode |
Annotation for marking a method for handling
a specific portlet mode in the render phase.
|
| RenderParameters |
Provides access to render parameters, which make up part of the render state.
|
| RenderParametersWrapper |
The RenderParametersWrapper provides a convenient
implementation of the RenderParameters interface
that can be subclassed by developers.
|
| RenderRequest |
The RenderRequest represents the request sent to the portlet
to handle a render.
|
| RenderRequestWrapper |
The
RenderRequestWrapper provides a convenient
implementation of the RenderRequest interface
that can be subclassed by developers.
|
| RenderResponse |
The
RenderResponse defines an object to assist a portlet in
sending a response to the portal.
|
| RenderResponseWrapper |
The RenderResponseWrapper provides a convenient
implementation of the RenderResponse interface
that can be subclassed by developers.
|
| RenderState |
Provides read-only access to the render state.
|
| RenderStateScoped |
Provides a CDI custom scope that is scoped to the render state.
|
| RenderStateWrapper |
The RenderStateWrapper provides a convenient
implementation of the RenderState interface
that can be subclassed by developers.
|
| RenderURL |
This is a marker interface for a render URL.
|
| RenderURLWrapper |
The RenderURLWrapper provides a convenient
implementation of the RenderURL interface
that can be subclassed by developers.
|
| ResourceFilter |
The
ResourceFilter 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.
|
| ResourceParameters |
Resource parameters are additional portlet parameters added to the
URL that extend the state information provided by
the render parameters.
|
| ResourceParametersWrapper |
The ResourceParametersWrapper provides a convenient
implementation of the ResourceParameters interface
that can be subclassed by developers.
|
| ResourceRequest |
The
ResourceRequest interface represents the request
send to the portlet for rendering resources.
|
| ResourceRequestWrapper |
The
ResourceRequestWrapper provides a convenient
implementation of the ResourceRequest interface
that can be subclassed by developers.
|
| ResourceResponse |
The
ResourceResponse defines an object to assist a portlet
for rendering a resource.
|
| ResourceResponseWrapper |
The
ResourceResponseWrapper provides a convenient
implementation of the ResourceResponse interface
that can be subclassed by developers.
|
| 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.
|
| ResourceURLWrapper |
The ResourceURLWrapper provides a convenient
implementation of the ResourceURL interface
that can be subclassed by developers.
|
| RuntimeOption |
This annotation is used within composite portlet configuration annotations to
represent portlet container runtime option name-value pairs.
|
| SecurityRoleRef |
This annotation is used within composite portlet configuration annotations to
represent a single security role reference.
|
| ServeResourceMethod |
Designates a method corresponding to the portlet API serveResource method.
|
| StateAwareResponse |
The
StateAwareResponse represents a response that can modify
render state information or send events.
|
| StateAwareResponseWrapper |
The StateAwareResponseWrapper provides a convenient
implementation of the StateAwareResponse interface
that can be subclassed by developers.
|
| Supports |
This annotation is used within composite portlet configuration annotations to
specify the supported portlet modes and window states for a given content type.
|
| UnavailableException |
The portlet should throw the UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests.
|
| UserAttribute |
This annotation is used within composite portlet configuration annotations to
represent a single user attribute.
|
| ValidatorException |
The ValidatorException is thrown by the
validate method of a PreferencesValidator when
the validation of a preference failed.
|
| WindowId |
Qualifier that specifies the window ID for injection.
|
| 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.
|