@ProcessAction
annotation.javax.portlet.actionScopedRequestAttributes
container runtime option is used by the portlet.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.ActionParametersWrapper
provides a convenient
implementation of the ActionParameters
interface
that can be subclassed by developers.ActionRequest
represents the request sent to the portlet
to handle an action.ActionRequestWrapper
provides a convenient
implementation of the ActionRequest
interface
that can be subclassed by developers.ActionRequest
adaptor
wrapping the given request object.ActionResponse
interface represents the portlet
response to an action request.ActionResponseWrapper
provides a convenient
implementation of the ActionResponse
interface
that can be subclassed by developers.ActionResponse
adaptor
wrapping the given response object.MimeResponse.createActionURL()
.ActionURLWrapper
provides a convenient
implementation of the ActionURL
interface
that can be subclassed by developers.PortletParameters
object
if they are not already present.PortletAsyncListener
with the most recent
asynchronous cycle that was started by a call to one of the
ResourceRequest.startAsync()
methods.PortletAsyncListener
with the most recent
asynchronous cycle that was started by a call to one of the
ResourceRequest.startAsync()
methods.BaseURL
defines the basic capabilities of a portlet URL
pointing back to the portlet.BaseURLWrapper
provides a convenient
implementation of the BaseURL
interface
that can be subclassed by developers.setProperty
method intended to be used in
forwarded or included servlets/JSPs.CacheControl
interface represents cache settings
for a piece of markup.javax.ccpp.Profile
with the getAttribute
call.MutableRenderParameters
object.MutableRenderParameters
object.ClientDataRequest
represents the request information
of the HTTP request issued from the client to the portal.ClientDataRequestWrapper
provides a convenient implementation of the ClientDataRequest
interface that can be subclassed by developers.MutableActionParameters
object encapsulating a copy of the same
parameters as the original object.MutablePortletParameters
object encapsulating a copy of the same
parameters as the original object.MutableRenderParameters
object encapsulating a copy of the same
parameters as the original object.MutableResourceParameters
object encapsulating a copy of the same
parameters as the original object.PortletAsynchronous
operation
and closes the response associated with this PortletAsyncContext
object.PortletResponse.addProperty(String,Element)
method.PortletAsyncListener
class.PORTLET_SCOPE
.PortletAsyncContext
to
the portlet container.PortletAsyncContext
to
the given path within the PortletContext
.@RenderMode
and the name of the portlet mode
a set of helper methods depending on the current portlet mode the portlet
is currently in.edit
mode.doFilter
method of the Filter is called by the
portlet container each time a action request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.doFilter
method of the Filter is called by the
portlet container each time a event request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.doFilter
method of the Filter is called by the
portlet container each time a header request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.doFilter
method of the Filter is called by the
portlet container each time a render request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.doFilter
method of the Filter is called by the
portlet container each time a resource request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.help
mode.view
mode.EDIT
portlet mode, a portlet should provide content and logic that lets a user customize
the behavior of the portlet.Event
interface represents an event that the portlet has received
in the event processing phase.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.EventPortlet
interface allows
portlets receiving events.EventRequest
represents the request sent to the portlet
to handle an event.EventRequestWrapper
provides a convenient
implementation of the EventRequest
interface
that can be subclassed by developers.EventRequest
adaptor
wrapping the given request object.EventResponse
interface represents the portlet
response to an event request.EventResponseWrapper
provides a convenient
implementation of the EventResponse
interface
that can be subclassed by developers.EventResponse
adaptor
wrapping the given response object.setProperty
method intended to be used in
forwarded or included servlets/JSPs.toString
or write
are executed on action URLs.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.toString
or write
are executed on render URLs.toString
or write
are executed on resource URLs.FULL
does not need to contain the current
state of the page or the current render parameters, portlet mode, or
window state of the portlet.GenericPortlet
class provides a default implementation for
the Portlet
interface.Object
,
or null
if no attribute of the given name exists.PORTLET_SCOPE
, or null
if no
object is bound under the name in that scope.null
if no object is bound under the name in the given scope.Map
of the session attributes in
the portlet session scope.Map
of the session attributes in
the given session scope.Enumeration
containing the attribute names
available within this portlet context, or an empty
Enumeration
if no attributes are available.Enumeration
containing the
names of the attributes available to this request.Enumeration
of String objects containing the names of
all the objects bound to this session under the PORTLET_SCOPE
, or an
empty Enumeration
if no attributes are available.Enumeration
of String objects containing the names of
all the objects bound to this session in the given scope, or an
empty Enumeration
if no attributes are available in the
given scope.BASIC_AUTH
, CLIENT_CERT_AUTH
,
a custom one or null
if there was no authentication.null
if no ETag is set on the response.null
if no cached response exists.null
if no cached response exists.null
if the parameter does not exist.null
if the parameter does not exist.Enumeration
of String objects, or an empty Enumeration
if the
portlet has no initialization parameters.Enumeration
of String objects, or an empty Enumeration if the context
has no initialization parameters.Map
of the preferences.null
if
the MIME type is not known.PortletRequestDispatcher
object that acts
as a wrapper for the named servlet.Set
of String
objects containing the names of the parameters contained
in this object.Set
of String
objects containing the names of the parameters contained
in this object.Enumeration
if no keys are
available.RenderState.getRenderParameters()
instead.RenderState.getRenderParameters()
,
ResourceURL.getResourceParameters()
,
or ActionURL.getActionParameters()
as required.RenderState.getRenderParameters()
instead.RenderState.getRenderParameters()
instead.RenderState.getRenderParameters()
instead.AsyncContext
that was created or reinitialized by the most
recent invocation of startAsync()
or
startAsync(ResourceRequest,ResourceResponse)
on this request.PortletContext
in which the caller is executing.PortletContext
of the portlet application the
portlet is in.PortletContext
of the portlet application
the portlet is in.PortletContext
of the portlet application
the portlet is in.web.xml
deployment descriptor for this web application by the
display-name
element.InputStream
.Enumeration
of PortletMode objects that are defined
for the portlet for the given MIME type.Enumeration
of PortletMode objects that are defined
for the portlet for the given MIME type.HeaderResponse
output stream is added
to the aggregated portal document HEAD
section.OutputStream
suitable for writing binary data in
the response.true
, creates one and returns
the new session.RenderState.getRenderParameters()
instead.RenderState.getRenderParameters()
instead.Enumeration
of QName
objects,
or an empty Enumeration
if the
portlet has not defined any processing events.Enumeration
of String
objects.null
if there is
no property by that name.String
.Enumeration
if there are no property names.Enumeration
of all the property names
this request contains.RenderState.getRenderParameters()
instead.Enumeration
of String objects, or an empty
Enumeration
if the portlet has no public render
parameters.Enumeration
of String
objects,
or an empty Enumeration
if the
portlet has not defined public render parameters.Enumeration
of QName
objects,
or an empty Enumeration
if the
portlet has not defined any publishing events.BufferedReader
.String
containing the real path
for a given virtual path.MutableRenderState.getRenderParameters()
instead.PortletRequestDispatcher
object that acts
as a wrapper for the resource located at the given path.resource-bundle
tag or the inlined resources defined in
the deployment descriptor.resource-bundle
tag or the inlined resources
defined in the deployment descriptor.null
if no resource ID was set on the URL.null
if no resource ID was set on the URL.PortletAsyncContext
by calling
ResourceRequest.startAsync()
or ResourceRequest.startAsync(ServletRequest, ServletResponse)
.PortletAsyncContext
by calling
ResourceRequest.startAsync()
or ResourceRequest.startAsync(ServletRequest, ServletResponse)
.PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse)
method.PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse)
method.Enumeration
of Locale
objects,
or an empty Enumeration
if the
portlet has not defined any supported locales.PortletMode
objects.WindowState
objects.Throwable
associated with the event.String
.String
objects containing
all of the values the given parameter, or
null
if the parameter does not exist.Enumeration
of WindowState objects that are defined
for the portlet for the given MIME type.Enumeration
of WindowState objects that are defined
for the portlet for the given MIME type.HeaderResponse
writer is added
to the aggregated portal document HEAD
section.PortletAsyncContext
was initialized with the original or
application-wrapped request and response objects.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
object is provided by the portlet container
to give a view into the invocation chain of a
filtered header request for a portlet.HeaderPortlet
interface.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.HeaderRequestWrapper
provides a convenient
implementation of the HeaderRequest
interface
that can be subclassed by developers.HeaderRequest
adaptor
wrapping the given request object.HEAD
section to be written and HTTP headers to be
set before the render markup for each individual portlet is aggregated.HeaderResponseWrapper
provides a convenient implementation of the HeaderResponse
interface that can be subclassed by developers.HELP
portlet mode, a portlet should provide help information about the portlet.setProperty
method.super.init(config)
.true
if no parameters have been set.boolean
indicating
whether the portlet is permanently unavailable.MimeResponse
property MARKUP_HEAD_ELEMENT
.MAXIMIZED
window state is an indication that a portlet may be the only portlet being rendered in
the portal page, or that the portlet has more space compared to other portlets in the portal page.MimeResponse
defines the base interface to assist a
portlet in returning MIME content.MimeResponseWrapper
provides
a convenient implementation of the MimeResponse
interface that
can be subclassed by developers.MINIMIZED
window state, the portlet should only render minimal output or no
output at all.MutableActionParametersWrapper
provides a convenient
implementation of the MutableActionParameters
interface
that can be subclassed by developers.