A B C D E F G H I J L M N O P R S T U V W 

A

ACTION_NAME - Static variable in interface javax.portlet.ActionRequest
Predefined action name for usage with the @ProcessAction annotation.
ACTION_PHASE - Static variable in interface javax.portlet.PortletRequest
String identifier for the portlet action lifecycle phase.
ACTION_SCOPE_ID - Static variable in interface javax.portlet.PortletRequest
The action scope ID that the portlet container uses for storing the current action scope as render parameter if the javax.portlet.actionScopedRequestAttributes container runtime option is used by the portlet.
ActionFilter - Interface in javax.portlet.filter
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 - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API processAction method.
ActionParameters - Interface in javax.portlet
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 - Class in javax.portlet.filter
The ActionParametersWrapper provides a convenient implementation of the ActionParameters interface that can be subclassed by developers.
ActionParametersWrapper(ActionParameters) - Constructor for class javax.portlet.filter.ActionParametersWrapper
 
ActionRequest - Interface in javax.portlet
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 - Class in javax.portlet.filter
The ActionRequestWrapper provides a convenient implementation of the ActionRequest interface that can be subclassed by developers.
ActionRequestWrapper(ActionRequest) - Constructor for class javax.portlet.filter.ActionRequestWrapper
Creates an ActionRequest adaptor wrapping the given request object.
ActionResponse - Interface in javax.portlet
The ActionResponse interface represents the portlet response to an action request.
ActionResponseWrapper - Class in javax.portlet.filter
The ActionResponseWrapper provides a convenient implementation of the ActionResponse interface that can be subclassed by developers.
ActionResponseWrapper(ActionResponse) - Constructor for class javax.portlet.filter.ActionResponseWrapper
Creates an ActionResponse adaptor wrapping the given response object.
ActionURL - Interface in javax.portlet
An action URL is created with MimeResponse.createActionURL().
ActionURLWrapper - Class in javax.portlet.filter
The ActionURLWrapper provides a convenient implementation of the ActionURL interface that can be subclassed by developers.
ActionURLWrapper(ActionURL) - Constructor for class javax.portlet.filter.ActionURLWrapper
 
add(PortletParameters) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
add(PortletParameters) - Method in interface javax.portlet.MutablePortletParameters
Adds the parameters from the input PortletParameters object if they are not already present.
addDependency(String, String, String) - Method in class javax.portlet.filter.HeaderResponseWrapper
 
addDependency(String, String, String, String) - Method in class javax.portlet.filter.HeaderResponseWrapper
 
addDependency(String, String, String) - Method in interface javax.portlet.HeaderResponse
Adds a dependency on a page-level resource that is managed by the portal.
addDependency(String, String, String, String) - Method in interface javax.portlet.HeaderResponse
Adds a dependency on a page-level resource that is managed by the portal and adds a resource for addition to the page for the dependency.
addListener(PortletAsyncListener) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
addListener(PortletAsyncListener) - Method in interface javax.portlet.PortletAsyncContext
Registers the given PortletAsyncListener with the most recent asynchronous cycle that was started by a call to one of the ResourceRequest.startAsync() methods.
addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) - Method in interface javax.portlet.PortletAsyncContext
Registers the given PortletAsyncListener with the most recent asynchronous cycle that was started by a call to one of the ResourceRequest.startAsync() methods.
addProperty(String, String) - Method in interface javax.portlet.BaseURL
Adds a String property to an existing key on the URL.
addProperty(String, String) - Method in class javax.portlet.filter.BaseURLWrapper
 
addProperty(String, String) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call addProperty(key, value) on the wrapped response object.
addProperty(String, Element) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call addProperty() on the wrapped response object.
addProperty(Cookie) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call addProperty() on the wrapped response object.
addProperty(String, String) - Method in interface javax.portlet.PortletResponse
Adds a String property to an existing key to be returned to the portal.
addProperty(Cookie) - Method in interface javax.portlet.PortletResponse
Adds a HTTP Cookie property to the response.
The portlet should note that the cookie may not make it to the client, but may be stored at the portal.
addProperty(String, Element) - Method in interface javax.portlet.PortletResponse
Adds an XML DOM element property to the response.
append(Appendable) - Method in interface javax.portlet.BaseURL
Appends the portlet URL to the appendable object.
append(Appendable, boolean) - Method in interface javax.portlet.BaseURL
Appends the portlet URL to the appendable object.
append(Appendable) - Method in class javax.portlet.filter.BaseURLWrapper
 
append(Appendable, boolean) - Method in class javax.portlet.filter.BaseURLWrapper
 
APPLICATION_SCOPE - Static variable in interface javax.portlet.PortletSession
This constant defines an application wide scope for the session attribute.

B

BaseURL - Interface in javax.portlet
The BaseURL defines the basic capabilities of a portlet URL pointing back to the portlet.
BaseURLWrapper - Class in javax.portlet.filter
The BaseURLWrapper provides a convenient implementation of the BaseURL interface that can be subclassed by developers.
BaseURLWrapper(BaseURL) - Constructor for class javax.portlet.filter.BaseURLWrapper
 
BASIC_AUTH - Static variable in interface javax.portlet.PortletRequest
String identifier for Basic authentication.

C

CACHE_SCOPE - Static variable in interface javax.portlet.MimeResponse
Property to set the cache scope for this response using the setProperty method intended to be used in forwarded or included servlets/JSPs.
CacheControl - Interface in javax.portlet
The CacheControl interface represents cache settings for a piece of markup.
CCPP_PROFILE - Static variable in interface javax.portlet.PortletRequest
Used to retrieve an instance of the javax.ccpp.Profile with the getAttribute call.
clear() - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
clear() - Method in interface javax.portlet.MutablePortletParameters
Clears all parameters.
clearPrivate() - Method in class javax.portlet.filter.MutableRenderParametersWrapper
 
clearPrivate() - Method in interface javax.portlet.MutableRenderParameters
Clears all private parameters that are present in the MutableRenderParameters object.
clearPublic() - Method in class javax.portlet.filter.MutableRenderParametersWrapper
 
clearPublic() - Method in interface javax.portlet.MutableRenderParameters
Clears all public parameters that are present in the MutableRenderParameters object.
CLIENT_CERT_AUTH - Static variable in interface javax.portlet.PortletRequest
String identifier for Certification based authentication.
ClientDataRequest - Interface in javax.portlet
The ClientDataRequest represents the request information of the HTTP request issued from the client to the portal.
It extends the PortletRequest interface.
ClientDataRequestWrapper - Class in javax.portlet.filter
The ClientDataRequestWrapper provides a convenient implementation of the ClientDataRequest interface that can be subclassed by developers.
ClientDataRequestWrapper(ClientDataRequest) - Constructor for class javax.portlet.filter.ClientDataRequestWrapper
 
clone() - Method in interface javax.portlet.ActionParameters
Returns a MutableActionParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in class javax.portlet.filter.ActionParametersWrapper
 
clone() - Method in class javax.portlet.filter.MutableActionParametersWrapper
 
clone() - Method in class javax.portlet.filter.MutableRenderParametersWrapper
 
clone() - Method in class javax.portlet.filter.MutableResourceParametersWrapper
 
clone() - Method in class javax.portlet.filter.PortletParametersWrapper
 
clone() - Method in class javax.portlet.filter.RenderParametersWrapper
 
clone() - Method in class javax.portlet.filter.ResourceParametersWrapper
 
clone() - Method in interface javax.portlet.PortletParameters
Returns a MutablePortletParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in interface javax.portlet.RenderParameters
Returns a MutableRenderParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in interface javax.portlet.ResourceParameters
Returns a MutableResourceParameters object encapsulating a copy of the same parameters as the original object.
complete() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
complete() - Method in interface javax.portlet.PortletAsyncContext
Completes the PortletAsynchronous operation and closes the response associated with this PortletAsyncContext object.
ContextPath - Annotation Type in javax.portlet.annotations
Qualifier that specifies the context root for injection.
createActionURL() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call createActionURL() on the wrapped response object.
createActionURL(MimeResponse.Copy) - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call createActionURL(ParameterCopyOption) on the wrapped response object.
createActionURL() - Method in interface javax.portlet.MimeResponse
Creates an action URL targeting the portlet.
createActionURL(MimeResponse.Copy) - Method in interface javax.portlet.MimeResponse
Creates an action URL targeting the portlet.
createActionURL() - Method in interface javax.portlet.ResourceResponse
 
createActionURL(MimeResponse.Copy) - Method in interface javax.portlet.ResourceResponse
 
createElement(String) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call createElement() on the wrapped response object.
createElement(String) - Method in interface javax.portlet.PortletResponse
Creates an element of the type specified to be used in the PortletResponse.addProperty(String,Element) method.
createPortletAsyncListener(Class<T>) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
createPortletAsyncListener(Class<T>) - Method in interface javax.portlet.PortletAsyncContext
Instantiates the given PortletAsyncListener class.
createRedirectURL(MimeResponse.Copy) - Method in interface javax.portlet.ActionResponse
Returns a render URL containing render parameters according to the MimeResponse.Copy argument.
createRedirectURL(MimeResponse.Copy) - Method in class javax.portlet.filter.ActionResponseWrapper
call wrapped object.
createRenderURL() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call createRenderURL() on the wrapped response object.
createRenderURL(MimeResponse.Copy) - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call createRenderURL(ParameterCopyOption) on the wrapped response object.
createRenderURL() - Method in interface javax.portlet.MimeResponse
Creates a render URL targeting the portlet.
createRenderURL(MimeResponse.Copy) - Method in interface javax.portlet.MimeResponse
Creates a render URL targeting the portlet.
createRenderURL() - Method in interface javax.portlet.ResourceResponse
 
createRenderURL(MimeResponse.Copy) - Method in interface javax.portlet.ResourceResponse
 
createResourceURL() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call createResourceURL() on the wrapped response object.
createResourceURL() - Method in interface javax.portlet.MimeResponse
Creates a resource URL targeting the portlet.
createResourceURL() - Method in interface javax.portlet.ResourceResponse
 
CustomPortletMode - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a custom portlet mode.
CustomWindowState - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a custom window state.

D

decodeAttributeName(String) - Static method in class javax.portlet.PortletSessionUtil
Returns the attribute name of an attribute in the PORTLET_SCOPE.
decodeScope(String) - Static method in class javax.portlet.PortletSessionUtil
Returns the portlet attribute scope from an encoded portlet attribute.
Dependency - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent dependencies the portlet may have on external resources.
deserialize(String[]) - Method in interface javax.portlet.annotations.PortletSerializable
The bean portlet container calls this method at the beginning of every portlet request method that uses the bean.
destroy() - Method in interface javax.portlet.filter.PortletFilter
Called by the portlet container to indicate to a filter that it is being taken out of service.
destroy() - Method in class javax.portlet.GenericPortlet
Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.
destroy() - Method in interface javax.portlet.Portlet
Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.
DestroyMethod - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API destroy method.
DIGEST_AUTH - Static variable in interface javax.portlet.PortletRequest
String identifier for Digest based authentication.
dispatch() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
dispatch(String) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
dispatch() - Method in interface javax.portlet.PortletAsyncContext
Dispatches the request and response objects of this PortletAsyncContext to the portlet container.
dispatch(String) - Method in interface javax.portlet.PortletAsyncContext
Dispatches the request and response objects of this PortletAsyncContext to the given path within the PortletContext.
dispatchAnnotatedActionMethod(String, ActionRequest, ActionResponse) - Method in class javax.portlet.GenericPortlet
Dispatches an action request to an annotated action method.
dispatchAnnotatedEventMethod(String, EventRequest, EventResponse) - Method in class javax.portlet.GenericPortlet
Dispatches an event request to an annotated event method.
dispatchAnnotatedRenderMethod(String, RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
Dispatches an render request to an annotated render method.
doDispatch(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
The default implementation of this method routes the render request to: method annotated with @RenderMode and the name of the portlet mode a set of helper methods depending on the current portlet mode the portlet is currently in.
doEdit(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
Helper method to serve up the edit mode.
doFilter(ActionRequest, ActionResponse, FilterChain) - Method in interface javax.portlet.filter.ActionFilter
The 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(EventRequest, EventResponse, FilterChain) - Method in interface javax.portlet.filter.EventFilter
The 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(ActionRequest, ActionResponse) - Method in interface javax.portlet.filter.FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
doFilter(EventRequest, EventResponse) - Method in interface javax.portlet.filter.FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
doFilter(RenderRequest, RenderResponse) - Method in interface javax.portlet.filter.FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
doFilter(ResourceRequest, ResourceResponse) - Method in interface javax.portlet.filter.FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
doFilter(HeaderRequest, HeaderResponse, HeaderFilterChain) - Method in interface javax.portlet.filter.HeaderFilter
The 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(HeaderRequest, HeaderResponse) - Method in interface javax.portlet.filter.HeaderFilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
doFilter(RenderRequest, RenderResponse, FilterChain) - Method in interface javax.portlet.filter.RenderFilter
The 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(ResourceRequest, ResourceResponse, FilterChain) - Method in interface javax.portlet.filter.ResourceFilter
The 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.
doHeaders(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
Used by the render method to set the response properties and headers.
doHelp(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
Helper method to serve up the help mode.
doView(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
Helper method to serve up the mandatory view mode.

E

EDIT - Static variable in class javax.portlet.PortletMode
Within the EDIT portlet mode, a portlet should provide content and logic that lets a user customize the behavior of the portlet.
encodeURL(String) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call encodeURL(path) on the wrapped response object.
encodeURL(String) - Method in interface javax.portlet.PortletResponse
Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.
equals(Object) - Method in class javax.portlet.PortletMode
Compares the specified object with this portlet mode for equality.
equals(Object) - Method in class javax.portlet.WindowState
Compares the specified object with this window state for equality.
ETAG - Static variable in interface javax.portlet.MimeResponse
Property to tell the portlet container the new ETag for this response intended to be used in forwarded or included servlets/JSPs.
ETAG - Static variable in interface javax.portlet.RenderRequest
This property is set by the container if the portlet container has a cached response for the given validation tag.
ETAG - Static variable in interface javax.portlet.ResourceRequest
This property is set by the container if the container has a cached response for the given validation tag.
Event - Interface in javax.portlet
The Event interface represents an event that the portlet has received in the event processing phase.
EVENT_PHASE - Static variable in interface javax.portlet.PortletRequest
String identifier for the portlet event lifecycle phase.
EventDefinition - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a single event.
EventFilter - Interface in javax.portlet.filter
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 - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API processEvent method.
EventPortlet - Interface in javax.portlet
The EventPortlet interface allows portlets receiving events.
EventRequest - Interface in javax.portlet
The EventRequest represents the request sent to the portlet to handle an event.
EventRequestWrapper - Class in javax.portlet.filter
The EventRequestWrapper provides a convenient implementation of the EventRequest interface that can be subclassed by developers.
EventRequestWrapper(EventRequest) - Constructor for class javax.portlet.filter.EventRequestWrapper
Creates an EventRequest adaptor wrapping the given request object.
EventResponse - Interface in javax.portlet
The EventResponse interface represents the portlet response to an event request.
EventResponseWrapper - Class in javax.portlet.filter
The EventResponseWrapper provides a convenient implementation of the EventResponse interface that can be subclassed by developers.
EventResponseWrapper(EventResponse) - Constructor for class javax.portlet.filter.EventResponseWrapper
Creates an EventResponse adaptor wrapping the given response object.
EXPIRATION_CACHE - Static variable in interface javax.portlet.MimeResponse
Property to set the expiration time in seconds for this response using the setProperty method intended to be used in forwarded or included servlets/JSPs.

F

filterActionURL(U) - Method in interface javax.portlet.PortletURLGenerationListener
Callback being called by the portlet container before toString or write are executed on action URLs.
FilterChain - Interface in javax.portlet.filter
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 - Interface in javax.portlet.filter
A filter configuration object used by a portlet container to pass information to a filter during initialization.
filterRenderURL(T) - Method in interface javax.portlet.PortletURLGenerationListener
Callback being called by the portlet container before toString or write are executed on render URLs.
filterResourceURL(ResourceURL) - Method in interface javax.portlet.PortletURLGenerationListener
Callback being called by the portlet container before toString or write are executed on resource URLs.
flushBuffer() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call flushBuffer() on the wrapped response object.
flushBuffer() - Method in interface javax.portlet.MimeResponse
Forces any content in the buffer to be written to the underlying output stream.
FORM_AUTH - Static variable in interface javax.portlet.PortletRequest
String identifier for Form based authentication.
forward(PortletRequest, PortletResponse) - Method in class javax.portlet.filter.PortletRequestDispatcherWrapper
 
forward(PortletRequest, PortletResponse) - Method in interface javax.portlet.PortletRequestDispatcher
Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) on the server.
FULL - Static variable in interface javax.portlet.ResourceURL
The URL of type 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.

G

GenericPortlet - Class in javax.portlet
The GenericPortlet class provides a default implementation for the Portlet interface.
GenericPortlet() - Constructor for class javax.portlet.GenericPortlet
Does nothing.
getActionParameters() - Method in interface javax.portlet.ActionRequest
Gets the action parameters set for this request.
getActionParameters() - Method in interface javax.portlet.ActionURL
Gets the action parameter values set for this URL.
getActionParameters() - Method in class javax.portlet.filter.ActionRequestWrapper
The default behavior of this method is to call getActionParameters() on the wrapped request object.
getActionParameters() - Method in class javax.portlet.filter.ActionURLWrapper
 
getAttribute(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getAttribute(String) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
getAttribute(String) - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttribute(String, int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttribute(String) - Method in interface javax.portlet.PortletContext
Returns the portlet container attribute with the given name, or null if there is no attribute by that name.
getAttribute(String) - Method in interface javax.portlet.PortletRequest
Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
getAttribute(String) - Method in interface javax.portlet.PortletSession
Returns the object bound with the specified name in this session under the PORTLET_SCOPE, or null if no object is bound under the name in that scope.
getAttribute(String, int) - Method in interface javax.portlet.PortletSession
Returns the object bound with the specified name in this session, or null if no object is bound under the name in the given scope.
getAttributeMap() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttributeMap(int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttributeMap() - Method in interface javax.portlet.PortletSession
Returns a Map of the session attributes in the portlet session scope.
getAttributeMap(int) - Method in interface javax.portlet.PortletSession
Returns a Map of the session attributes in the given session scope.
getAttributeNames() - Method in class javax.portlet.filter.PortletContextWrapper
 
getAttributeNames() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getAttributeNames() on the wrapped request object.
getAttributeNames() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttributeNames(int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
getAttributeNames() - Method in interface javax.portlet.PortletContext
Returns an Enumeration containing the attribute names available within this portlet context, or an empty Enumeration if no attributes are available.
getAttributeNames() - Method in interface javax.portlet.PortletRequest
Returns an Enumeration containing the names of the attributes available to this request.
getAttributeNames() - Method in interface javax.portlet.PortletSession
Returns an 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.
getAttributeNames(int) - Method in interface javax.portlet.PortletSession
Returns an 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.
getAuthType() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getAuthType() on the wrapped request object.
getAuthType() - Method in interface javax.portlet.PortletRequest
Returns the name of the authentication scheme used for the connection between client and portal, for example, BASIC_AUTH, CLIENT_CERT_AUTH, a custom one or null if there was no authentication.
getBufferSize() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getBufferSize() on the wrapped response object.
getBufferSize() - Method in interface javax.portlet.MimeResponse
Returns the actual buffer size used for the response.
getCacheability() - Method in class javax.portlet.filter.ResourceRequestWrapper
The default behavior of this method is to call getCacheability() on the wrapped response object.
getCacheability() - Method in class javax.portlet.filter.ResourceURLWrapper
 
getCacheability() - Method in interface javax.portlet.ResourceRequest
Returns the cache level of this resource request.
getCacheability() - Method in interface javax.portlet.ResourceURL
Returns the cache level of this resource URL.
getCacheControl() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getCacheControl() on the wrapped response object.
getCacheControl() - Method in interface javax.portlet.MimeResponse
Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response.
getCharacterEncoding() - Method in interface javax.portlet.ClientDataRequest
Returns the name of the character encoding used in the body of this request.
getCharacterEncoding() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getCharacterEncoding() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getCharacterEncoding() on the wrapped response object.
getCharacterEncoding() - Method in interface javax.portlet.MimeResponse
Returns the name of the charset used for the MIME body sent in this response.
getClassLoader() - Method in class javax.portlet.filter.PortletContextWrapper
 
getClassLoader() - Method in interface javax.portlet.PortletContext
Returns the class loader for this portlet context.
getContainerRuntimeOptions() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getContainerRuntimeOptions() - Method in class javax.portlet.filter.PortletContextWrapper
 
getContainerRuntimeOptions() - Method in class javax.portlet.GenericPortlet
 
getContainerRuntimeOptions() - Method in interface javax.portlet.PortletConfig
Returns the container runtime options and values for this portlet.
getContainerRuntimeOptions() - Method in interface javax.portlet.PortletContext
Returns the container container runtime options keys supported by this portlet container.
getContentLength() - Method in interface javax.portlet.ClientDataRequest
Returns the length, in bytes, of the request body which is made available by the input stream, or -1 if the length is not known.
getContentLength() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getContentLengthLong() - Method in interface javax.portlet.ClientDataRequest
Returns the length, in bytes, of the request body which is made available by the input stream, or -1 if the length is not known.
getContentLengthLong() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getContentType() - Method in interface javax.portlet.ClientDataRequest
Returns the MIME type of the body of the request, or null if the type is not known.
getContentType() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getContentType() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getContentType() on the wrapped response object.
getContentType() - Method in interface javax.portlet.MimeResponse
Returns the MIME type that can be used to contribute markup to the render response.
getContextPath() - Method in class javax.portlet.filter.PortletContextWrapper
 
getContextPath() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getContextPath() on the wrapped request object.
getContextPath() - Method in interface javax.portlet.PortletContext
Returns the context path for this portlet application.
getContextPath() - Method in interface javax.portlet.PortletRequest
Returns the context path which is the path prefix associated with the deployed portlet application.
getCookies() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getCookies() on the wrapped request object.
getCookies() - Method in interface javax.portlet.PortletRequest
Returns an array containing all of the Cookie properties.
getCreationTime() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getCreationTime() - Method in interface javax.portlet.PortletSession
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getDefaultNamespace() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getDefaultNamespace() - Method in class javax.portlet.GenericPortlet
Returns the default namespace for events and public parameters.
getDefaultNamespace() - Method in interface javax.portlet.PortletConfig
Returns the default namespace for events and public render parameters.
getDispatcherType() - Method in class javax.portlet.filter.ResourceRequestWrapper
 
getDispatcherType() - Method in interface javax.portlet.ResourceRequest
Gets the dispatcher type of this request.
getEffectiveMajorVersion() - Method in class javax.portlet.filter.PortletContextWrapper
 
getEffectiveMajorVersion() - Method in interface javax.portlet.PortletContext
Returns the major version of the Portlet API used by the portlet application running in this PortletContext.
getEffectiveMinorVersion() - Method in class javax.portlet.filter.PortletContextWrapper
 
getEffectiveMinorVersion() - Method in interface javax.portlet.PortletContext
Returns the minor version of the Portlet API used by the portlet application running in this PortletContext.
getETag() - Method in interface javax.portlet.CacheControl
Returns the ETag for the current response that is used as validation tag, or null if no ETag is set on the response.
getETag() - Method in class javax.portlet.filter.RenderRequestWrapper
The default behavior of this method is to call getETag() on the wrapped request object.
getETag() - Method in class javax.portlet.filter.ResourceRequestWrapper
The default behavior of this method is to call getETag() on the wrapped request object.
getETag() - Method in interface javax.portlet.RenderRequest
Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.
getETag() - Method in interface javax.portlet.ResourceRequest
Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.
getEvent() - Method in interface javax.portlet.EventRequest
Returns the event that triggered the call to the processEvent method.
getEvent() - Method in class javax.portlet.filter.EventRequestWrapper
The default behavior of this method is to call getEvent() on the wrapped request object.
getExpirationTime() - Method in interface javax.portlet.CacheControl
Get the currently set expiration time.
getFailedKeys() - Method in exception javax.portlet.ValidatorException
Returns the keys that failed the validation.
getFilterName() - Method in interface javax.portlet.filter.FilterConfig
Returns the filter-name of this filter as defined in the portlet deployment descriptor.
getFragmentIdentifier() - Method in class javax.portlet.filter.RenderURLWrapper
 
getFragmentIdentifier() - Method in interface javax.portlet.RenderURL
Gets the fragment identifier previously set on the URL.
getId() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getId() - Method in interface javax.portlet.PortletSession
Returns a string containing the unique identifier assigned to this session.
getInitParameter(String) - Method in interface javax.portlet.filter.FilterConfig
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in class javax.portlet.filter.PortletConfigWrapper
 
getInitParameter(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getInitParameter(String) - Method in class javax.portlet.GenericPortlet
Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in interface javax.portlet.PortletConfig
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String) - Method in interface javax.portlet.PortletContext
Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.
getInitParameterNames() - Method in interface javax.portlet.filter.FilterConfig
Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters.
getInitParameterNames() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getInitParameterNames() - Method in class javax.portlet.filter.PortletContextWrapper
 
getInitParameterNames() - Method in class javax.portlet.GenericPortlet
Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.
getInitParameterNames() - Method in interface javax.portlet.PortletConfig
Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.
getInitParameterNames() - Method in interface javax.portlet.PortletContext
Returns the names of the context initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.
getLastAccessedTime() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getLastAccessedTime() - Method in interface javax.portlet.PortletSession
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
getLocale() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getLocale() on the wrapped response object.
getLocale() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getLocale() on the wrapped request object.
getLocale() - Method in interface javax.portlet.MimeResponse
Returns the locale assigned to the response.
getLocale() - Method in interface javax.portlet.PortletRequest
Returns the preferred Locale in which the portal will accept content.
getLocales() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getLocales() on the wrapped request object.
getLocales() - Method in interface javax.portlet.PortletRequest
Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale in which the portal will accept content for this request.
getMajorVersion() - Method in class javax.portlet.filter.PortletContextWrapper
 
getMajorVersion() - Method in interface javax.portlet.PortletContext
Returns the major version of the Portlet API that this portlet container supports.
getMap() - Method in interface javax.portlet.PortletPreferences
Returns a Map of the preferences.
getMaxInactiveInterval() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getMaxInactiveInterval() - Method in interface javax.portlet.PortletSession
Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses.
getMethod() - Method in interface javax.portlet.ClientDataRequest
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getMethod() - Method in interface javax.portlet.EventRequest
Returns the name of the HTTP method with which the original action request was made, for example, POST, or PUT.
getMethod() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getMethod() - Method in class javax.portlet.filter.EventRequestWrapper
The default behavior of this method is to call getMethod() on the wrapped request object.
getMimeType(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getMimeType(String) - Method in interface javax.portlet.PortletContext
Returns the MIME type of the specified file, or null if the MIME type is not known.
getMinorVersion() - Method in class javax.portlet.filter.PortletContextWrapper
 
getMinorVersion() - Method in interface javax.portlet.PortletContext
Returns the minor version of the Portlet API that this portlet container supports.
getMode() - Method in exception javax.portlet.PortletModeException
Returns the unsupported portlet mode causing this exception.
getName() - Method in interface javax.portlet.Event
Get the local part of the event name.
getNamedDispatcher(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getNamedDispatcher(String) - Method in interface javax.portlet.PortletContext
Returns a PortletRequestDispatcher object that acts as a wrapper for the named servlet.
getNames() - Method in class javax.portlet.filter.PortletParametersWrapper
 
getNames() - Method in interface javax.portlet.MutablePortletParameters
Returns a Set of String objects containing the names of the parameters contained in this object.
getNames() - Method in interface javax.portlet.PortletParameters
Returns a Set of String objects containing the names of the parameters contained in this object.
getNames() - Method in interface javax.portlet.PortletPreferences
Returns all of the keys that have an associated value, or an empty Enumeration if no keys are available.
getNamespace() - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call getNamespace() on the wrapped response object.
getNamespace() - Method in interface javax.portlet.PortletResponse
The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.
getNextPossiblePortletModes(RenderRequest) - Method in class javax.portlet.GenericPortlet
Used by the render method to set the next possible portlet modes.
getParameter(String) - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getParameter(String) - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterMap() - Method in interface javax.portlet.BaseURL
getParameterMap() - Method in class javax.portlet.filter.BaseURLWrapper
Deprecated.
getParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getParameterMap() - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterNames() - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getParameterNames() - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterValues(String) - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getParameterValues(String) - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPart(String) - Method in interface javax.portlet.ClientDataRequest
Gets the Part with the given name.
getPart(String) - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getParts() - Method in interface javax.portlet.ClientDataRequest
Gets all the Part components of this request, provided that it is of type multipart/form-data.
getParts() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getPortalContext() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPortalContext() on the wrapped request object.
getPortalContext() - Method in interface javax.portlet.PortletRequest
Returns the context of the calling portal.
getPortalInfo() - Method in class javax.portlet.filter.PortalContextWrapper
 
getPortalInfo() - Method in interface javax.portlet.PortalContext
Returns information about the portal like vendor, version, etc.
getPortletAsyncContext() - Method in class javax.portlet.filter.ResourceRequestWrapper
 
getPortletAsyncContext() - Method in class javax.portlet.PortletAsyncEvent
Gets the portlet asynchronous context object associated with the event.
getPortletAsyncContext() - Method in interface javax.portlet.ResourceRequest
Gets the AsyncContext that was created or reinitialized by the most recent invocation of startAsync() or startAsync(ResourceRequest,ResourceResponse) on this request.
getPortletConfig() - Method in class javax.portlet.GenericPortlet
Returns the PortletConfig object of this portlet.
getPortletContext() - Method in interface javax.portlet.filter.FilterConfig
Returns a reference to the PortletContext in which the caller is executing.
getPortletContext() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPortletContext() - Method in class javax.portlet.filter.PortletContextWrapper
Gets the wrapped object.
getPortletContext() - Method in class javax.portlet.filter.PortletRequestWrapper
 
getPortletContext() - Method in class javax.portlet.filter.PortletSessionWrapper
 
getPortletContext() - Method in class javax.portlet.GenericPortlet
Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface javax.portlet.PortletConfig
Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface javax.portlet.PortletRequest
Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface javax.portlet.PortletSession
Returns the portlet application context associated with this session.
getPortletContextName() - Method in class javax.portlet.filter.PortletContextWrapper
 
getPortletContextName() - Method in interface javax.portlet.PortletContext
Returns the name of this portlet application correponding to this PortletContext as specified in the web.xml deployment descriptor for this web application by the display-name element.
getPortletInputStream() - Method in interface javax.portlet.ClientDataRequest
Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
getPortletInputStream() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getPortletMode() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPortletMode() on the wrapped request object.
getPortletMode() - Method in class javax.portlet.filter.RenderStateWrapper
 
getPortletMode() - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
getPortletMode() - Method in interface javax.portlet.RenderState
Returns the current portlet mode of the portlet.
getPortletMode() - Method in interface javax.portlet.ResourceRequest
Returns the current portlet mode of the portlet.
getPortletModes(String) - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPortletModes(String) - Method in class javax.portlet.GenericPortlet
Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
getPortletModes(String) - Method in interface javax.portlet.PortletConfig
Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
getPortletName() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPortletName() - Method in class javax.portlet.GenericPortlet
Returns the name of this portlet.
getPortletName() - Method in interface javax.portlet.PortletConfig
Returns the name of the portlet.
getPortletOutputStream() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getPortletOutputStream() on the wrapped response object.
getPortletOutputStream() - Method in interface javax.portlet.HeaderResponse
Data written to the HeaderResponse output stream is added to the aggregated portal document HEAD section.
getPortletOutputStream() - Method in interface javax.portlet.MimeResponse
Returns a OutputStream suitable for writing binary data in the response.
getPortletSession() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPortletSession() on the wrapped request object.
getPortletSession(boolean) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPortletSession(create) on the wrapped request object.
getPortletSession() - Method in interface javax.portlet.PortletRequest
Returns the current portlet session or, if there is no current session, creates one and returns the new session.
getPortletSession(boolean) - Method in interface javax.portlet.PortletRequest
Returns the current portlet session or, if there is no current session and the given flag is true, creates one and returns the new session.
getPreferences() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPreferences() on the wrapped request object.
getPreferences() - Method in interface javax.portlet.PortletRequest
Returns the preferences object associated with the portlet.
getPrivateParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getPrivateParameterMap() - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPrivateRenderParameterMap() - Method in class javax.portlet.filter.ResourceRequestWrapper
Deprecated.
getPrivateRenderParameterMap() - Method in interface javax.portlet.ResourceRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getProcessingEventQNames() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getProcessingEventQNames() - Method in class javax.portlet.GenericPortlet
 
getProcessingEventQNames() - Method in interface javax.portlet.PortletConfig
Returns the QNames of the processing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any processing events.
getProperties(String) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getProperteis(name) on the wrapped request object.
getProperties(String) - Method in interface javax.portlet.PortletRequest
Returns all the values of the specified request property as a Enumeration of String objects.
getProperty(String) - Method in class javax.portlet.filter.PortalContextWrapper
 
getProperty(String) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getProperty(name) on the wrapped request object.
getProperty(String) - Method in class javax.portlet.filter.PortletResponseWrapper
 
getProperty(String) - Method in interface javax.portlet.PortalContext
Returns the portal property with the given name, or a null if there is no property by that name.
getProperty(String) - Method in interface javax.portlet.PortletRequest
Returns the value of the specified request property as a String.
getProperty(String) - Method in interface javax.portlet.PortletResponse
Gets the value of the response property with the given name.
getPropertyNames() - Method in class javax.portlet.filter.PortalContextWrapper
 
getPropertyNames() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getPropertyNames() on the wrapped request object.
getPropertyNames() - Method in class javax.portlet.filter.PortletResponseWrapper
 
getPropertyNames() - Method in interface javax.portlet.PortalContext
Returns all portal property names, or an empty Enumeration if there are no property names.
getPropertyNames() - Method in interface javax.portlet.PortletRequest
Returns a Enumeration of all the property names this request contains.
getPropertyNames() - Method in interface javax.portlet.PortletResponse
Gets the names of all response properties set on the response.
getPropertyValues(String) - Method in class javax.portlet.filter.PortletResponseWrapper
 
getPropertyValues(String) - Method in interface javax.portlet.PortletResponse
Gets the values of the response property with the given name.
getPublicParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper
Deprecated.
getPublicParameterMap() - Method in interface javax.portlet.PortletRequest
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPublicRenderParameterDefinitions() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPublicRenderParameterDefinitions() - Method in class javax.portlet.GenericPortlet
Returns a Map of public render parameter names to their qualified names.
getPublicRenderParameterDefinitions() - Method in interface javax.portlet.PortletConfig
Returns a Map of public render parameter names to their qualified names.
getPublicRenderParameterNames() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPublicRenderParameterNames() - Method in class javax.portlet.GenericPortlet
Returns the names of the public render parameters supported by the portlet as an Enumeration of String objects, or an empty Enumeration if the portlet has no public render parameters.
getPublicRenderParameterNames() - Method in interface javax.portlet.PortletConfig
Returns the names of the public render parameters supported by the portlet as an Enumeration of String objects, or an empty Enumeration if the portlet has not defined public render parameters.
getPublishingEventQNames() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getPublishingEventQNames() - Method in class javax.portlet.GenericPortlet
 
getPublishingEventQNames() - Method in interface javax.portlet.PortletConfig
Returns the QNames of the publishing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any publishing events.
getQName() - Method in interface javax.portlet.Event
Get the event QName.
getReader() - Method in interface javax.portlet.ClientDataRequest
Retrieves the body of the HTTP request from the client to the portal as character data using a BufferedReader.
getReader() - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
getRealPath(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getRealPath(String) - Method in interface javax.portlet.PortletContext
Returns a String containing the real path for a given virtual path.
getRemoteUser() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getRemoteUser() on the wrapped request object.
getRemoteUser() - Method in interface javax.portlet.PortletRequest
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
getRenderParameterMap() - Method in class javax.portlet.filter.StateAwareResponseWrapper
Deprecated.
getRenderParameterMap() - Method in interface javax.portlet.StateAwareResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
getRenderParameters() - Method in class javax.portlet.filter.MutableRenderStateWrapper
 
getRenderParameters() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getRenderParameters() on the wrapped request object.
getRenderParameters() - Method in class javax.portlet.filter.PortletURLWrapper
 
getRenderParameters() - Method in class javax.portlet.filter.RenderStateWrapper
 
getRenderParameters() - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
getRenderParameters() - Method in interface javax.portlet.MutableRenderState
Gets the mutable render parameters.
getRenderParameters() - Method in interface javax.portlet.RenderState
Gets the render parameters.
getRequest() - Method in class javax.portlet.filter.ActionRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.ClientDataRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.EventRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.HeaderRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.PortletRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.RenderRequestWrapper
Return the wrapped request object.
getRequest() - Method in class javax.portlet.filter.ResourceRequestWrapper
Return the wrapped request object.
getRequestDispatcher(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getRequestDispatcher(String) - Method in interface javax.portlet.PortletContext
Returns a PortletRequestDispatcher object that acts as a wrapper for the resource located at the given path.
getRequestedSessionId() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getRequestedSessionId() on the wrapped request object.
getRequestedSessionId() - Method in interface javax.portlet.PortletRequest
Returns the session ID indicated in the client request.
getResource(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getResource(String) - Method in interface javax.portlet.PortletContext
Returns a URL to the resource that is mapped to a specified path.
getResourceAsStream(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getResourceAsStream(String) - Method in interface javax.portlet.PortletContext
Returns the resource located at the given path as an InputStream object.
getResourceBundle(Locale) - Method in class javax.portlet.filter.PortletConfigWrapper
 
getResourceBundle(Locale) - Method in class javax.portlet.GenericPortlet
Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.
getResourceBundle(Locale) - Method in interface javax.portlet.PortletConfig
Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.
getResourceID() - Method in class javax.portlet.filter.ResourceRequestWrapper
The default behavior of this method is to call getResourceID() on the wrapped request object.
getResourceID() - Method in class javax.portlet.filter.ResourceURLWrapper
 
getResourceID() - Method in interface javax.portlet.ResourceRequest
Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.
getResourceID() - Method in interface javax.portlet.ResourceURL
Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.
getResourceParameters() - Method in class javax.portlet.filter.ResourceRequestWrapper
The default behavior of this method is to call getResourceParameters() on the wrapped response object.
getResourceParameters() - Method in class javax.portlet.filter.ResourceURLWrapper
 
getResourceParameters() - Method in interface javax.portlet.ResourceRequest
Gets the resource parameters set for this request.
getResourceParameters() - Method in interface javax.portlet.ResourceURL
Gets the resource parameter values set for this URL.
getResourcePaths(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
getResourcePaths(String) - Method in interface javax.portlet.PortletContext
Returns a directory-like listing of all the paths to resources within the web application longest sub-path of which matches the supplied path argument.
getResourceRequest() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
getResourceRequest() - Method in interface javax.portlet.PortletAsyncContext
Gets the request that was used to initialize this PortletAsyncContext by calling ResourceRequest.startAsync() or ResourceRequest.startAsync(ServletRequest, ServletResponse).
getResourceResponse() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
getResourceResponse() - Method in interface javax.portlet.PortletAsyncContext
Gets the response that was used to initialize this PortletAsyncContext by calling ResourceRequest.startAsync() or ResourceRequest.startAsync(ServletRequest, ServletResponse).
getResponse() - Method in class javax.portlet.filter.ActionResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.EventResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.HeaderResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.MimeResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.PortletResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.RenderResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.ResourceResponseWrapper
Return the wrapped response object.
getResponse() - Method in class javax.portlet.filter.StateAwareResponseWrapper
Return the wrapped response object.
getResponseContentType() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getResponseContentType() on the wrapped request object.
getResponseContentType() - Method in interface javax.portlet.PortletRequest
Returns the portal preferred content type for the response.
getResponseContentType() - Method in interface javax.portlet.ResourceRequest
Returns the portal preferred content type for the response.
getResponseContentTypes() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getResponseContentTypes() on the wrapped request object.
getResponseContentTypes() - Method in interface javax.portlet.PortletRequest
Gets a list of content types which the portal accepts for the response.
getResponseContentTypes() - Method in interface javax.portlet.ResourceRequest
Gets a list of content types which the portal accepts for the response.
getScheme() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getScheme() on the wrapped request object.
getScheme() - Method in interface javax.portlet.PortletRequest
Returns the name of the scheme used to make this request.
getServerInfo() - Method in class javax.portlet.filter.PortletContextWrapper
 
getServerInfo() - Method in interface javax.portlet.PortletContext
Returns the name and version of the portlet container in which the portlet is running.
getServerName() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getServerName() on the wrapped request object.
getServerName() - Method in interface javax.portlet.PortletRequest
Returns the host name of the server that received the request.
getServerPort() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getServerPort() on the wrapped request object.
getServerPort() - Method in interface javax.portlet.PortletRequest
Returns the port number on which this request was received.
getState() - Method in exception javax.portlet.WindowStateException
Returns the window state causing this exception.
getStatus() - Method in class javax.portlet.filter.ResourceResponseWrapper
 
getStatus() - Method in interface javax.portlet.ResourceResponse
Gets the current HTTP status code for the response.
getSuppliedRequest() - Method in class javax.portlet.PortletAsyncEvent
Gets the resource request associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.
getSuppliedResponse() - Method in class javax.portlet.PortletAsyncEvent
Gets the resource response associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.
getSupportedLocales() - Method in class javax.portlet.filter.PortletConfigWrapper
 
getSupportedLocales() - Method in class javax.portlet.GenericPortlet
 
getSupportedLocales() - Method in interface javax.portlet.PortletConfig
Returns the locales supported by the portlet as an Enumeration of Locale objects, or an empty Enumeration if the portlet has not defined any supported locales.
getSupportedPortletModes() - Method in class javax.portlet.filter.PortalContextWrapper
 
getSupportedPortletModes() - Method in interface javax.portlet.PortalContext
Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.
getSupportedWindowStates() - Method in class javax.portlet.filter.PortalContextWrapper
 
getSupportedWindowStates() - Method in interface javax.portlet.PortalContext
Returns all supported window states by the portal as an enumeration of WindowState objects.
getThrowable() - Method in class javax.portlet.PortletAsyncEvent
Gets the Throwable associated with the event.
getTimeout() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
getTimeout() - Method in interface javax.portlet.PortletAsyncContext
Gets the timeout (in milliseconds) for this PortletAsyncContext.
getTitle(RenderRequest) - Method in class javax.portlet.GenericPortlet
Used by the render method to get the title.
getUnavailableSeconds() - Method in exception javax.portlet.UnavailableException
Returns the time in seconds for which the portlet can be expected to be unavailable.
getUserAgent() - Method in class javax.portlet.filter.PortletRequestWrapper
 
getUserAgent() - Method in interface javax.portlet.PortletRequest
Returns the user agent for the request.
getUserPrincipal() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getUserPrincipal() on the wrapped request object.
getUserPrincipal() - Method in interface javax.portlet.PortletRequest
Returns a java.security.Principal object containing the name of the current authenticated user.
getValue() - Method in interface javax.portlet.Event
Get the event payload.
getValue(String) - Method in class javax.portlet.filter.PortletParametersWrapper
 
getValue(String) - Method in interface javax.portlet.PortletParameters
Returns the value of a parameter as a String.
getValue(String, String) - Method in interface javax.portlet.PortletPreferences
Returns the first String value associated with the specified key of this preference.
getValues(String) - Method in class javax.portlet.filter.PortletParametersWrapper
 
getValues(String) - Method in interface javax.portlet.PortletParameters
Returns an array of String objects containing all of the values the given parameter, or null if the parameter does not exist.
getValues(String, String[]) - Method in interface javax.portlet.PortletPreferences
Returns the String array value associated with the specified key in this preference.
getWindowID() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getWindowId() on the wrapped request object.
getWindowID() - Method in interface javax.portlet.PortletRequest
Returns the portlet window ID.
getWindowState() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call getWindowState() on the wrapped request object.
getWindowState() - Method in class javax.portlet.filter.RenderStateWrapper
 
getWindowState() - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
getWindowState() - Method in interface javax.portlet.RenderState
Returns the current window state of the portlet.
getWindowState() - Method in interface javax.portlet.ResourceRequest
Returns the current window state of the portlet.
getWindowStates(String) - Method in class javax.portlet.filter.PortletConfigWrapper
 
getWindowStates(String) - Method in class javax.portlet.GenericPortlet
Returns an Enumeration of WindowState objects that are defined for the portlet for the given MIME type.
getWindowStates(String) - Method in interface javax.portlet.PortletConfig
Returns an Enumeration of WindowState objects that are defined for the portlet for the given MIME type.
getWrapped() - Method in class javax.portlet.filter.ActionParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.ActionURLWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.BaseURLWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.MutableActionParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.MutablePortletParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.MutableRenderParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.MutableRenderStateWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.MutableResourceParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortalContextWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
getWrapped() - Method in class javax.portlet.filter.PortletConfigWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortletParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortletRequestDispatcherWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortletSessionWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.PortletURLWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.RenderParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.RenderStateWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.RenderURLWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.ResourceParametersWrapper
Gets the wrapped object.
getWrapped() - Method in class javax.portlet.filter.ResourceURLWrapper
Gets the wrapped object.
getWriter() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call getWriter() on the wrapped response object.
getWriter() - Method in interface javax.portlet.HeaderResponse
Data written to the HeaderResponse writer is added to the aggregated portal document HEAD section.
getWriter() - Method in interface javax.portlet.MimeResponse
Returns a PrintWriter object that can send character text to the portal.

H

hashCode() - Method in class javax.portlet.PortletMode
Returns the hash code value for this portlet mode.
hashCode() - Method in class javax.portlet.WindowState
Returns the hash code value for this window state.
hasOriginalRequestAndResponse() - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
hasOriginalRequestAndResponse() - Method in interface javax.portlet.PortletAsyncContext
Checks if this PortletAsyncContext was initialized with the original or application-wrapped request and response objects.
HEADER_PHASE - Static variable in interface javax.portlet.PortletRequest
String identifier for the portlet render lifecycle phase.
HeaderFilter - Interface in javax.portlet.filter
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 - Interface in javax.portlet.filter
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 - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the renderHeaders method of the HeaderPortlet interface.
HeaderPortlet - Interface in javax.portlet
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 - Interface in javax.portlet
Tag interface designating a header request object.
HeaderRequestWrapper - Class in javax.portlet.filter
The HeaderRequestWrapper provides a convenient implementation of the HeaderRequest interface that can be subclassed by developers.
HeaderRequestWrapper(HeaderRequest) - Constructor for class javax.portlet.filter.HeaderRequestWrapper
Creates an HeaderRequest adaptor wrapping the given request object.
HeaderResponse - Interface in javax.portlet
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 - Class in javax.portlet.filter
The HeaderResponseWrapper provides a convenient implementation of the HeaderResponse interface that can be subclassed by developers.
HeaderResponseWrapper(HeaderResponse) - Constructor for class javax.portlet.filter.HeaderResponseWrapper
 
HELP - Static variable in class javax.portlet.PortletMode
When in HELP portlet mode, a portlet should provide help information about the portlet.
HTTP_STATUS_CODE - Static variable in interface javax.portlet.ResourceResponse
Constant for setting the HTTP status code via the setProperty method.

I

include(RenderRequest, RenderResponse) - Method in class javax.portlet.filter.PortletRequestDispatcherWrapper
 
include(PortletRequest, PortletResponse) - Method in class javax.portlet.filter.PortletRequestDispatcherWrapper
 
include(RenderRequest, RenderResponse) - Method in interface javax.portlet.PortletRequestDispatcher
Includes the content of a resource (servlet, JSP page, HTML file) in the response.
include(PortletRequest, PortletResponse) - Method in interface javax.portlet.PortletRequestDispatcher
Includes the content of a resource (servlet, JSP page, HTML file) in the response.
init(FilterConfig) - Method in interface javax.portlet.filter.PortletFilter
Called by the portlet container to indicate to a filter that it is being placed into service.
init(PortletConfig) - Method in class javax.portlet.GenericPortlet
Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
init() - Method in class javax.portlet.GenericPortlet
A convenience method which can be overridden so that there's no need to call super.init(config).
init(PortletConfig) - Method in interface javax.portlet.Portlet
Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
InitMethod - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API init method.
InitParameter - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent name-value pairs.
invalidate() - Method in class javax.portlet.filter.PortletSessionWrapper
 
invalidate() - Method in interface javax.portlet.PortletSession
Invalidates this session (all scopes) and unbinds any objects bound to it.
isAsyncStarted() - Method in class javax.portlet.filter.ResourceRequestWrapper
 
isAsyncStarted() - Method in interface javax.portlet.ResourceRequest
Checks if this request has been put into asynchronous mode.
isAsyncSupported() - Method in class javax.portlet.filter.ResourceRequestWrapper
 
isAsyncSupported() - Method in interface javax.portlet.ResourceRequest
Checks if this request supports asynchronous operation.
isCommitted() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call isCommitted() on the wrapped response object.
isCommitted() - Method in interface javax.portlet.MimeResponse
Returns a boolean indicating if the response has been committed.
isEmpty() - Method in class javax.portlet.filter.PortletParametersWrapper
 
isEmpty() - Method in interface javax.portlet.PortletParameters
Returns a true if no parameters have been set.
isNew() - Method in class javax.portlet.filter.PortletSessionWrapper
 
isNew() - Method in interface javax.portlet.PortletSession
Returns true if the client does not yet know about the session or if the client chooses not to join the session.
isPermanent() - Method in exception javax.portlet.UnavailableException
Returns a boolean indicating whether the portlet is permanently unavailable.
isPortletModeAllowed(PortletMode) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call isPortletModeAllowed(mode) on the wrapped request object.
isPortletModeAllowed(PortletMode) - Method in interface javax.portlet.PortletRequest
Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.
isPublic(String) - Method in class javax.portlet.filter.MutableRenderParametersWrapper
 
isPublic(String) - Method in class javax.portlet.filter.RenderParametersWrapper
 
isPublic(String) - Method in interface javax.portlet.RenderParameters
Returns a boolean value indicating whether the given parameter name represents a public render parameter.
isPublicScope() - Method in interface javax.portlet.CacheControl
Returns a boolean indicating whether the caching scope is set to public for the current response.
isReadOnly(String) - Method in interface javax.portlet.PortletPreferences
Returns true, if the value of this key is defined as read-only and thus cannot be modified by the user.
isRequestedSessionIdValid() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call isRequestedSessionIdValid() on the wrapped request object.
isRequestedSessionIdValid() - Method in interface javax.portlet.PortletRequest
Checks whether the requested session ID is still valid.
isSecure() - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call isSecure() on the wrapped request object.
isSecure() - Method in interface javax.portlet.PortletRequest
Returns a boolean indicating whether this request was made using a secure channel between client and the portal, such as HTTPS.
isUserInRole(String) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call isUserInRole(role) on the wrapped request object.
isUserInRole(String) - Method in interface javax.portlet.PortletRequest
Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
isWindowStateAllowed(WindowState) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call isWindowStateAllowed(state) on the wrapped request object.
isWindowStateAllowed(WindowState) - Method in interface javax.portlet.PortletRequest
Returns true, if the given window state is valid to be set for this portlet in the context of the current request.

J

javax.portlet - package javax.portlet
The javax.portlet package defines the API for the Java Portlet Specification V3.0.
javax.portlet.annotations - package javax.portlet.annotations
The javax.portlet.annotations package provides the annotations used for portlet configuration and portlet-specific dependency injection.
javax.portlet.filter - package javax.portlet.filter
The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.

L

LIFECYCLE_PHASE - Static variable in interface javax.portlet.PortletRequest
Provides the portlet lifecycle phase of the current request as request attribute.
LocaleString - Annotation Type in javax.portlet.annotations
This annotation represents locale-specific strings used within composite portlet configuration annotations to represent information describing the portlet.
log(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
log(String, Throwable) - Method in class javax.portlet.filter.PortletContextWrapper
 
log(String) - Method in interface javax.portlet.PortletContext
Writes the specified message to a portlet log file, usually an event log.
log(String, Throwable) - Method in interface javax.portlet.PortletContext
Writes an explanatory message and a stack trace for a given Throwable exception to the portlet log file.

M

MARKUP_HEAD_ELEMENT - Static variable in interface javax.portlet.MimeResponse
Property intended to be a hint to the portal application that the provided DOM element should be added to the markup head section of the response to the client.
MARKUP_HEAD_ELEMENT_SUPPORT - Static variable in interface javax.portlet.PortalContext
Property indicating if the portal application supports the MimeResponse property MARKUP_HEAD_ELEMENT.
MAXIMIZED - Static variable in class javax.portlet.WindowState
The 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 - Interface in javax.portlet
The MimeResponse defines the base interface to assist a portlet in returning MIME content.
MimeResponse.Copy - Enum in javax.portlet
Specifies processing when a URL is created.
MimeResponseWrapper - Class in javax.portlet.filter
The MimeResponseWrapper provides a convenient implementation of the MimeResponse interface that can be subclassed by developers.
MimeResponseWrapper(MimeResponse) - Constructor for class javax.portlet.filter.MimeResponseWrapper
 
MINIMIZED - Static variable in class javax.portlet.WindowState
When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.
Multipart - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to add multipart configuration information.
Mutable - Interface in javax.portlet
This is a marker interface indicating that the implementing object contains methods for updating portelt state information.
MutableActionParameters - Interface in javax.portlet
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 - Class in javax.portlet.filter
The MutableActionParametersWrapper provides a convenient implementation of the MutableActionParameters interface that can be subclassed by developers.
MutableActionParametersWrapper(MutableActionParameters) - Constructor for class javax.portlet.filter.MutableActionParametersWrapper
 
MutablePortletParameters - Interface in javax.portlet
The MutablePortletParameters provides methods that allow setting parameters to define a potential future render state.
MutablePortletParametersWrapper - Class in javax.portlet.filter
The MutablePortletParametersWrapper provides a convenient implementation of the MutablePortletParameters interface that can be subclassed by developers.
MutablePortletParametersWrapper(MutablePortletParameters) - Constructor for class javax.portlet.filter.MutablePortletParametersWrapper
 
MutableRenderParameters - Interface in javax.portlet
Provides methods that allow setting parameters to define a potential future render state.
MutableRenderParametersWrapper - Class in javax.portlet.filter
The MutableRenderParametersWrapper provides a convenient implementation of the MutableRenderParameters interface that can be subclassed by developers.
MutableRenderParametersWrapper(MutableRenderParameters) - Constructor for class javax.portlet.filter.MutableRenderParametersWrapper
 
MutableRenderState - Interface in javax.portlet
Provides read-write access to the render state.
MutableRenderStateWrapper - Class in javax.portlet.filter
The MutableRenderStateWrapper provides a convenient implementation of the MutableRenderState interface that can be subclassed by developers.
MutableRenderStateWrapper(MutableRenderState) - Constructor for class javax.portlet.filter.MutableRenderStateWrapper
 
MutableResourceParameters - Interface in javax.portlet
Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
MutableResourceParametersWrapper - Class in javax.portlet.filter
The MutableResourceParametersWrapper provides a convenient implementation of the MutableResourceParameters interface that can be subclassed by developers.
MutableResourceParametersWrapper(MutableResourceParameters) - Constructor for class javax.portlet.filter.MutableResourceParametersWrapper
 

N

Namespace - Annotation Type in javax.portlet.annotations
Qualifier that specifies the namespace for injection.
NAMESPACED_RESPONSE - Static variable in interface javax.portlet.MimeResponse
Property intended to be a hint to the portal application that the returned content is completely namespaced.
NORMAL - Static variable in class javax.portlet.WindowState
The NORMAL window state indicates that a portlet may be sharing the page with other portlets.

O

onComplete(PortletAsyncEvent) - Method in interface javax.portlet.PortletAsyncListener
Notifies this PortletAsyncListener that an asynchronous operation has been completed.
onError(PortletAsyncEvent) - Method in interface javax.portlet.PortletAsyncListener
Notifies this PortletAsyncListener that an asynchronous operation has failed to complete.
onStartAsync(PortletAsyncEvent) - Method in interface javax.portlet.PortletAsyncListener
Notifies this PortletAsyncListener that a new asynchronous cycle is being initiated via a call to one of the ResourceRequest#startAsync methods.
onTimeout(PortletAsyncEvent) - Method in interface javax.portlet.PortletAsyncListener
Notifies this PortletAsyncListener that an asynchronous operation has timed out.

P

PAGE - Static variable in interface javax.portlet.ResourceURL
The URL of type PAGE may contain artifacts that require knowledge of the state of the complete page, like PortletURLs.
PortalContext - Interface in javax.portlet
The PortalContext interface gives the portlet the ability to retrieve information about the portal calling this portlet.
PortalContextWrapper - Class in javax.portlet.filter
The PortalContextWrapper provides a convenient implementation of the PortalContext interface that can be subclassed by developers.
PortalContextWrapper(PortalContext) - Constructor for class javax.portlet.filter.PortalContextWrapper
 
Portlet - Interface in javax.portlet
The Portlet interface is used by the portlet container to invoke the portlets.
PORTLET - Static variable in interface javax.portlet.ResourceURL
The URL of type PORTLRET does not need to contain the current state of the page, but the current render parameters, portlet mode, or window state of the portlet must be accessible to the portlet.
PORTLET_SCOPE - Static variable in interface javax.portlet.PortletSession
This constant defines the scope of the session attribute to be private to the portlet and its included resources.
PortletApplication - Annotation Type in javax.portlet.annotations
Annotation for the portlet application configuration.
PortletAsyncContext - Interface in javax.portlet
Class representing the execution context for an asynchronous operation that was initiated on a ResourceRequest.
PortletAsyncContextWrapper - Class in javax.portlet.filter
The PortletAsyncContextWrapper provides a convenient implementation of the PortletAsyncContext interface that can be subclassed by developers.
PortletAsyncContextWrapper(PortletAsyncContext) - Constructor for class javax.portlet.filter.PortletAsyncContextWrapper
 
PortletAsyncEvent - Class in javax.portlet
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.
PortletAsyncEvent(PortletAsyncContext, ResourceRequest, ResourceResponse, Throwable) - Constructor for class javax.portlet.PortletAsyncEvent
Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, ResourceResponse, and Throwable.
PortletAsyncEvent(PortletAsyncContext, ResourceRequest, ResourceResponse) - Constructor for class javax.portlet.PortletAsyncEvent
Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, and ResourceResponse.
PortletAsyncEvent(PortletAsyncContext, Throwable) - Constructor for class javax.portlet.PortletAsyncEvent
Constructs a PortletAsyncEvent from the given PortletAsyncContext and Throwable.
PortletAsyncEvent(PortletAsyncContext) - Constructor for class javax.portlet.PortletAsyncEvent
Constructs a PortletAsyncEvent from the given PortletAsyncContext.
PortletAsyncListener - Interface in javax.portlet
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 - Interface in javax.portlet
The PortletConfig interface provides the portlet with its configuration.
PortletConfiguration - Annotation Type in javax.portlet.annotations
Annotation for the portlet configuration.
PortletConfigurations - Annotation Type in javax.portlet.annotations
Annotation for configuration of multiple portlets.
PortletConfigWrapper - Class in javax.portlet.filter
The PortletConfigWrapper provides a convenient implementation of the PortletConfig interface that can be subclassed by developers.
PortletConfigWrapper(PortletConfig) - Constructor for class javax.portlet.filter.PortletConfigWrapper
 
PortletContext - Interface in javax.portlet
The PortletContext interface defines a portlet view of the portlet container.
PortletContextWrapper - Class in javax.portlet.filter
The PortletContextWrapper provides a convenient implementation of the PortletContext interface that can be subclassed by developers.
PortletContextWrapper(PortletContext) - Constructor for class javax.portlet.filter.PortletContextWrapper
 
PortletException - Exception in javax.portlet
The PortletException class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.
PortletException() - Constructor for exception javax.portlet.PortletException
Constructs a new portlet exception.
PortletException(String) - Constructor for exception javax.portlet.PortletException
Constructs a new portlet exception with the given text.
PortletException(String, Throwable) - Constructor for exception javax.portlet.PortletException
Constructs a new portlet exception when the portlet needs to do the following: throw an exception include the "root cause" exception include a description message
PortletException(Throwable) - Constructor for exception javax.portlet.PortletException
Constructs a new portlet exception when the portlet needs to throw an exception.
PortletFilter - Interface in javax.portlet.filter
The PortletFilter is the base interface for all portlet filters.
PortletLifecycleFilter - Annotation Type in javax.portlet.annotations
Designates a portlet request filter class.
PortletListener - Annotation Type in javax.portlet.annotations
Designates a portlet URL generation listener class.
PortletMode - Class in javax.portlet
The PortletMode class represents the possible modes that a portlet can assume.
PortletMode() - Constructor for class javax.portlet.PortletMode
No-arg constructor to make object proxyable
PortletMode(String) - Constructor for class javax.portlet.PortletMode
Creates a new portlet mode with the given name.
PortletModeException - Exception in javax.portlet
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.
PortletModeException(String, PortletMode) - Constructor for exception javax.portlet.PortletModeException
Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
PortletModeException(String, Throwable, PortletMode) - Constructor for exception javax.portlet.PortletModeException
Constructs a new portlet mode exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message include the portlet mode that caused this exception
PortletModeException(Throwable, PortletMode) - Constructor for exception javax.portlet.PortletModeException
Constructs a new portlet mode exception when the portlet needs to throw an exception.
PortletName - Annotation Type in javax.portlet.annotations
Qualifier that specifies the portlet name for injection.
PortletParameters - Interface in javax.portlet
The PortletParameters interface defines the API for accessing the parameters that are set for the portlet or on a portlet URL.
PortletParametersWrapper - Class in javax.portlet.filter
The PortletParametersWrapper provides a convenient implementation of the PortletParameters interface that can be subclassed by developers.
PortletParametersWrapper(PortletParameters) - Constructor for class javax.portlet.filter.PortletParametersWrapper
 
PortletPreferences - Interface in javax.portlet
The PortletPreferences interface allows the portlet to store configuration data.
PortletPreferencesValidator - Annotation Type in javax.portlet.annotations
Designates a preferences validator class.
PortletQName - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a QName for use in portlet event and public render parameter definitions.
PortletRequest - Interface in javax.portlet
The PortletRequest defines the base interface to provide client request information to a portlet.
PortletRequest.P3PUserInfos - Enum in javax.portlet
P3P user information constants.
PortletRequestDispatcher - Interface in javax.portlet
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 - Class in javax.portlet.filter
The PortletRequestDispatcherWrapper provides a convenient implementation of the PortletRequestDispatcher interface that can be subclassed by developers.
PortletRequestDispatcherWrapper(PortletRequestDispatcher) - Constructor for class javax.portlet.filter.PortletRequestDispatcherWrapper
 
PortletRequestScoped - Annotation Type in javax.portlet.annotations
Provides a CDI custom scope for the portlet request.
PortletRequestWrapper - Class in javax.portlet.filter
The PortletRequestWrapper provides a convenient implementation of the PortletRequest interface and is extended by other request wrappers.
PortletRequestWrapper(PortletRequest) - Constructor for class javax.portlet.filter.PortletRequestWrapper
Creates an PortletRequest adaptor wrapping the given request object.
PortletResponse - Interface in javax.portlet
The PortletResponse defines the base interface to assist a portlet in creating and sending a response to the client.
PortletResponseWrapper - Class in javax.portlet.filter
The PortletResponseWrapper provides a convenient implementation of the PortletResponse interface and is extended by other response wrappers.
PortletResponseWrapper(PortletResponse) - Constructor for class javax.portlet.filter.PortletResponseWrapper
Creates an ActionResponse adaptor wrapping the given response object.
PortletSecurityException - Exception in javax.portlet
A portlet should throw a PortletSecurityException when a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.
PortletSecurityException(String) - Constructor for exception javax.portlet.PortletSecurityException
Constructs a new security exception with the given text.
PortletSecurityException(String, Throwable) - Constructor for exception javax.portlet.PortletSecurityException
Constructs a new portlet security exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message
PortletSecurityException(Throwable) - Constructor for exception javax.portlet.PortletSecurityException
Constructs a new portlet security exception when the portlet needs to throw an exception.
PortletSerializable - Interface in javax.portlet.annotations
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 - Interface in javax.portlet
The PortletSession interface provides a way to identify a user across more than one request and to store transient information about that user.
PortletSessionScoped - Annotation Type in javax.portlet.annotations
Provides a CDI custom scope that is scoped to the portlet session rather than to the servlet session.
PortletSessionUtil - Class in javax.portlet
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.
PortletSessionUtil() - Constructor for class javax.portlet.PortletSessionUtil
 
PortletSessionWrapper - Class in javax.portlet.filter
The PortletSessionWrapper provides a convenient implementation of the PortletSession interface that can be subclassed by developers.
PortletSessionWrapper(PortletSession) - Constructor for class javax.portlet.filter.PortletSessionWrapper
 
PortletURL - Interface in javax.portlet
The PortletURL interface represents a URL that reference the portlet itself.
PortletURLGenerationListener<T extends PortletURL & RenderURL,U extends PortletURL & ActionURL> - Interface in javax.portlet
Portlet applications can register portlet URL listeners in order to filter URLs before they get generated.
PortletURLWrapper - Class in javax.portlet.filter
The PortletURLWrapper provides a convenient implementation of the PortletURL interface that can be subclassed by developers.
PortletURLWrapper(PortletURL) - Constructor for class javax.portlet.filter.PortletURLWrapper
 
Preference - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a single portlet preference.
PreferencesValidator - Interface in javax.portlet
The PreferencesValidator allows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.
PRIVATE_SCOPE - Static variable in interface javax.portlet.MimeResponse
Private cache scope, indicating that the cache entry must not be shared across users.
processAction(ActionRequest, ActionResponse) - Method in class javax.portlet.GenericPortlet
Called by the portlet container to allow the portlet to process an action request.
processAction(ActionRequest, ActionResponse) - Method in interface javax.portlet.Portlet
Called by the portlet container to allow the portlet to process an action request.
ProcessAction - Annotation Type in javax.portlet
Annotation for marking a method for processing a specific action.
processEvent(EventRequest, EventResponse) - Method in interface javax.portlet.EventPortlet
Called by the portlet container requesting the portlet to process a specific event.
processEvent(EventRequest, EventResponse) - Method in class javax.portlet.GenericPortlet
The default implementation tries to dispatch to a method annotated with @ProcessEvent that matches the event name or, if no such method is found just sets the current render parameters on the response.
Note that the annotated methods needs to be public in order to be allowed to be called by GenericPortlet.
ProcessEvent - Annotation Type in javax.portlet
Annotation for marking a method for handling a specific event.
PUBLIC_SCOPE - Static variable in interface javax.portlet.MimeResponse
Public cache scope, indicating that the cache entry can be shared across users.
PublicRenderParameterDefinition - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a single public render parameter.

R

ReadOnlyException - Exception in javax.portlet
The ReadOnlyException is thrown when a portlet tries to change the value for a read-only preference attribute.
ReadOnlyException(String) - Constructor for exception javax.portlet.ReadOnlyException
Constructs a new read-only exception with the given text.
ReadOnlyException(String, Throwable) - Constructor for exception javax.portlet.ReadOnlyException
Constructs a new read-only exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message
ReadOnlyException(Throwable) - Constructor for exception javax.portlet.ReadOnlyException
Constructs a new read-only exception when the portlet needs to throw an exception.
removeAttribute(String) - Method in class javax.portlet.filter.PortletContextWrapper
 
removeAttribute(String) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call removeAttribute(name) on the wrapped request object.
removeAttribute(String) - Method in class javax.portlet.filter.PortletSessionWrapper
 
removeAttribute(String, int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
removeAttribute(String) - Method in interface javax.portlet.PortletContext
Removes the attribute with the given name from the portlet context.
removeAttribute(String) - Method in interface javax.portlet.PortletRequest
Removes an attribute from this request.
removeAttribute(String) - Method in interface javax.portlet.PortletSession
Removes the object bound with the specified name under the PORTLET_SCOPE from this session.
removeAttribute(String, int) - Method in interface javax.portlet.PortletSession
Removes the object bound with the specified name and the given scope from this session.
removeParameter(String) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
removeParameter(String) - Method in interface javax.portlet.MutablePortletParameters
Removes the given public or private parameter.
removePublicRenderParameter(String) - Method in class javax.portlet.filter.PortletURLWrapper
Deprecated.
removePublicRenderParameter(String) - Method in class javax.portlet.filter.StateAwareResponseWrapper
Deprecated.
removePublicRenderParameter(String) - Method in interface javax.portlet.PortletURL
Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
removePublicRenderParameter(String) - Method in interface javax.portlet.StateAwareResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
render(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
The default implementation of this method sets the headers using the doHeaders method, sets the title using the getTitle method and invokes the doDispatch method.
render(RenderRequest, RenderResponse) - Method in interface javax.portlet.Portlet
Called by the portlet container to allow the portlet to generate the content of the response based on its current state.
RENDER_HEADERS - Static variable in interface javax.portlet.PortletRequest
The RENDER_HEADERS is a possible value of the RENDER_PART request attribute and denotes that the portlet should set the intended headers and the portlet title of this render request.
RENDER_MARKUP - Static variable in interface javax.portlet.PortletRequest
The RENDER_MARKUP is a possible value of the RENDER_PART request attribute and denotes that the portlet should produce its markup for this render request.
RENDER_PART - Static variable in interface javax.portlet.PortletRequest
The RENDER_PART portlet request attribute is set by portals that are streaming based and therefore need to split the render phase into two parts: first the RENDER_HEADERS part where the portlet should only set the header related data and the portlet title, and second the RENDER_MARKUP part in which the portlet should produce its markup.
RENDER_PHASE - Static variable in interface javax.portlet.PortletRequest
String identifier for the portlet render lifecycle phase.
RenderFilter - Interface in javax.portlet.filter
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.
renderHeaders(HeaderRequest, HeaderResponse) - Method in class javax.portlet.GenericPortlet
V3 method implementing the headers stage within the render phase.
renderHeaders(HeaderRequest, HeaderResponse) - Method in interface javax.portlet.HeaderPortlet
Called by the portlet container to allow the portlet to set response headers and generate markup for overall response document head section.
RenderMethod - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API render method.
RenderMode - Annotation Type in javax.portlet
Annotation for marking a method for handling a specific portlet mode in the render phase.
RenderParameters - Interface in javax.portlet
Provides access to render parameters, which make up part of the render state.
RenderParametersWrapper - Class in javax.portlet.filter
The RenderParametersWrapper provides a convenient implementation of the RenderParameters interface that can be subclassed by developers.
RenderParametersWrapper(RenderParameters) - Constructor for class javax.portlet.filter.RenderParametersWrapper
 
RenderRequest - Interface in javax.portlet
The RenderRequest represents the request sent to the portlet to handle a render.
RenderRequestWrapper - Class in javax.portlet.filter
The RenderRequestWrapper provides a convenient implementation of the RenderRequest interface that can be subclassed by developers.
RenderRequestWrapper(RenderRequest) - Constructor for class javax.portlet.filter.RenderRequestWrapper
Creates an RenderRequest adaptor wrapping the given request object.
RenderResponse - Interface in javax.portlet
The RenderResponse defines an object to assist a portlet in sending a response to the portal.
RenderResponseWrapper - Class in javax.portlet.filter
The RenderResponseWrapper provides a convenient implementation of the RenderResponse interface that can be subclassed by developers.
RenderResponseWrapper(RenderResponse) - Constructor for class javax.portlet.filter.RenderResponseWrapper
Creates an RenderResponse adaptor wrapping the given response object.
RenderState - Interface in javax.portlet
Provides read-only access to the render state.
RenderStateScoped - Annotation Type in javax.portlet.annotations
Provides a CDI custom scope that is scoped to the render state.
RenderStateWrapper - Class in javax.portlet.filter
The RenderStateWrapper provides a convenient implementation of the RenderState interface that can be subclassed by developers.
RenderStateWrapper(RenderState) - Constructor for class javax.portlet.filter.RenderStateWrapper
 
RenderURL - Interface in javax.portlet
This is a marker interface for a render URL.
RenderURLWrapper - Class in javax.portlet.filter
The RenderURLWrapper provides a convenient implementation of the RenderURL interface that can be subclassed by developers.
RenderURLWrapper(RenderURL) - Constructor for class javax.portlet.filter.RenderURLWrapper
 
reset() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call reset() on the wrapped response object.
reset() - Method in interface javax.portlet.MimeResponse
Clears any data that exists in the buffer as well as the properties set.
reset(String) - Method in interface javax.portlet.PortletPreferences
Resets or removes the value associated with the specified key.
resetBuffer() - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call resetBuffer() on the wrapped response object.
resetBuffer() - Method in interface javax.portlet.MimeResponse
Clears the content of the underlying buffer in the response without clearing properties set.
RESOURCE_PHASE - Static variable in interface javax.portlet.PortletRequest
String identifier for the portlet resource serving lifecycle phase.
ResourceFilter - Interface in javax.portlet.filter
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 - Interface in javax.portlet
Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
ResourceParametersWrapper - Class in javax.portlet.filter
The ResourceParametersWrapper provides a convenient implementation of the ResourceParameters interface that can be subclassed by developers.
ResourceParametersWrapper(ResourceParameters) - Constructor for class javax.portlet.filter.ResourceParametersWrapper
 
ResourceRequest - Interface in javax.portlet
The ResourceRequest interface represents the request send to the portlet for rendering resources.
ResourceRequestWrapper - Class in javax.portlet.filter
The ResourceRequestWrapper provides a convenient implementation of the ResourceRequest interface that can be subclassed by developers.
ResourceRequestWrapper(ResourceRequest) - Constructor for class javax.portlet.filter.ResourceRequestWrapper
Creates an ResourceRequest adaptor wrapping the given request object.
ResourceResponse - Interface in javax.portlet
The ResourceResponse defines an object to assist a portlet for rendering a resource.
ResourceResponseWrapper - Class in javax.portlet.filter
The ResourceResponseWrapper provides a convenient implementation of the ResourceResponse interface that can be subclassed by developers.
ResourceResponseWrapper(ResourceResponse) - Constructor for class javax.portlet.filter.ResourceResponseWrapper
Creates an ResourceResponse adaptor wrapping the given response object.
ResourceServingPortlet - Interface in javax.portlet
The ResourceServingPortlet interface allows serving resources through the portlet.
ResourceURL - Interface in javax.portlet
The ResourceURL defines a resource URL that when clicked will result in a serveResource call of the ResourceServingPortlet interface.
ResourceURLWrapper - Class in javax.portlet.filter
The ResourceURLWrapper provides a convenient implementation of the ResourceURL interface that can be subclassed by developers.
ResourceURLWrapper(ResourceURL) - Constructor for class javax.portlet.filter.ResourceURLWrapper
 
RuntimeOption - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent portlet container runtime option name-value pairs.

S

SecurityRoleRef - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a single security role reference.
sendRedirect(String) - Method in interface javax.portlet.ActionResponse
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.
sendRedirect(String, String) - Method in interface javax.portlet.ActionResponse
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL and encode a render URL as parameter on the redirect URL.
sendRedirect(String) - Method in class javax.portlet.filter.ActionResponseWrapper
The default behavior of this method is to call sendRedirect(location) on the wrapped response object.
sendRedirect(String, String) - Method in class javax.portlet.filter.ActionResponseWrapper
The default behavior of this method is to call sendRedirect(location, renderUrlParamName) on the wrapped response object.
serialize() - Method in interface javax.portlet.annotations.PortletSerializable
The portlet bean container calls this method after ActionMethod or EventMethod execution to obtain the bean state.
serveResource(ResourceRequest, ResourceResponse) - Method in class javax.portlet.GenericPortlet
Default resource serving.
serveResource(ResourceRequest, ResourceResponse) - Method in interface javax.portlet.ResourceServingPortlet
Called by the portlet container to allow the portlet to generate the resource content based on its current state.
ServeResourceMethod - Annotation Type in javax.portlet.annotations
Designates a method corresponding to the portlet API serveResource method.
set(PortletParameters) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
set(PortletParameters) - Method in interface javax.portlet.MutablePortletParameters
Makes the public and private parameters identical to those of the input PortletParameters object.
setAttribute(String, Object) - Method in class javax.portlet.filter.PortletContextWrapper
 
setAttribute(String, Object) - Method in class javax.portlet.filter.PortletRequestWrapper
The default behavior of this method is to call setAttribute(name, o) on the wrapped request object.
setAttribute(String, Object) - Method in class javax.portlet.filter.PortletSessionWrapper
 
setAttribute(String, Object, int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
setAttribute(String, Object) - Method in interface javax.portlet.PortletContext
Binds an object to a given attribute name in this portlet context.
setAttribute(String, Object) - Method in interface javax.portlet.PortletRequest
Stores an attribute in this request.
setAttribute(String, Object) - Method in interface javax.portlet.PortletSession
Binds an object to this session under the PORTLET_SCOPE, using the name specified.
setAttribute(String, Object, int) - Method in interface javax.portlet.PortletSession
Binds an object to this session in the given scope, using the name specified.
setBeanParameter(PortletSerializable) - Method in class javax.portlet.filter.PortletURLWrapper
 
setBeanParameter(PortletSerializable) - Method in interface javax.portlet.PortletURL
Sets the value of a @RenderStateScoped bean on an action or render URL.
setBufferSize(int) - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call setBufferSize(size) on the wrapped response object.
setBufferSize(int) - Method in interface javax.portlet.MimeResponse
Sets the preferred buffer size for the body of the response.
setCacheability(String) - Method in class javax.portlet.filter.ResourceURLWrapper
 
setCacheability(String) - Method in interface javax.portlet.ResourceURL
Sets the cache level of this resource URL.
setCharacterEncoding(String) - Method in interface javax.portlet.ClientDataRequest
Overrides the name of the character encoding used in the body of this request.
setCharacterEncoding(String) - Method in class javax.portlet.filter.ClientDataRequestWrapper
 
setCharacterEncoding(String) - Method in class javax.portlet.filter.ResourceResponseWrapper
The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
setCharacterEncoding(String) - Method in interface javax.portlet.ResourceResponse
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
setContentLength(int) - Method in class javax.portlet.filter.ResourceResponseWrapper
The default behavior of this method is to call setContentLength() on the wrapped response object.
setContentLength(int) - Method in interface javax.portlet.ResourceResponse
Sets the length of the content body in the response.
setContentLengthLong(long) - Method in class javax.portlet.filter.ResourceResponseWrapper
 
setContentLengthLong(long) - Method in interface javax.portlet.ResourceResponse
Sets the length of the content body in the response.
setContentType(String) - Method in class javax.portlet.filter.MimeResponseWrapper
The default behavior of this method is to call setContentType(type) on the wrapped response object.
setContentType(String) - Method in interface javax.portlet.HeaderResponse
Sets the MIME type for the header response.
setContentType(String) - Method in interface javax.portlet.MimeResponse
Sets the MIME type for the response.
setContentType(String) - Method in interface javax.portlet.RenderResponse
Sets the MIME type for the render response.
setETag(String) - Method in interface javax.portlet.CacheControl
Sets an ETag for the current response that is used as validation tag.
setEvent(QName, Serializable) - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
setEvent(String, Serializable) - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
setEvent(QName, Serializable) - Method in interface javax.portlet.StateAwareResponse
Publishes an Event with the given payload.
setEvent(String, Serializable) - Method in interface javax.portlet.StateAwareResponse
Publishes an Event with the given payload in the default namespace.
setExpirationTime(int) - Method in interface javax.portlet.CacheControl
Sets a new expiration time for the current response in seconds.
setFragmentIdentifier(String) - Method in class javax.portlet.filter.RenderURLWrapper
 
setFragmentIdentifier(String) - Method in interface javax.portlet.RenderURL
Sets a fragment identifier on the URL.
setLocale(Locale) - Method in class javax.portlet.filter.ResourceResponseWrapper
The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
setLocale(Locale) - Method in interface javax.portlet.ResourceResponse
Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
setMaxInactiveInterval(int) - Method in class javax.portlet.filter.PortletSessionWrapper
 
setMaxInactiveInterval(int) - Method in interface javax.portlet.PortletSession
Specifies the time, in seconds, between client requests, before the portlet container invalidates this session.
setNextPossiblePortletModes(Collection<? extends PortletMode>) - Method in class javax.portlet.filter.RenderResponseWrapper
The default behavior of this method is to call setNextPossiblePortletModes() on the wrapped response object.
setNextPossiblePortletModes(Collection<? extends PortletMode>) - Method in interface javax.portlet.RenderResponse
This method allows the portlet to tell the portal the next possible portlet modes that the make sense from the portlet point of view.
setParameter(String, String) - Method in interface javax.portlet.BaseURL
setParameter(String, String...) - Method in interface javax.portlet.BaseURL
setParameter(String, String) - Method in class javax.portlet.filter.BaseURLWrapper
Deprecated.
setParameter(String, String...) - Method in class javax.portlet.filter.BaseURLWrapper
Deprecated.
setParameters(Map<String, String[]>) - Method in interface javax.portlet.BaseURL
setParameters(Map<String, String[]>) - Method in class javax.portlet.filter.BaseURLWrapper
Deprecated.
setPortletContext(PortletContext) - Method in class javax.portlet.filter.PortletContextWrapper
Sets the wrapped object.
setPortletMode(PortletMode) - Method in class javax.portlet.filter.MutableRenderStateWrapper
 
setPortletMode(PortletMode) - Method in class javax.portlet.filter.PortletURLWrapper
 
setPortletMode(PortletMode) - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
setPortletMode(PortletMode) - Method in interface javax.portlet.MutableRenderState
Sets the portlet mode of a portlet to the given portlet mode.
setProperty(String, String) - Method in interface javax.portlet.BaseURL
Sets a String property on the URL.
setProperty(String, String) - Method in class javax.portlet.filter.BaseURLWrapper
 
setProperty(String, String) - Method in class javax.portlet.filter.PortletResponseWrapper
The default behavior of this method is to call setProperty(key, value) on the wrapped response object.
setProperty(String, String) - Method in interface javax.portlet.PortletResponse
Sets a String property to be returned to the portal.
setPublicScope(boolean) - Method in interface javax.portlet.CacheControl
Sets the caching scope for the current response to public with true as publicScope and to private with false as publicScope.
setRenderParameter(String, String) - Method in class javax.portlet.filter.StateAwareResponseWrapper
Deprecated.
setRenderParameter(String, String...) - Method in class javax.portlet.filter.StateAwareResponseWrapper
Deprecated.
setRenderParameter(String, String) - Method in interface javax.portlet.StateAwareResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
setRenderParameter(String, String...) - Method in interface javax.portlet.StateAwareResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
setRenderParameters(EventRequest) - Method in interface javax.portlet.EventResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
setRenderParameters(EventRequest) - Method in class javax.portlet.filter.EventResponseWrapper
Deprecated.
setRenderParameters(Map<String, String[]>) - Method in class javax.portlet.filter.StateAwareResponseWrapper
Deprecated.
setRenderParameters(Map<String, String[]>) - Method in interface javax.portlet.StateAwareResponse
Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
setRequest(ActionRequest) - Method in class javax.portlet.filter.ActionRequestWrapper
Sets the request object being wrapped.
setRequest(ClientDataRequest) - Method in class javax.portlet.filter.ClientDataRequestWrapper
Sets the request object being wrapped.
setRequest(EventRequest) - Method in class javax.portlet.filter.EventRequestWrapper
Sets the request object being wrapped.
setRequest(HeaderRequest) - Method in class javax.portlet.filter.HeaderRequestWrapper
Sets the request object being wrapped.
setRequest(PortletRequest) - Method in class javax.portlet.filter.PortletRequestWrapper
Sets the request object being wrapped.
setRequest(RenderRequest) - Method in class javax.portlet.filter.RenderRequestWrapper
Sets the request object being wrapped.
setRequest(ResourceRequest) - Method in class javax.portlet.filter.ResourceRequestWrapper
Sets the request object being wrapped.
setResourceID(String) - Method in class javax.portlet.filter.ResourceURLWrapper
 
setResourceID(String) - Method in interface javax.portlet.ResourceURL
Allows setting a resource ID that can be retrieved when serving the resource through the ResourceRequest.getResourceID() method.
setResponse(ActionResponse) - Method in class javax.portlet.filter.ActionResponseWrapper
Sets the response object being wrapped.
setResponse(EventResponse) - Method in class javax.portlet.filter.EventResponseWrapper
Sets the response object being wrapped.
setResponse(HeaderResponse) - Method in class javax.portlet.filter.HeaderResponseWrapper
Sets the response object being wrapped.
setResponse(MimeResponse) - Method in class javax.portlet.filter.MimeResponseWrapper
Sets the response object being wrapped.
setResponse(PortletResponse) - Method in class javax.portlet.filter.PortletResponseWrapper
Sets the response object being wrapped.
setResponse(RenderResponse) - Method in class javax.portlet.filter.RenderResponseWrapper
Sets the response object being wrapped.
setResponse(ResourceResponse) - Method in class javax.portlet.filter.ResourceResponseWrapper
Sets the response object being wrapped.
setResponse(StateAwareResponse) - Method in class javax.portlet.filter.StateAwareResponseWrapper
Sets the response object being wrapped.
setSecure(boolean) - Method in interface javax.portlet.BaseURL
Indicates the security setting for this URL.
setSecure(boolean) - Method in class javax.portlet.filter.BaseURLWrapper
 
setStatus(int) - Method in class javax.portlet.filter.ResourceResponseWrapper
The default behavior of this method is to call setStatus() on the wrapped response object.
setStatus(int) - Method in interface javax.portlet.ResourceResponse
Sets the HTTP status code for this request.
setTimeout(long) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
setTimeout(long) - Method in interface javax.portlet.PortletAsyncContext
Sets the timeout (in milliseconds) for this PortletAsyncContext.
setTitle(String) - Method in class javax.portlet.filter.HeaderResponseWrapper
 
setTitle(String) - Method in class javax.portlet.filter.RenderResponseWrapper
Deprecated.
setTitle(String) - Method in interface javax.portlet.HeaderResponse
This method sets the title of the portlet.
setTitle(String) - Method in interface javax.portlet.RenderResponse
Deprecated.
setUseCachedContent(boolean) - Method in interface javax.portlet.CacheControl
Sets the indication whether the cached content for the provided ETag at the request is still valid or not.
setValue(String, String) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
setValue(String, String) - Method in interface javax.portlet.MutablePortletParameters
Sets a String parameter.
setValue(String, String) - Method in interface javax.portlet.PortletPreferences
Associates the specified String value with the specified key in this preference.
setValues(String, String...) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
 
setValues(String, String...) - Method in interface javax.portlet.MutablePortletParameters
Sets a multivalued String parameter.
setValues(String, String...) - Method in interface javax.portlet.PortletPreferences
Sets a multi-valued String preference for the specified key.
setWindowState(WindowState) - Method in class javax.portlet.filter.MutableRenderStateWrapper
 
setWindowState(WindowState) - Method in class javax.portlet.filter.PortletURLWrapper
 
setWindowState(WindowState) - Method in class javax.portlet.filter.StateAwareResponseWrapper
 
setWindowState(WindowState) - Method in interface javax.portlet.MutableRenderState
Sets the window state of a portlet to the given window state.
setWrapped(ActionParameters) - Method in class javax.portlet.filter.ActionParametersWrapper
Sets the wrapped object.
setWrapped(ActionURL) - Method in class javax.portlet.filter.ActionURLWrapper
Sets the wrapped object.
setWrapped(BaseURL) - Method in class javax.portlet.filter.BaseURLWrapper
Sets the wrapped object.
setWrapped(MutableActionParameters) - Method in class javax.portlet.filter.MutableActionParametersWrapper
Sets the wrapped object.
setWrapped(MutablePortletParameters) - Method in class javax.portlet.filter.MutablePortletParametersWrapper
Sets the wrapped object.
setWrapped(MutableRenderParameters) - Method in class javax.portlet.filter.MutableRenderParametersWrapper
Sets the wrapped object.
setWrapped(MutableRenderState) - Method in class javax.portlet.filter.MutableRenderStateWrapper
Sets the wrapped object.
setWrapped(MutableResourceParameters) - Method in class javax.portlet.filter.MutableResourceParametersWrapper
Sets the wrapped object.
setWrapped(PortalContext) - Method in class javax.portlet.filter.PortalContextWrapper
Sets the wrapped object.
setWrapped(PortletAsyncContext) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
setWrapped(PortletConfig) - Method in class javax.portlet.filter.PortletConfigWrapper
Sets the wrapped object.
setWrapped(PortletParameters) - Method in class javax.portlet.filter.PortletParametersWrapper
Sets the wrapped object.
setWrapped(PortletRequestDispatcher) - Method in class javax.portlet.filter.PortletRequestDispatcherWrapper
Sets the wrapped object.
setWrapped(PortletSession) - Method in class javax.portlet.filter.PortletSessionWrapper
Sets the wrapped object.
setWrapped(PortletURL) - Method in class javax.portlet.filter.PortletURLWrapper
Sets the wrapped object.
setWrapped(RenderParameters) - Method in class javax.portlet.filter.RenderParametersWrapper
Sets the wrapped object.
setWrapped(RenderState) - Method in class javax.portlet.filter.RenderStateWrapper
Sets the wrapped object.
setWrapped(RenderURL) - Method in class javax.portlet.filter.RenderURLWrapper
Sets the wrapped object.
setWrapped(ResourceParameters) - Method in class javax.portlet.filter.ResourceParametersWrapper
Sets the wrapped object.
setWrapped(ResourceURL) - Method in class javax.portlet.filter.ResourceURLWrapper
Sets the wrapped object.
SHARED - Static variable in interface javax.portlet.ResourceURL
Property that the portlet can set for resources with caching type FULL via the setProperty method on the ResourceURL.
size() - Method in class javax.portlet.filter.PortletParametersWrapper
 
size() - Method in interface javax.portlet.PortletParameters
Returns the number of parameters in this object.
start(Runnable) - Method in class javax.portlet.filter.PortletAsyncContextWrapper
 
start(Runnable) - Method in interface javax.portlet.PortletAsyncContext
Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable.
startPortletAsync() - Method in class javax.portlet.filter.ResourceRequestWrapper
 
startPortletAsync(ResourceRequest, ResourceResponse) - Method in class javax.portlet.filter.ResourceRequestWrapper
 
startPortletAsync() - Method in interface javax.portlet.ResourceRequest
Puts this request into asynchronous mode and initializes the AsyncContext object.
startPortletAsync(ResourceRequest, ResourceResponse) - Method in interface javax.portlet.ResourceRequest
Puts this request into asynchronous mode and initializes the AsyncContext object.
StateAwareResponse - Interface in javax.portlet
The StateAwareResponse represents a response that can modify render state information or send events.
StateAwareResponseWrapper - Class in javax.portlet.filter
The StateAwareResponseWrapper provides a convenient implementation of the StateAwareResponse interface that can be subclassed by developers.
StateAwareResponseWrapper(StateAwareResponse) - Constructor for class javax.portlet.filter.StateAwareResponseWrapper
 
store() - Method in interface javax.portlet.PortletPreferences
Commits all changes made to the preferences via the set methods in the persistent store.
Supports - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to specify the supported portlet modes and window states for a given content type.

T

toString() - Method in interface javax.portlet.BaseURL
Returns the portlet URL string representation to be embedded in the markup.
Note that the returned String may not be a valid URL, as it may be rewritten by the portal/portlet-container before returning the markup to the client.
toString() - Method in class javax.portlet.filter.BaseURLWrapper
 
toString() - Method in class javax.portlet.PortletMode
Returns a String representation of this portlet mode.
toString() - Method in enum javax.portlet.PortletRequest.P3PUserInfos
 
toString() - Method in class javax.portlet.WindowState
Returns a String representation of this window state.

U

UnavailableException - Exception in javax.portlet
The portlet should throw the UnavailableException when the portlet is either temporarily or permanently unavailable to handle requests.
UnavailableException(String) - Constructor for exception javax.portlet.UnavailableException
Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.
UnavailableException(String, int) - Constructor for exception javax.portlet.UnavailableException
Constructs a new exception with a descriptive message indicating that the portlet is temporarily unavailable and giving an estimate of how long it will be unavailable.
UNDEFINED - Static variable in class javax.portlet.PortletMode
The portlet mode UNDEFINED is returned by the getPortletMode method when the portlet mode is not available.
UNDEFINED - Static variable in class javax.portlet.WindowState
The window state UNDEFINED is returned by the getWindowState method when the window state is not available.
USE_CACHED_CONTENT - Static variable in interface javax.portlet.MimeResponse
Property to tell the portlet container to use the cached markup for the validation token provided in the request.
useCachedContent() - Method in interface javax.portlet.CacheControl
Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid.
USER_INFO - Static variable in interface javax.portlet.PortletRequest
Used to retrieve user information attributes with the getAttribute call.
UserAttribute - Annotation Type in javax.portlet.annotations
This annotation is used within composite portlet configuration annotations to represent a single user attribute.

V

validate(PortletPreferences) - Method in interface javax.portlet.PreferencesValidator
If the preferences values are successfully validated the call to this method must finish gracefully.
ValidatorException - Exception in javax.portlet
The ValidatorException is thrown by the validate method of a PreferencesValidator when the validation of a preference failed.
ValidatorException(String, Collection<String>) - Constructor for exception javax.portlet.ValidatorException
Constructs a new validator exception with the given text.
ValidatorException(String, Throwable, Collection<String>) - Constructor for exception javax.portlet.ValidatorException
Constructs a new portlet validator exception.
ValidatorException(Throwable, Collection<String>) - Constructor for exception javax.portlet.ValidatorException
Constructs a new portlet validator exception when the portlet needs to throw an exception.
valueOf(String) - Static method in enum javax.portlet.MimeResponse.Copy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.portlet.PortletRequest.P3PUserInfos
Returns the enum constant of this type with the specified name.
values() - Static method in enum javax.portlet.MimeResponse.Copy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.portlet.PortletRequest.P3PUserInfos
Returns an array containing the constants of this enum type, in the order they are declared.
VIEW - Static variable in class javax.portlet.PortletMode
The expected functionality for a portlet in VIEW portlet mode is to generate markup reflecting the current state of the portlet.

W

WindowId - Annotation Type in javax.portlet.annotations
Qualifier that specifies the window ID for injection.
WindowState - Class in javax.portlet
The WindowState class represents the possible window states that a portlet window can assume.
WindowState() - Constructor for class javax.portlet.WindowState
No-arg constructor to make object proxyable
WindowState(String) - Constructor for class javax.portlet.WindowState
Creates a new window state with the given name.
WindowStateException - Exception in javax.portlet
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.
WindowStateException(String, WindowState) - Constructor for exception javax.portlet.WindowStateException
Constructs a new window state exception with the given text.
WindowStateException(String, Throwable, WindowState) - Constructor for exception javax.portlet.WindowStateException
Constructs a new window state exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message
WindowStateException(Throwable, WindowState) - Constructor for exception javax.portlet.WindowStateException
Constructs a new window state exception when the portlet needs to throw an exception.
wrapped - Variable in class javax.portlet.filter.PortalContextWrapper
 
wrapped - Variable in class javax.portlet.filter.PortletConfigWrapper
 
wrapped - Variable in class javax.portlet.filter.PortletContextWrapper
 
wrapped - Variable in class javax.portlet.filter.PortletParametersWrapper
 
wrapped - Variable in class javax.portlet.filter.PortletRequestDispatcherWrapper
 
wrapped - Variable in class javax.portlet.filter.PortletSessionWrapper
 
wrapped - Variable in class javax.portlet.filter.RenderStateWrapper
 
write(Writer) - Method in interface javax.portlet.BaseURL
Writes the portlet URL to the output stream using the provided writer.
write(Writer, boolean) - Method in interface javax.portlet.BaseURL
Writes the portlet URL to the output stream using the provided writer.
write(Writer) - Method in class javax.portlet.filter.BaseURLWrapper
 
write(Writer, boolean) - Method in class javax.portlet.filter.BaseURLWrapper
 
A B C D E F G H I J L M N O P R S T U V W 

Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.