Index (Portlet 4.0 API Specification)

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

A

ACTION_NAME - Static variable in interface jakarta.portlet.ActionRequest: Predefined action name for usage with the @ProcessAction annotation.
ACTION_PHASE - Static variable in interface jakarta.portlet.PortletRequest: String identifier for the portlet action lifecycle phase.
ACTION_SCOPE_ID - Static variable in interface jakarta.portlet.PortletRequest: The action scope ID that the portlet container uses for storing the current action scope as render parameter if the jakarta.portlet.actionScopedRequestAttributes container runtime option is used by the portlet.
ActionFilter - Interface in jakarta.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 jakarta.portlet.annotations: Designates a method corresponding to the portlet API processAction method.
actionName() - Method in annotation type jakarta.portlet.annotations.ActionMethod: The action name.
ActionParameters - Interface in jakarta.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 jakarta.portlet.filter: The ActionParametersWrapper provides a convenient implementation of the ActionParameters interface that can be subclassed by developers.
ActionParametersWrapper(ActionParameters) - Constructor for class jakarta.portlet.filter.ActionParametersWrapper
ActionRequest - Interface in jakarta.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 jakarta.portlet.filter: The ActionRequestWrapper provides a convenient implementation of the ActionRequest interface that can be subclassed by developers.
ActionRequestWrapper(ActionRequest) - Constructor for class jakarta.portlet.filter.ActionRequestWrapper: Creates an ActionRequest adaptor wrapping the given request object.
ActionResponse - Interface in jakarta.portlet: The ActionResponse interface represents the portlet response to an action request.
ActionResponseWrapper - Class in jakarta.portlet.filter: The ActionResponseWrapper provides a convenient implementation of the ActionResponse interface that can be subclassed by developers.
ActionResponseWrapper(ActionResponse) - Constructor for class jakarta.portlet.filter.ActionResponseWrapper: Creates an ActionResponse adaptor wrapping the given response object.
ActionURL - Interface in jakarta.portlet: An action URL is created with MimeResponse.createActionURL().
ActionURLWrapper - Class in jakarta.portlet.filter: The ActionURLWrapper provides a convenient implementation of the ActionURL interface that can be subclassed by developers.
ActionURLWrapper(ActionURL) - Constructor for class jakarta.portlet.filter.ActionURLWrapper
add(PortletParameters) - Method in class jakarta.portlet.filter.MutablePortletParametersWrapper
add(PortletParameters) - Method in interface jakarta.portlet.MutablePortletParameters: Adds the parameters from the input PortletParameters object if they are not already present.
addDependency(String, String, String) - Method in class jakarta.portlet.filter.HeaderResponseWrapper
addDependency(String, String, String) - Method in interface jakarta.portlet.HeaderResponse: Adds a dependency on a page-level resource that is managed by the portal.
addDependency(String, String, String, String) - Method in class jakarta.portlet.filter.HeaderResponseWrapper
addDependency(String, String, String, String) - Method in interface jakarta.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 jakarta.portlet.filter.PortletAsyncContextWrapper
addListener(PortletAsyncListener) - Method in interface jakarta.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 class jakarta.portlet.filter.PortletAsyncContextWrapper
addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) - Method in interface jakarta.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(Cookie) - Method in class jakarta.portlet.filter.PortletResponseWrapper
addProperty(Cookie) - Method in interface jakarta.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, String) - Method in interface jakarta.portlet.BaseURL: Adds a String property to an existing key on the URL.
addProperty(String, String) - Method in class jakarta.portlet.filter.BaseURLWrapper
addProperty(String, String) - Method in class jakarta.portlet.filter.PortletResponseWrapper
addProperty(String, String) - Method in interface jakarta.portlet.PortletResponse: Adds a String property to an existing key to be returned to the portal.
addProperty(String, Element) - Method in class jakarta.portlet.filter.PortletResponseWrapper
addProperty(String, Element) - Method in interface jakarta.portlet.PortletResponse: Adds an XML DOM element property to the response.
alias() - Method in annotation type jakarta.portlet.annotations.EventDefinition: The qualified name aliases for this event.
ALL - jakarta.portlet.MimeResponse.Copy: Specifies that the public and private render parameters set for the current request are be copied to the URL when it is created.
append(Appendable) - Method in interface jakarta.portlet.BaseURL: Appends the portlet URL to the appendable object.
append(Appendable) - Method in class jakarta.portlet.filter.BaseURLWrapper
append(Appendable, boolean) - Method in interface jakarta.portlet.BaseURL: Appends the portlet URL to the appendable object.
append(Appendable, boolean) - Method in class jakarta.portlet.filter.BaseURLWrapper
APPLICATION_SCOPE - Static variable in interface jakarta.portlet.PortletSession: This constant defines an application wide scope for the session attribute.
asyncSupported() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: Declares whether the portlet supports asynchronous operation mode.
asyncSupported() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: Declares whether the serve resource method supports asynchronous operation mode.
AUTOMATIC_RESOURCE_DISPATCH - Static variable in class jakarta.portlet.GenericPortlet: This property is set by the container if the container has a cached response for the given validation tag.

B

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

C

CACHE_SCOPE - Static variable in interface jakarta.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 jakarta.portlet: The CacheControl interface represents cache settings for a piece of markup.
cacheExpirationTime() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: Expiration-time defines the time in seconds after which the portlet output expires.
cacheScopePublic() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The cache scope, which defines whether generated portlet content is private for the user or can be shared across different users.
CCPP_PROFILE - Static variable in interface jakarta.portlet.PortletRequest: Used to retrieve an instance of the javax.ccpp.Profile with the getAttribute call.
characterEncoding() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: Sets the character encoding for content generated by the annotated method.
clear() - Method in class jakarta.portlet.filter.MutablePortletParametersWrapper
clear() - Method in interface jakarta.portlet.MutablePortletParameters: Clears all parameters.
clearPrivate() - Method in class jakarta.portlet.filter.MutableRenderParametersWrapper
clearPrivate() - Method in interface jakarta.portlet.MutableRenderParameters: Clears all private parameters that are present in the MutableRenderParameters object.
clearPublic() - Method in class jakarta.portlet.filter.MutableRenderParametersWrapper
clearPublic() - Method in interface jakarta.portlet.MutableRenderParameters: Clears all public parameters that are present in the MutableRenderParameters object.
CLIENT_CERT_AUTH - Static variable in interface jakarta.portlet.PortletRequest: String identifier for Certification based authentication.
ClientDataRequest - Interface in jakarta.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 jakarta.portlet.filter: The ClientDataRequestWrapper provides a convenient implementation of the ClientDataRequest interface that can be subclassed by developers.
ClientDataRequestWrapper(ClientDataRequest) - Constructor for class jakarta.portlet.filter.ClientDataRequestWrapper
clone() - Method in interface jakarta.portlet.ActionParameters: Returns a MutableActionParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in class jakarta.portlet.filter.ActionParametersWrapper
clone() - Method in class jakarta.portlet.filter.MutableActionParametersWrapper
clone() - Method in class jakarta.portlet.filter.MutableRenderParametersWrapper
clone() - Method in class jakarta.portlet.filter.MutableResourceParametersWrapper
clone() - Method in class jakarta.portlet.filter.PortletParametersWrapper
clone() - Method in class jakarta.portlet.filter.RenderParametersWrapper
clone() - Method in class jakarta.portlet.filter.ResourceParametersWrapper
clone() - Method in interface jakarta.portlet.PortletParameters: Returns a MutablePortletParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in interface jakarta.portlet.RenderParameters: Returns a MutableRenderParameters object encapsulating a copy of the same parameters as the original object.
clone() - Method in interface jakarta.portlet.ResourceParameters: Returns a MutableResourceParameters object encapsulating a copy of the same parameters as the original object.
complete() - Method in class jakarta.portlet.filter.PortletAsyncContextWrapper
complete() - Method in interface jakarta.portlet.PortletAsyncContext: Completes the PortletAsynchronous operation and closes the response associated with this PortletAsyncContext object.
contentType() - Method in annotation type jakarta.portlet.annotations.HeaderMethod: Sets the content type, or the MIME type, of content generated by the method.
contentType() - Method in annotation type jakarta.portlet.annotations.RenderMethod: Sets the content type, or the MIME type, of content generated by the method.
contentType() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: Sets the content type, or the MIME type, of content generated by the method.
ContextPath - Annotation Type in jakarta.portlet.annotations: Qualifier that specifies the context root for injection.
createActionURL() - Method in class jakarta.portlet.filter.MimeResponseWrapper
createActionURL() - Method in interface jakarta.portlet.MimeResponse: Creates an action URL targeting the portlet.
createActionURL() - Method in interface jakarta.portlet.ResourceResponse
createActionURL(MimeResponse.Copy) - Method in class jakarta.portlet.filter.MimeResponseWrapper
createActionURL(MimeResponse.Copy) - Method in interface jakarta.portlet.MimeResponse: Creates an action URL targeting the portlet.
createActionURL(MimeResponse.Copy) - Method in interface jakarta.portlet.ResourceResponse
createElement(String) - Method in class jakarta.portlet.filter.PortletResponseWrapper
createElement(String) - Method in interface jakarta.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 jakarta.portlet.filter.PortletAsyncContextWrapper
createPortletAsyncListener(Class<T>) - Method in interface jakarta.portlet.PortletAsyncContext: Instantiates the given PortletAsyncListener class.
createRedirectURL(MimeResponse.Copy) - Method in interface jakarta.portlet.ActionResponse: Returns a render URL containing render parameters according to the MimeResponse.Copy argument.
createRedirectURL(MimeResponse.Copy) - Method in class jakarta.portlet.filter.ActionResponseWrapper
createRenderURL() - Method in class jakarta.portlet.filter.MimeResponseWrapper
createRenderURL() - Method in interface jakarta.portlet.MimeResponse: Creates a render URL targeting the portlet.
createRenderURL() - Method in interface jakarta.portlet.ResourceResponse
createRenderURL(MimeResponse.Copy) - Method in class jakarta.portlet.filter.MimeResponseWrapper
createRenderURL(MimeResponse.Copy) - Method in interface jakarta.portlet.MimeResponse: Creates a render URL targeting the portlet.
createRenderURL(MimeResponse.Copy) - Method in interface jakarta.portlet.ResourceResponse
createResourceURL() - Method in class jakarta.portlet.filter.MimeResponseWrapper
createResourceURL() - Method in interface jakarta.portlet.MimeResponse: Creates a resource URL targeting the portlet.
createResourceURL() - Method in interface jakarta.portlet.ResourceResponse
CustomPortletMode - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a custom portlet mode.
customPortletModes() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The custom portlet modes defined for this portlet.
CustomWindowState - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a custom window state.
customWindowStates() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The custom window states defined for this portlet.

D

decodeAttributeName(String) - Static method in class jakarta.portlet.PortletSessionUtil: Returns the attribute name of an attribute in the PORTLET_SCOPE.
decodeScope(String) - Static method in class jakarta.portlet.PortletSessionUtil: Returns the portlet attribute scope from an encoded portlet attribute.
defaultNamespaceURI() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The default QName namespace URI.
dependencies() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The dependencies the portlet may have on external resources.
Dependency - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent dependencies the portlet may have on external resources.
description() - Method in annotation type jakarta.portlet.annotations.CustomPortletMode: Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.CustomWindowState: Provides locale-specific text describing the custom window state for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.EventDefinition: Provides locale-specific text describing the event for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.InitParameter: Provides locale-specific text describing the initialization parameter for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The portlet description.
description() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The portlet filter description providing locale-specific text describing the portlet filter for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.PortletListener: The portlet listener description providing locale-specific text describing the portlet listener for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.PublicRenderParameterDefinition: Provides locale-specific text describing the public render parameter for use by the portal application or by tools.
description() - Method in annotation type jakarta.portlet.annotations.SecurityRoleRef: The security role ref description.
description() - Method in annotation type jakarta.portlet.annotations.UserAttribute: Provides locale-specific text describing the user attribute for use by the portal application or by tools.
deserialize(String[]) - Method in interface jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.annotations: Designates a method corresponding to the portlet API destroy method.
DIGEST_AUTH - Static variable in interface jakarta.portlet.PortletRequest: String identifier for Digest based authentication.
dispatch() - Method in class jakarta.portlet.filter.PortletAsyncContextWrapper
dispatch() - Method in interface jakarta.portlet.PortletAsyncContext: Dispatches the request and response objects of this PortletAsyncContext to the portlet container.
dispatch(String) - Method in class jakarta.portlet.filter.PortletAsyncContextWrapper
dispatch(String) - Method in interface jakarta.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 jakarta.portlet.GenericPortlet: Dispatches an action request to an annotated action method.
dispatchAnnotatedEventMethod(String, EventRequest, EventResponse) - Method in class jakarta.portlet.GenericPortlet: Dispatches an event request to an annotated event method.
dispatchAnnotatedRenderMethod(String, RenderRequest, RenderResponse) - Method in class jakarta.portlet.GenericPortlet: Dispatches an render request to an annotated render method.
displayName() - Method in annotation type jakarta.portlet.annotations.EventDefinition: The display-name type contains a locale-specific short name that is intended to be displayed by tools.
displayName() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The display-name type contains a locale-specific short name that is intended to be displayed by tools.
displayName() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The display-name type contains a language-specific short name that is intended to be displayed by tools.
displayName() - Method in annotation type jakarta.portlet.annotations.PortletListener: The display-name type contains a language-specific short name that is intended to be displayed by tools.
displayName() - Method in annotation type jakarta.portlet.annotations.PublicRenderParameterDefinition: The display-name type contains a locale-specific short name that is intended to be displayed by tools.
doDispatch(RenderRequest, RenderResponse) - Method in class jakarta.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 jakarta.portlet.GenericPortlet: Helper method to serve up the edit mode.
doFilter(ActionRequest, ActionResponse) - Method in interface jakarta.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(ActionRequest, ActionResponse, FilterChain) - Method in interface jakarta.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) - Method in interface jakarta.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, FilterChain) - Method in interface jakarta.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(HeaderRequest, HeaderResponse) - Method in interface jakarta.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(HeaderRequest, HeaderResponse, HeaderFilterChain) - Method in interface jakarta.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(RenderRequest, RenderResponse) - Method in interface jakarta.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, FilterChain) - Method in interface jakarta.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) - Method in interface jakarta.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, FilterChain) - Method in interface jakarta.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 jakarta.portlet.GenericPortlet: Used by the render method to set the response properties and headers.
doHelp(RenderRequest, RenderResponse) - Method in class jakarta.portlet.GenericPortlet: Helper method to serve up the help mode.
doView(RenderRequest, RenderResponse) - Method in class jakarta.portlet.GenericPortlet: Helper method to serve up the mandatory view mode.

E

EDIT - Static variable in class jakarta.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 jakarta.portlet.filter.PortletResponseWrapper
encodeURL(String) - Method in interface jakarta.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 jakarta.portlet.PortletMode: Compares the specified object with this portlet mode for equality.
equals(Object) - Method in class jakarta.portlet.WindowState: Compares the specified object with this window state for equality.
ETAG - Static variable in interface jakarta.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 jakarta.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 jakarta.portlet.ResourceRequest: This property is set by the container if the container has a cached response for the given validation tag.
Event - Interface in jakarta.portlet: The Event interface represents an event that the portlet has received in the event processing phase.
EVENT_PHASE - Static variable in interface jakarta.portlet.PortletRequest: String identifier for the portlet event lifecycle phase.
EventDefinition - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a single event.
EventFilter - Interface in jakarta.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 jakarta.portlet.annotations: Designates a method corresponding to the portlet API processEvent method.
EventPortlet - Interface in jakarta.portlet: The EventPortlet interface allows portlets receiving events.
EventRequest - Interface in jakarta.portlet: The EventRequest represents the request sent to the portlet to handle an event.
EventRequestWrapper - Class in jakarta.portlet.filter: The EventRequestWrapper provides a convenient implementation of the EventRequest interface that can be subclassed by developers.
EventRequestWrapper(EventRequest) - Constructor for class jakarta.portlet.filter.EventRequestWrapper: Creates an EventRequest adaptor wrapping the given request object.
EventResponse - Interface in jakarta.portlet: The EventResponse interface represents the portlet response to an event request.
EventResponseWrapper - Class in jakarta.portlet.filter: The EventResponseWrapper provides a convenient implementation of the EventResponse interface that can be subclassed by developers.
EventResponseWrapper(EventResponse) - Constructor for class jakarta.portlet.filter.EventResponseWrapper: Creates an EventResponse adaptor wrapping the given response object.
events() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The events defined for the portlet.
EXPIRATION_CACHE - Static variable in interface jakarta.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

fileSizeThreshold() - Method in annotation type jakarta.portlet.annotations.Multipart: The size threshold after which the file will be written to disk.
filterActionURL(U) - Method in interface jakarta.portlet.PortletURLGenerationListener: Callback being called by the portlet container before toString or write are executed on action URLs.
FilterChain - Interface in jakarta.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 jakarta.portlet.filter: A filter configuration object used by a portlet container to pass information to a filter during initialization.
filterName() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The filter name.
filterRenderURL(T) - Method in interface jakarta.portlet.PortletURLGenerationListener: Callback being called by the portlet container before toString or write are executed on render URLs.
filterResourceURL(ResourceURL) - Method in interface jakarta.portlet.PortletURLGenerationListener: Callback being called by the portlet container before toString or write are executed on resource URLs.
flushBuffer() - Method in class jakarta.portlet.filter.MimeResponseWrapper
flushBuffer() - Method in interface jakarta.portlet.MimeResponse: Forces any content in the buffer to be written to the underlying output stream.
FORM_AUTH - Static variable in interface jakarta.portlet.PortletRequest: String identifier for Form based authentication.
forward(PortletRequest, PortletResponse) - Method in class jakarta.portlet.filter.PortletRequestDispatcherWrapper
forward(PortletRequest, PortletResponse) - Method in interface jakarta.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 jakarta.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 jakarta.portlet: The GenericPortlet class provides a default implementation for the Portlet interface.
GenericPortlet() - Constructor for class jakarta.portlet.GenericPortlet: Does nothing.
getActionParameters() - Method in interface jakarta.portlet.ActionRequest: Gets the action parameters set for this request.
getActionParameters() - Method in interface jakarta.portlet.ActionURL: Gets the action parameter values set for this URL.
getActionParameters() - Method in class jakarta.portlet.filter.ActionRequestWrapper
getActionParameters() - Method in class jakarta.portlet.filter.ActionURLWrapper
getAttribute(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getAttribute(String) - Method in class jakarta.portlet.filter.PortletRequestWrapper
getAttribute(String) - Method in class jakarta.portlet.filter.PortletSessionWrapper
getAttribute(String) - Method in interface jakarta.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 jakarta.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 jakarta.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 class jakarta.portlet.filter.PortletSessionWrapper
getAttribute(String, int) - Method in interface jakarta.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 jakarta.portlet.filter.PortletSessionWrapper
getAttributeMap() - Method in interface jakarta.portlet.PortletSession: Returns a Map of the session attributes in the portlet session scope.
getAttributeMap(int) - Method in class jakarta.portlet.filter.PortletSessionWrapper
getAttributeMap(int) - Method in interface jakarta.portlet.PortletSession: Returns a Map of the session attributes in the given session scope.
getAttributeNames() - Method in class jakarta.portlet.filter.PortletContextWrapper
getAttributeNames() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getAttributeNames() - Method in class jakarta.portlet.filter.PortletSessionWrapper
getAttributeNames() - Method in interface jakarta.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 jakarta.portlet.PortletRequest: Returns an Enumeration containing the names of the attributes available to this request.
getAttributeNames() - Method in interface jakarta.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 class jakarta.portlet.filter.PortletSessionWrapper
getAttributeNames(int) - Method in interface jakarta.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 jakarta.portlet.filter.PortletRequestWrapper
getAuthType() - Method in interface jakarta.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 jakarta.portlet.filter.MimeResponseWrapper
getBufferSize() - Method in interface jakarta.portlet.MimeResponse: Returns the actual buffer size used for the response.
getCacheability() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
getCacheability() - Method in class jakarta.portlet.filter.ResourceURLWrapper
getCacheability() - Method in interface jakarta.portlet.ResourceRequest: Returns the cache level of this resource request.
getCacheability() - Method in interface jakarta.portlet.ResourceURL: Returns the cache level of this resource URL.
getCacheControl() - Method in class jakarta.portlet.filter.MimeResponseWrapper
getCacheControl() - Method in interface jakarta.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 jakarta.portlet.ClientDataRequest: Returns the name of the character encoding used in the body of this request.
getCharacterEncoding() - Method in class jakarta.portlet.filter.ClientDataRequestWrapper
getCharacterEncoding() - Method in class jakarta.portlet.filter.MimeResponseWrapper
getCharacterEncoding() - Method in interface jakarta.portlet.MimeResponse: Returns the name of the charset used for the MIME body sent in this response.
getClassLoader() - Method in class jakarta.portlet.filter.PortletContextWrapper
getClassLoader() - Method in interface jakarta.portlet.PortletContext: Returns the class loader for this portlet context.
getContainerRuntimeOptions() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getContainerRuntimeOptions() - Method in class jakarta.portlet.filter.PortletContextWrapper
getContainerRuntimeOptions() - Method in class jakarta.portlet.GenericPortlet
getContainerRuntimeOptions() - Method in interface jakarta.portlet.PortletConfig: Returns the container runtime options and values for this portlet.
getContainerRuntimeOptions() - Method in interface jakarta.portlet.PortletContext: Returns the container container runtime options keys supported by this portlet container.
getContentLength() - Method in interface jakarta.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 jakarta.portlet.filter.ClientDataRequestWrapper
getContentLengthLong() - Method in interface jakarta.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 jakarta.portlet.filter.ClientDataRequestWrapper
getContentType() - Method in interface jakarta.portlet.ClientDataRequest: Returns the MIME type of the body of the request, or null if the type is not known.
getContentType() - Method in class jakarta.portlet.filter.ClientDataRequestWrapper
getContentType() - Method in class jakarta.portlet.filter.MimeResponseWrapper
getContentType() - Method in interface jakarta.portlet.MimeResponse: Returns the MIME type that can be used to contribute markup to the render response.
getContextPath() - Method in class jakarta.portlet.filter.PortletContextWrapper
getContextPath() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getContextPath() - Method in interface jakarta.portlet.PortletContext: Returns the context path for this portlet application.
getContextPath() - Method in interface jakarta.portlet.PortletRequest: Returns the context path which is the path prefix associated with the deployed portlet application.
getCookies() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getCookies() - Method in interface jakarta.portlet.PortletRequest: Returns an array containing all of the Cookie properties.
getCreationTime() - Method in class jakarta.portlet.filter.PortletSessionWrapper
getCreationTime() - Method in interface jakarta.portlet.PortletSession: Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getDefaultNamespace() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getDefaultNamespace() - Method in class jakarta.portlet.GenericPortlet: Returns the default namespace for events and public parameters.
getDefaultNamespace() - Method in interface jakarta.portlet.PortletConfig: Returns the default namespace for events and public render parameters.
getDispatcherType() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
getDispatcherType() - Method in interface jakarta.portlet.ResourceRequest: Gets the dispatcher type of this request.
getEffectiveMajorVersion() - Method in class jakarta.portlet.filter.PortletContextWrapper
getEffectiveMajorVersion() - Method in interface jakarta.portlet.PortletContext: Returns the major version of the Portlet API used by the portlet application running in this PortletContext.
getEffectiveMinorVersion() - Method in class jakarta.portlet.filter.PortletContextWrapper
getEffectiveMinorVersion() - Method in interface jakarta.portlet.PortletContext: Returns the minor version of the Portlet API used by the portlet application running in this PortletContext.
getETag() - Method in interface jakarta.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 jakarta.portlet.filter.RenderRequestWrapper
getETag() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
getETag() - Method in interface jakarta.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 jakarta.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 jakarta.portlet.EventRequest: Returns the event that triggered the call to the processEvent method.
getEvent() - Method in class jakarta.portlet.filter.EventRequestWrapper
getExpirationTime() - Method in interface jakarta.portlet.CacheControl: Get the currently set expiration time.
getFailedKeys() - Method in exception jakarta.portlet.ValidatorException: Returns the keys that failed the validation.
getFilterName() - Method in interface jakarta.portlet.filter.FilterConfig: Returns the filter-name of this filter as defined in the portlet deployment descriptor.
getFragmentIdentifier() - Method in class jakarta.portlet.filter.RenderURLWrapper
getFragmentIdentifier() - Method in interface jakarta.portlet.RenderURL: Gets the fragment identifier previously set on the URL.
getId() - Method in class jakarta.portlet.filter.PortletSessionWrapper
getId() - Method in interface jakarta.portlet.PortletSession: Returns a string containing the unique identifier assigned to this session.
getInitParameter(String) - Method in interface jakarta.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 jakarta.portlet.filter.PortletConfigWrapper
getInitParameter(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getInitParameter(String) - Method in class jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.filter.PortletConfigWrapper
getInitParameterNames() - Method in class jakarta.portlet.filter.PortletContextWrapper
getInitParameterNames() - Method in class jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.filter.PortletSessionWrapper
getLastAccessedTime() - Method in interface jakarta.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 jakarta.portlet.filter.MimeResponseWrapper
getLocale() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getLocale() - Method in interface jakarta.portlet.MimeResponse: Returns the locale assigned to the response.
getLocale() - Method in interface jakarta.portlet.PortletRequest: Returns the preferred Locale in which the portal will accept content.
getLocales() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getLocales() - Method in interface jakarta.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 jakarta.portlet.filter.PortletContextWrapper
getMajorVersion() - Method in interface jakarta.portlet.PortletContext: Returns the major version of the Portlet API that this portlet container supports.
getMap() - Method in interface jakarta.portlet.PortletPreferences: Returns a Map of the preferences.
getMaxInactiveInterval() - Method in class jakarta.portlet.filter.PortletSessionWrapper
getMaxInactiveInterval() - Method in interface jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.filter.ClientDataRequestWrapper
getMethod() - Method in class jakarta.portlet.filter.EventRequestWrapper
getMimeType(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getMimeType(String) - Method in interface jakarta.portlet.PortletContext: Returns the MIME type of the specified file, or null if the MIME type is not known.
getMinorVersion() - Method in class jakarta.portlet.filter.PortletContextWrapper
getMinorVersion() - Method in interface jakarta.portlet.PortletContext: Returns the minor version of the Portlet API that this portlet container supports.
getMode() - Method in exception jakarta.portlet.PortletModeException: Returns the unsupported portlet mode causing this exception.
getName() - Method in interface jakarta.portlet.Event: Get the local part of the event name.
getNamedDispatcher(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getNamedDispatcher(String) - Method in interface jakarta.portlet.PortletContext: Returns a PortletRequestDispatcher object that acts as a wrapper for the named servlet.
getNames() - Method in class jakarta.portlet.filter.PortletParametersWrapper
getNames() - Method in interface jakarta.portlet.MutablePortletParameters: Returns a Set of String objects containing the names of the parameters contained in this object.
getNames() - Method in interface jakarta.portlet.PortletParameters: Returns a Set of String objects containing the names of the parameters contained in this object.
getNames() - Method in interface jakarta.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 jakarta.portlet.filter.PortletResponseWrapper
getNamespace() - Method in interface jakarta.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 jakarta.portlet.GenericPortlet: Used by the render method to set the next possible portlet modes.
getParameter(String) - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getParameter(String) - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterMap() - Method in interface jakarta.portlet.BaseURL: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters(), ResourceURL.getResourceParameters(), or ActionURL.getActionParameters() as required.
getParameterMap() - Method in class jakarta.portlet.filter.BaseURLWrapper: Deprecated.
getParameterMap() - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getParameterMap() - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterNames() - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getParameterNames() - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getParameterValues(String) - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getParameterValues(String) - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPart(String) - Method in interface jakarta.portlet.ClientDataRequest: Gets the Part with the given name.
getPart(String) - Method in class jakarta.portlet.filter.ClientDataRequestWrapper
getParts() - Method in interface jakarta.portlet.ClientDataRequest: Gets all the Part components of this request, provided that it is of type multipart/form-data.
getParts() - Method in class jakarta.portlet.filter.ClientDataRequestWrapper
getPortalContext() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getPortalContext() - Method in interface jakarta.portlet.PortletRequest: Returns the context of the calling portal.
getPortalInfo() - Method in class jakarta.portlet.filter.PortalContextWrapper
getPortalInfo() - Method in interface jakarta.portlet.PortalContext: Returns information about the portal like vendor, version, etc.
getPortletAsyncContext() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
getPortletAsyncContext() - Method in class jakarta.portlet.PortletAsyncEvent: Gets the portlet asynchronous context object associated with the event.
getPortletAsyncContext() - Method in interface jakarta.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 jakarta.portlet.GenericPortlet: Returns the PortletConfig object of this portlet.
getPortletContext() - Method in interface jakarta.portlet.filter.FilterConfig: Returns a reference to the PortletContext in which the caller is executing.
getPortletContext() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getPortletContext() - Method in class jakarta.portlet.filter.PortletContextWrapper: Gets the wrapped object.
getPortletContext() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getPortletContext() - Method in class jakarta.portlet.filter.PortletSessionWrapper
getPortletContext() - Method in class jakarta.portlet.GenericPortlet: Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface jakarta.portlet.PortletConfig: Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface jakarta.portlet.PortletRequest: Returns the PortletContext of the portlet application the portlet is in.
getPortletContext() - Method in interface jakarta.portlet.PortletSession: Returns the portlet application context associated with this session.
getPortletContextName() - Method in class jakarta.portlet.filter.PortletContextWrapper
getPortletContextName() - Method in interface jakarta.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 jakarta.portlet.ClientDataRequest: Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
getPortletInputStream() - Method in class jakarta.portlet.filter.ClientDataRequestWrapper
getPortletMode() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getPortletMode() - Method in class jakarta.portlet.filter.RenderStateWrapper
getPortletMode() - Method in class jakarta.portlet.filter.StateAwareResponseWrapper
getPortletMode() - Method in interface jakarta.portlet.RenderState: Returns the current portlet mode of the portlet.
getPortletMode() - Method in interface jakarta.portlet.ResourceRequest: Returns the current portlet mode of the portlet.
getPortletModes(String) - Method in class jakarta.portlet.filter.PortletConfigWrapper
getPortletModes(String) - Method in class jakarta.portlet.GenericPortlet: Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
getPortletModes(String) - Method in interface jakarta.portlet.PortletConfig: Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
getPortletName() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getPortletName() - Method in class jakarta.portlet.GenericPortlet: Returns the name of this portlet.
getPortletName() - Method in interface jakarta.portlet.PortletConfig: Returns the name of the portlet.
getPortletOutputStream() - Method in class jakarta.portlet.filter.MimeResponseWrapper
getPortletOutputStream() - Method in interface jakarta.portlet.HeaderResponse: Data written to the HeaderResponse output stream is added to the aggregated portal document HEAD section.
getPortletOutputStream() - Method in interface jakarta.portlet.MimeResponse: Returns a OutputStream suitable for writing binary data in the response.
getPortletSession() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getPortletSession() - Method in interface jakarta.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 class jakarta.portlet.filter.PortletRequestWrapper
getPortletSession(boolean) - Method in interface jakarta.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 jakarta.portlet.filter.PortletRequestWrapper
getPreferences() - Method in interface jakarta.portlet.PortletRequest: Returns the preferences object associated with the portlet.
getPrivateParameterMap() - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getPrivateParameterMap() - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPrivateRenderParameterMap() - Method in class jakarta.portlet.filter.ResourceRequestWrapper: Deprecated.
getPrivateRenderParameterMap() - Method in interface jakarta.portlet.ResourceRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getProcessingEventQNames() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getProcessingEventQNames() - Method in class jakarta.portlet.GenericPortlet
getProcessingEventQNames() - Method in interface jakarta.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 jakarta.portlet.filter.PortletRequestWrapper
getProperties(String) - Method in interface jakarta.portlet.PortletRequest: Returns all the values of the specified request property as a Enumeration of String objects.
getProperty(String) - Method in class jakarta.portlet.filter.PortalContextWrapper
getProperty(String) - Method in class jakarta.portlet.filter.PortletRequestWrapper
getProperty(String) - Method in class jakarta.portlet.filter.PortletResponseWrapper
getProperty(String) - Method in interface jakarta.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 jakarta.portlet.PortletRequest: Returns the value of the specified request property as a String.
getProperty(String) - Method in interface jakarta.portlet.PortletResponse: Gets the value of the response property with the given name.
getPropertyNames() - Method in class jakarta.portlet.filter.PortalContextWrapper
getPropertyNames() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getPropertyNames() - Method in class jakarta.portlet.filter.PortletResponseWrapper
getPropertyNames() - Method in interface jakarta.portlet.PortalContext: Returns all portal property names, or an empty Enumeration if there are no property names.
getPropertyNames() - Method in interface jakarta.portlet.PortletRequest: Returns a Enumeration of all the property names this request contains.
getPropertyNames() - Method in interface jakarta.portlet.PortletResponse: Gets the names of all response properties set on the response.
getPropertyValues(String) - Method in class jakarta.portlet.filter.PortletResponseWrapper
getPropertyValues(String) - Method in interface jakarta.portlet.PortletResponse: Gets the values of the response property with the given name.
getPublicParameterMap() - Method in class jakarta.portlet.filter.PortletRequestWrapper: Deprecated.
getPublicParameterMap() - Method in interface jakarta.portlet.PortletRequest: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
getPublicRenderParameterDefinitions() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getPublicRenderParameterDefinitions() - Method in class jakarta.portlet.GenericPortlet: Returns a Map of public render parameter names to their qualified names.
getPublicRenderParameterDefinitions() - Method in interface jakarta.portlet.PortletConfig: Returns a Map of public render parameter names to their qualified names.
getPublicRenderParameterNames() - Method in class jakarta.portlet.filter.PortletConfigWrapper
getPublicRenderParameterNames() - Method in class jakarta.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 jakarta.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 jakarta.portlet.filter.PortletConfigWrapper
getPublishingEventQNames() - Method in class jakarta.portlet.GenericPortlet
getPublishingEventQNames() - Method in interface jakarta.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 jakarta.portlet.Event: Get the event QName.
getReader() - Method in interface jakarta.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 jakarta.portlet.filter.ClientDataRequestWrapper
getRealPath(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getRealPath(String) - Method in interface jakarta.portlet.PortletContext: Returns a String containing the real path for a given virtual path.
getRemoteUser() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getRemoteUser() - Method in interface jakarta.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 jakarta.portlet.filter.StateAwareResponseWrapper: Deprecated.
getRenderParameterMap() - Method in interface jakarta.portlet.StateAwareResponse: Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
getRenderParameters() - Method in class jakarta.portlet.filter.MutableRenderStateWrapper
getRenderParameters() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getRenderParameters() - Method in class jakarta.portlet.filter.PortletURLWrapper
getRenderParameters() - Method in class jakarta.portlet.filter.RenderStateWrapper
getRenderParameters() - Method in class jakarta.portlet.filter.StateAwareResponseWrapper
getRenderParameters() - Method in interface jakarta.portlet.MutableRenderState: Gets the mutable render parameters.
getRenderParameters() - Method in interface jakarta.portlet.RenderState: Gets the render parameters.
getRequest() - Method in class jakarta.portlet.filter.ActionRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.ClientDataRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.EventRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.HeaderRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.PortletRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.RenderRequestWrapper: Return the wrapped request object.
getRequest() - Method in class jakarta.portlet.filter.ResourceRequestWrapper: Return the wrapped request object.
getRequestDispatcher(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getRequestDispatcher(String) - Method in interface jakarta.portlet.PortletContext: Returns a PortletRequestDispatcher object that acts as a wrapper for the resource located at the given path.
getRequestedSessionId() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getRequestedSessionId() - Method in interface jakarta.portlet.PortletRequest: Returns the session ID indicated in the client request.
getResource(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getResource(String) - Method in interface jakarta.portlet.PortletContext: Returns a URL to the resource that is mapped to a specified path.
getResourceAsStream(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getResourceAsStream(String) - Method in interface jakarta.portlet.PortletContext: Returns the resource located at the given path as an InputStream object.
getResourceBundle(Locale) - Method in class jakarta.portlet.filter.PortletConfigWrapper
getResourceBundle(Locale) - Method in class jakarta.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 jakarta.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 jakarta.portlet.filter.ResourceRequestWrapper
getResourceID() - Method in class jakarta.portlet.filter.ResourceURLWrapper
getResourceID() - Method in interface jakarta.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 jakarta.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 jakarta.portlet.filter.ResourceRequestWrapper
getResourceParameters() - Method in class jakarta.portlet.filter.ResourceURLWrapper
getResourceParameters() - Method in interface jakarta.portlet.ResourceRequest: Gets the resource parameters set for this request.
getResourceParameters() - Method in interface jakarta.portlet.ResourceURL: Gets the resource parameter values set for this URL.
getResourcePaths(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
getResourcePaths(String) - Method in interface jakarta.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 jakarta.portlet.filter.PortletAsyncContextWrapper
getResourceRequest() - Method in interface jakarta.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 jakarta.portlet.filter.PortletAsyncContextWrapper
getResourceResponse() - Method in interface jakarta.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 jakarta.portlet.filter.ActionResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.EventResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.HeaderResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.MimeResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.PortletResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.RenderResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.ResourceResponseWrapper: Return the wrapped response object.
getResponse() - Method in class jakarta.portlet.filter.StateAwareResponseWrapper: Return the wrapped response object.
getResponseContentType() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getResponseContentType() - Method in interface jakarta.portlet.PortletRequest: Returns the portal preferred content type for the response.
getResponseContentType() - Method in interface jakarta.portlet.ResourceRequest: Returns the portal preferred content type for the response.
getResponseContentTypes() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getResponseContentTypes() - Method in interface jakarta.portlet.PortletRequest: Gets a list of content types which the portal accepts for the response.
getResponseContentTypes() - Method in interface jakarta.portlet.ResourceRequest: Gets a list of content types which the portal accepts for the response.
getScheme() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getScheme() - Method in interface jakarta.portlet.PortletRequest: Returns the name of the scheme used to make this request.
getServerInfo() - Method in class jakarta.portlet.filter.PortletContextWrapper
getServerInfo() - Method in interface jakarta.portlet.PortletContext: Returns the name and version of the portlet container in which the portlet is running.
getServerName() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getServerName() - Method in interface jakarta.portlet.PortletRequest: Returns the host name of the server that received the request.
getServerPort() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getServerPort() - Method in interface jakarta.portlet.PortletRequest: Returns the port number on which this request was received.
getState() - Method in exception jakarta.portlet.WindowStateException: Returns the window state causing this exception.
getStatus() - Method in class jakarta.portlet.filter.ResourceResponseWrapper
getStatus() - Method in interface jakarta.portlet.ResourceResponse: Gets the current HTTP status code for the response.
getSuppliedRequest() - Method in class jakarta.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 jakarta.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 jakarta.portlet.filter.PortletConfigWrapper
getSupportedLocales() - Method in class jakarta.portlet.GenericPortlet
getSupportedLocales() - Method in interface jakarta.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 jakarta.portlet.filter.PortalContextWrapper
getSupportedPortletModes() - Method in interface jakarta.portlet.PortalContext: Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.
getSupportedWindowStates() - Method in class jakarta.portlet.filter.PortalContextWrapper
getSupportedWindowStates() - Method in interface jakarta.portlet.PortalContext: Returns all supported window states by the portal as an enumeration of WindowState objects.
getThrowable() - Method in class jakarta.portlet.PortletAsyncEvent: Gets the Throwable associated with the event.
getTimeout() - Method in class jakarta.portlet.filter.PortletAsyncContextWrapper
getTimeout() - Method in interface jakarta.portlet.PortletAsyncContext: Gets the timeout (in milliseconds) for this PortletAsyncContext.
getTitle(RenderRequest) - Method in class jakarta.portlet.GenericPortlet: Used by the render method to get the title.
getUnavailableSeconds() - Method in exception jakarta.portlet.UnavailableException: Returns the time in seconds for which the portlet can be expected to be unavailable.
getUserAgent() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getUserAgent() - Method in interface jakarta.portlet.PortletRequest: Returns the user agent for the request.
getUserPrincipal() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getUserPrincipal() - Method in interface jakarta.portlet.PortletRequest: Returns a java.security.Principal object containing the name of the current authenticated user.
getValue() - Method in interface jakarta.portlet.Event: Get the event payload.
getValue(String) - Method in class jakarta.portlet.filter.PortletParametersWrapper
getValue(String) - Method in interface jakarta.portlet.PortletParameters: Returns the value of a parameter as a String.
getValue(String, String) - Method in interface jakarta.portlet.PortletPreferences: Returns the first String value associated with the specified key of this preference.
getValues(String) - Method in class jakarta.portlet.filter.PortletParametersWrapper
getValues(String) - Method in interface jakarta.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 jakarta.portlet.PortletPreferences: Returns the String array value associated with the specified key in this preference.
getWindowID() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getWindowID() - Method in interface jakarta.portlet.PortletRequest: Returns the portlet window ID.
getWindowState() - Method in class jakarta.portlet.filter.PortletRequestWrapper
getWindowState() - Method in class jakarta.portlet.filter.RenderStateWrapper
getWindowState() - Method in class jakarta.portlet.filter.StateAwareResponseWrapper
getWindowState() - Method in interface jakarta.portlet.RenderState: Returns the current window state of the portlet.
getWindowState() - Method in interface jakarta.portlet.ResourceRequest: Returns the current window state of the portlet.
getWindowStates(String) - Method in class jakarta.portlet.filter.PortletConfigWrapper
getWindowStates(String) - Method in class jakarta.portlet.GenericPortlet: Returns an Enumeration of WindowState objects that are defined for the portlet for the given MIME type.
getWindowStates(String) - Method in interface jakarta.portlet.PortletConfig: Returns an Enumeration of WindowState objects that are defined for the portlet for the given MIME type.
getWrapped() - Method in class jakarta.portlet.filter.ActionParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.ActionURLWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.BaseURLWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.MutableActionParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.MutablePortletParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.MutableRenderParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.MutableRenderStateWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.MutableResourceParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortalContextWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortletAsyncContextWrapper
getWrapped() - Method in class jakarta.portlet.filter.PortletConfigWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortletParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortletRequestDispatcherWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortletSessionWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.PortletURLWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.RenderParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.RenderStateWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.RenderURLWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.ResourceParametersWrapper: Gets the wrapped object.
getWrapped() - Method in class jakarta.portlet.filter.ResourceURLWrapper: Gets the wrapped object.
getWriter() - Method in class jakarta.portlet.filter.MimeResponseWrapper
getWriter() - Method in interface jakarta.portlet.HeaderResponse: Data written to the HeaderResponse writer is added to the aggregated portal document HEAD section.
getWriter() - Method in interface jakarta.portlet.MimeResponse: Returns a PrintWriter object that can send character text to the portal.

H

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

I

identifier() - Method in annotation type jakarta.portlet.annotations.PublicRenderParameterDefinition: The public render parameter identifier.
include() - Method in annotation type jakarta.portlet.annotations.HeaderMethod: Specifies a resource, such as a JSP, an HTML file, or a servlet to be included.
include() - Method in annotation type jakarta.portlet.annotations.RenderMethod: Specifies a resource, such as a JSP, an HTML file, or a servlet to be included.
include() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: Specifies a resource, such as a JSP, an HTML file, or a servlet, to be included.
include(PortletRequest, PortletResponse) - Method in class jakarta.portlet.filter.PortletRequestDispatcherWrapper
include(PortletRequest, PortletResponse) - Method in interface jakarta.portlet.PortletRequestDispatcher: Includes the content of a resource (servlet, JSP page, HTML file) in the response.
include(RenderRequest, RenderResponse) - Method in class jakarta.portlet.filter.PortletRequestDispatcherWrapper
include(RenderRequest, RenderResponse) - Method in interface jakarta.portlet.PortletRequestDispatcher: Includes the content of a resource (servlet, JSP page, HTML file) in the response.
init() - Method in class jakarta.portlet.GenericPortlet: A convenience method which can be overridden so that there's no need to call super.init(config).
init(FilterConfig) - Method in interface jakarta.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 jakarta.portlet.GenericPortlet: Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
init(PortletConfig) - Method in interface jakarta.portlet.Portlet: Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
InitMethod - Annotation Type in jakarta.portlet.annotations: Designates a method corresponding to the portlet API init method.
InitParameter - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent name-value pairs.
initParams() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The portlet initialization parameters.
initParams() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The filter initialization parameters.
invalidate() - Method in class jakarta.portlet.filter.PortletSessionWrapper
invalidate() - Method in interface jakarta.portlet.PortletSession: Invalidates this session (all scopes) and unbinds any objects bound to it.
isAsyncStarted() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
isAsyncStarted() - Method in interface jakarta.portlet.ResourceRequest: Checks if this request has been put into asynchronous mode.
isAsyncSupported() - Method in class jakarta.portlet.filter.ResourceRequestWrapper
isAsyncSupported() - Method in interface jakarta.portlet.ResourceRequest: Checks if this request supports asynchronous operation.
isCommitted() - Method in class jakarta.portlet.filter.MimeResponseWrapper
isCommitted() - Method in interface jakarta.portlet.MimeResponse: Returns a boolean indicating if the response has been committed.
isEmpty() - Method in class jakarta.portlet.filter.PortletParametersWrapper
isEmpty() - Method in interface jakarta.portlet.PortletParameters: Returns a true if no parameters have been set.
isNew() - Method in class jakarta.portlet.filter.PortletSessionWrapper
isNew() - Method in interface jakarta.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 jakarta.portlet.UnavailableException: Returns a boolean indicating whether the portlet is permanently unavailable.
isPortletModeAllowed(PortletMode) - Method in class jakarta.portlet.filter.PortletRequestWrapper
isPortletModeAllowed(PortletMode) - Method in interface jakarta.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 jakarta.portlet.filter.MutableRenderParametersWrapper
isPublic(String) - Method in class jakarta.portlet.filter.RenderParametersWrapper
isPublic(String) - Method in interface jakarta.portlet.RenderParameters: Returns a boolean value indicating whether the given parameter name represents a public render parameter.
isPublicScope() - Method in interface jakarta.portlet.CacheControl: Returns a boolean indicating whether the caching scope is set to public for the current response.
isReadOnly() - Method in annotation type jakarta.portlet.annotations.Preference: Marks the preference as being read-only.
isReadOnly(String) - Method in interface jakarta.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 jakarta.portlet.filter.PortletRequestWrapper
isRequestedSessionIdValid() - Method in interface jakarta.portlet.PortletRequest: Checks whether the requested session ID is still valid.
isSecure() - Method in class jakarta.portlet.filter.PortletRequestWrapper
isSecure() - Method in interface jakarta.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 jakarta.portlet.filter.PortletRequestWrapper
isUserInRole(String) - Method in interface jakarta.portlet.PortletRequest: Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
isWindowStateAllowed(WindowState) - Method in class jakarta.portlet.filter.PortletRequestWrapper
isWindowStateAllowed(WindowState) - Method in interface jakarta.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

jakarta.portlet - package jakarta.portlet: The jakarta.portlet package defines the API for the Jakarta Portlet Specification V4.0.
jakarta.portlet.annotations - package jakarta.portlet.annotations: The jakarta.portlet.annotations package provides the annotations used for portlet configuration and portlet-specific dependency injection.
jakarta.portlet.filter - package jakarta.portlet.filter: The jakarta.portlet.filter package defines the filter APIs for the Jakarta Portlet Specification.

K

keywords() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: Locale specific keywords associated with this portlet.

L

LIFECYCLE_PHASE - Static variable in interface jakarta.portlet.PortletRequest: Provides the portlet lifecycle phase of the current request as request attribute.
listenerName() - Method in annotation type jakarta.portlet.annotations.PortletListener: The listener name.
locale() - Method in annotation type jakarta.portlet.annotations.LocaleString: The locale for the locale-specific string.
LocaleString - Annotation Type in jakarta.portlet.annotations: This annotation represents locale-specific strings used within composite portlet configuration annotations to represent information describing the portlet.
localPart() - Method in annotation type jakarta.portlet.annotations.PortletQName: The local part.
location() - Method in annotation type jakarta.portlet.annotations.Multipart: The directory location where files will be stored.
log(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
log(String) - Method in interface jakarta.portlet.PortletContext: Writes the specified message to a portlet log file, usually an event log.
log(String, Throwable) - Method in class jakarta.portlet.filter.PortletContextWrapper
log(String, Throwable) - Method in interface jakarta.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 jakarta.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 jakarta.portlet.PortalContext: Property indicating if the portal application supports the MimeResponse property MARKUP_HEAD_ELEMENT.
maxFileSize() - Method in annotation type jakarta.portlet.annotations.Multipart: The maximum size allowed for uploaded files.
MAXIMIZED - Static variable in class jakarta.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.
maxRequestSize() - Method in annotation type jakarta.portlet.annotations.Multipart: The maximum size allowed for multipart/form-data requests.
MimeResponse - Interface in jakarta.portlet: The MimeResponse defines the base interface to assist a portlet in returning MIME content.
MimeResponse.Copy - Enum in jakarta.portlet: Specifies processing when a URL is created.
MimeResponseWrapper - Class in jakarta.portlet.filter: The MimeResponseWrapper provides a convenient implementation of the MimeResponse interface that can be subclassed by developers.
MimeResponseWrapper(MimeResponse) - Constructor for class jakarta.portlet.filter.MimeResponseWrapper
mimeType() - Method in annotation type jakarta.portlet.annotations.Supports: The MIME type for the supported portlet modes and window states listed in this annotation, for example "text/html".
MINIMIZED - Static variable in class jakarta.portlet.WindowState: When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.
multipart() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: Provides multipart configuration data for the portlet.
Multipart - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to add multipart configuration information.
Mutable - Interface in jakarta.portlet: This is a marker interface indicating that the implementing object contains methods for updating portelt state information.
MutableActionParameters - Interface in jakarta.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 jakarta.portlet.filter: The MutableActionParametersWrapper provides a convenient implementation of the MutableActionParameters interface that can be subclassed by developers.
MutableActionParametersWrapper(MutableActionParameters) - Constructor for class jakarta.portlet.filter.MutableActionParametersWrapper
MutablePortletParameters - Interface in jakarta.portlet: The MutablePortletParameters provides methods that allow setting parameters to define a potential future render state.
MutablePortletParametersWrapper - Class in jakarta.portlet.filter: The MutablePortletParametersWrapper provides a convenient implementation of the MutablePortletParameters interface that can be subclassed by developers.
MutablePortletParametersWrapper(MutablePortletParameters) - Constructor for class jakarta.portlet.filter.MutablePortletParametersWrapper
MutableRenderParameters - Interface in jakarta.portlet: Provides methods that allow setting parameters to define a potential future render state.
MutableRenderParametersWrapper - Class in jakarta.portlet.filter: The MutableRenderParametersWrapper provides a convenient implementation of the MutableRenderParameters interface that can be subclassed by developers.
MutableRenderParametersWrapper(MutableRenderParameters) - Constructor for class jakarta.portlet.filter.MutableRenderParametersWrapper
MutableRenderState - Interface in jakarta.portlet: Provides read-write access to the render state.
MutableRenderStateWrapper - Class in jakarta.portlet.filter: The MutableRenderStateWrapper provides a convenient implementation of the MutableRenderState interface that can be subclassed by developers.
MutableRenderStateWrapper(MutableRenderState) - Constructor for class jakarta.portlet.filter.MutableRenderStateWrapper
MutableResourceParameters - Interface in jakarta.portlet: Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
MutableResourceParametersWrapper - Class in jakarta.portlet.filter: The MutableResourceParametersWrapper provides a convenient implementation of the MutableResourceParameters interface that can be subclassed by developers.
MutableResourceParametersWrapper(MutableResourceParameters) - Constructor for class jakarta.portlet.filter.MutableResourceParametersWrapper

N

name() - Method in annotation type jakarta.portlet.annotations.CustomPortletMode: The custom portlet mode name.
name() - Method in annotation type jakarta.portlet.annotations.CustomWindowState: The custom window state name.
name() - Method in annotation type jakarta.portlet.annotations.Dependency: The resource name.
name() - Method in annotation type jakarta.portlet.annotations.InitParameter: The parameter name.
name() - Method in annotation type jakarta.portlet.annotations.Preference: The preference name.
name() - Method in annotation type jakarta.portlet.annotations.RuntimeOption: The container runtime option name.
name() - Method in annotation type jakarta.portlet.annotations.UserAttribute: The user attribute name.
name() - Method in annotation type jakarta.portlet.ProcessAction: Name of the action.
name() - Method in annotation type jakarta.portlet.ProcessEvent: Local part of the event name.
name() - Method in annotation type jakarta.portlet.RenderMode: Name of the render mode.
Namespace - Annotation Type in jakarta.portlet.annotations: Qualifier that specifies the namespace for injection.
NAMESPACED_RESPONSE - Static variable in interface jakarta.portlet.MimeResponse: Property intended to be a hint to the portal application that the returned content is completely namespaced.
namespaceURI() - Method in annotation type jakarta.portlet.annotations.PortletQName: The QName namespace URI.
NONE - jakarta.portlet.MimeResponse.Copy: Specifies that no parameters are to be copied when a URL is created.
NORMAL - Static variable in class jakarta.portlet.WindowState: The NORMAL window state indicates that a portlet may be sharing the page with other portlets.

O

onComplete(PortletAsyncEvent) - Method in interface jakarta.portlet.PortletAsyncListener: Notifies this PortletAsyncListener that an asynchronous operation has been completed.
onError(PortletAsyncEvent) - Method in interface jakarta.portlet.PortletAsyncListener: Notifies this PortletAsyncListener that an asynchronous operation has failed to complete.
onStartAsync(PortletAsyncEvent) - Method in interface jakarta.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 jakarta.portlet.PortletAsyncListener: Notifies this PortletAsyncListener that an asynchronous operation has timed out.
ordinal() - Method in annotation type jakarta.portlet.annotations.HeaderMethod: The ordinal number for this annotated method.
ordinal() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The ordinal number for this annotated method.
ordinal() - Method in annotation type jakarta.portlet.annotations.PortletListener: The ordinal number for this annotated method.
ordinal() - Method in annotation type jakarta.portlet.annotations.RenderMethod: The ordinal number for this annotated method.
ordinal() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: The ordinal number for this annotated method.

P

PAGE - Static variable in interface jakarta.portlet.ResourceURL: The URL of type PAGE may contain artifacts that require knowledge of the state of the complete page, like PortletURLs.
paramName() - Method in annotation type jakarta.portlet.annotations.RenderStateScoped: The name of the render parameter under which the bean state is to be stored.
payloadType() - Method in annotation type jakarta.portlet.annotations.EventDefinition: The event payload type associated with the specified QName.
PortalContext - Interface in jakarta.portlet: The PortalContext interface gives the portlet the ability to retrieve information about the portal calling this portlet.
PortalContextWrapper - Class in jakarta.portlet.filter: The PortalContextWrapper provides a convenient implementation of the PortalContext interface that can be subclassed by developers.
PortalContextWrapper(PortalContext) - Constructor for class jakarta.portlet.filter.PortalContextWrapper
portalManaged() - Method in annotation type jakarta.portlet.annotations.CustomPortletMode: The portal managed flag.
Portlet - Interface in jakarta.portlet: The Portlet interface is used by the portlet container to invoke the portlets.
PORTLET - Static variable in interface jakarta.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 jakarta.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 jakarta.portlet.annotations: Annotation for the portlet application configuration.
PortletAsyncContext - Interface in jakarta.portlet: Class representing the execution context for an asynchronous operation that was initiated on a ResourceRequest.
PortletAsyncContextWrapper - Class in jakarta.portlet.filter: The PortletAsyncContextWrapper provides a convenient implementation of the PortletAsyncContext interface that can be subclassed by developers.
PortletAsyncContextWrapper(PortletAsyncContext) - Constructor for class jakarta.portlet.filter.PortletAsyncContextWrapper
PortletAsyncEvent - Class in jakarta.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) - Constructor for class jakarta.portlet.PortletAsyncEvent: Constructs a PortletAsyncEvent from the given PortletAsyncContext.
PortletAsyncEvent(PortletAsyncContext, ResourceRequest, ResourceResponse) - Constructor for class jakarta.portlet.PortletAsyncEvent: Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, and ResourceResponse.
PortletAsyncEvent(PortletAsyncContext, ResourceRequest, ResourceResponse, Throwable) - Constructor for class jakarta.portlet.PortletAsyncEvent: Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, ResourceResponse, and Throwable.
PortletAsyncEvent(PortletAsyncContext, Throwable) - Constructor for class jakarta.portlet.PortletAsyncEvent: Constructs a PortletAsyncEvent from the given PortletAsyncContext and Throwable.
PortletAsyncListener - Interface in jakarta.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 jakarta.portlet: The PortletConfig interface provides the portlet with its configuration.
PortletConfiguration - Annotation Type in jakarta.portlet.annotations: Annotation for the portlet configuration.
PortletConfigurations - Annotation Type in jakarta.portlet.annotations: Annotation for configuration of multiple portlets.
PortletConfigWrapper - Class in jakarta.portlet.filter: The PortletConfigWrapper provides a convenient implementation of the PortletConfig interface that can be subclassed by developers.
PortletConfigWrapper(PortletConfig) - Constructor for class jakarta.portlet.filter.PortletConfigWrapper
PortletContext - Interface in jakarta.portlet: The PortletContext interface defines a portlet view of the portlet container.
PortletContextWrapper - Class in jakarta.portlet.filter: The PortletContextWrapper provides a convenient implementation of the PortletContext interface that can be subclassed by developers.
PortletContextWrapper(PortletContext) - Constructor for class jakarta.portlet.filter.PortletContextWrapper
PortletException - Exception in jakarta.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 jakarta.portlet.PortletException: Constructs a new portlet exception.
PortletException(String) - Constructor for exception jakarta.portlet.PortletException: Constructs a new portlet exception with the given text.
PortletException(String, Throwable) - Constructor for exception jakarta.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 jakarta.portlet.PortletException: Constructs a new portlet exception when the portlet needs to throw an exception.
PortletFilter - Interface in jakarta.portlet.filter: The PortletFilter is the base interface for all portlet filters.
PortletLifecycleFilter - Annotation Type in jakarta.portlet.annotations: Designates a portlet request filter class.
PortletListener - Annotation Type in jakarta.portlet.annotations: Designates a portlet URL generation listener class.
portletMode() - Method in annotation type jakarta.portlet.annotations.HeaderMethod: The portlet mode rendered by the annotated method.
portletMode() - Method in annotation type jakarta.portlet.annotations.RenderMethod: The portlet mode rendered by the annotated method.
PortletMode - Class in jakarta.portlet: The PortletMode class represents the possible modes that a portlet can assume.
PortletMode() - Constructor for class jakarta.portlet.PortletMode: No-arg constructor to make object proxyable
PortletMode(String) - Constructor for class jakarta.portlet.PortletMode: Creates a new portlet mode with the given name.
PortletModeException - Exception in jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.PortletModeException: Constructs a new portlet mode exception when the portlet needs to throw an exception.
portletModes() - Method in annotation type jakarta.portlet.annotations.Supports: Defines the portlet modes supported by this portlet.
portletName() - Method in annotation type jakarta.portlet.annotations.ActionMethod: The portlet name for the annotated method.
portletName() - Method in annotation type jakarta.portlet.annotations.EventMethod: The portlet name for the annotated method.
portletName() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The portlet name for the annotated type.
PortletName - Annotation Type in jakarta.portlet.annotations: Qualifier that specifies the portlet name for injection.
portletNames() - Method in annotation type jakarta.portlet.annotations.HeaderMethod: The portlet names for which the header method applies.
portletNames() - Method in annotation type jakarta.portlet.annotations.PortletLifecycleFilter: The portlet names for which the request filter applies.
portletNames() - Method in annotation type jakarta.portlet.annotations.PortletPreferencesValidator: The portlet names for which the validator applies.
portletNames() - Method in annotation type jakarta.portlet.annotations.RenderMethod: The portlet names for which the render method applies.
portletNames() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: The portlet names for which the serve resource method applies.
PortletParameters - Interface in jakarta.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 jakarta.portlet.filter: The PortletParametersWrapper provides a convenient implementation of the PortletParameters interface that can be subclassed by developers.
PortletParametersWrapper(PortletParameters) - Constructor for class jakarta.portlet.filter.PortletParametersWrapper
PortletPreferences - Interface in jakarta.portlet: The PortletPreferences interface allows the portlet to store configuration data.
PortletPreferencesValidator - Annotation Type in jakarta.portlet.annotations: Designates a preferences validator class.
PortletQName - Annotation Type in jakarta.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 jakarta.portlet: The PortletRequest defines the base interface to provide client request information to a portlet.
PortletRequest.P3PUserInfos - Enum in jakarta.portlet: P3P user information constants.
PortletRequestDispatcher - Interface in jakarta.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 jakarta.portlet.filter: The PortletRequestDispatcherWrapper provides a convenient implementation of the PortletRequestDispatcher interface that can be subclassed by developers.
PortletRequestDispatcherWrapper(PortletRequestDispatcher) - Constructor for class jakarta.portlet.filter.PortletRequestDispatcherWrapper
PortletRequestScoped - Annotation Type in jakarta.portlet.annotations: Provides a CDI custom scope for the portlet request.
PortletRequestWrapper - Class in jakarta.portlet.filter: The PortletRequestWrapper provides a convenient implementation of the PortletRequest interface and is extended by other request wrappers.
PortletRequestWrapper(PortletRequest) - Constructor for class jakarta.portlet.filter.PortletRequestWrapper: Creates an PortletRequest adaptor wrapping the given request object.
PortletResponse - Interface in jakarta.portlet: The PortletResponse defines the base interface to assist a portlet in creating and sending a response to the client.
PortletResponseWrapper - Class in jakarta.portlet.filter: The PortletResponseWrapper provides a convenient implementation of the PortletResponse interface and is extended by other response wrappers.
PortletResponseWrapper(PortletResponse) - Constructor for class jakarta.portlet.filter.PortletResponseWrapper: Creates an ActionResponse adaptor wrapping the given response object.
PortletSecurityException - Exception in jakarta.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 jakarta.portlet.PortletSecurityException: Constructs a new security exception with the given text.
PortletSecurityException(String, Throwable) - Constructor for exception jakarta.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 jakarta.portlet.PortletSecurityException: Constructs a new portlet security exception when the portlet needs to throw an exception.
PortletSerializable - Interface in jakarta.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 jakarta.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 jakarta.portlet.annotations: Provides a CDI custom scope that is scoped to the portlet session rather than to the servlet session.
PortletSessionUtil - Class in jakarta.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 jakarta.portlet.PortletSessionUtil
PortletSessionWrapper - Class in jakarta.portlet.filter: The PortletSessionWrapper provides a convenient implementation of the PortletSession interface that can be subclassed by developers.
PortletSessionWrapper(PortletSession) - Constructor for class jakarta.portlet.filter.PortletSessionWrapper
PortletURL - Interface in jakarta.portlet: The PortletURL interface represents a URL that reference the portlet itself.
PortletURLGenerationListener<T extends PortletURL & RenderURL,U extends PortletURL & ActionURL> - Interface in jakarta.portlet: Portlet applications can register portlet URL listeners in order to filter URLs before they get generated.
PortletURLWrapper - Class in jakarta.portlet.filter: The PortletURLWrapper provides a convenient implementation of the PortletURL interface that can be subclassed by developers.
PortletURLWrapper(PortletURL) - Constructor for class jakarta.portlet.filter.PortletURLWrapper
Preference - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a single portlet preference.
PreferencesValidator - Interface in jakarta.portlet: The PreferencesValidator allows to validate the set of preferences of the associated portlet just before they are stored in the persistent store.
prefs() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The portlet preferences.
PRIVATE_SCOPE - Static variable in interface jakarta.portlet.MimeResponse: Private cache scope, indicating that the cache entry must not be shared across users.
processAction(ActionRequest, ActionResponse) - Method in class jakarta.portlet.GenericPortlet: Called by the portlet container to allow the portlet to process an action request.
processAction(ActionRequest, ActionResponse) - Method in interface jakarta.portlet.Portlet: Called by the portlet container to allow the portlet to process an action request.
ProcessAction - Annotation Type in jakarta.portlet: Annotation for marking a method for processing a specific action.
processEvent(EventRequest, EventResponse) - Method in interface jakarta.portlet.EventPortlet: Called by the portlet container requesting the portlet to process a specific event.
processEvent(EventRequest, EventResponse) - Method in class jakarta.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 jakarta.portlet: Annotation for marking a method for handling a specific event.
processingEvents() - Method in annotation type jakarta.portlet.annotations.EventMethod: The processing event QName definitions supported by this method.
PUBLIC - jakarta.portlet.MimeResponse.Copy: Specifies that only the public render parameters set for the current request are be copied to the URL when it is created.
PUBLIC_SCOPE - Static variable in interface jakarta.portlet.MimeResponse: Public cache scope, indicating that the cache entry can be shared across users.
publicParams() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The public render parameters used by the portlet.
publicParams() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The public render parameter identifiers used by the portlet.
PublicRenderParameterDefinition - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a single public render parameter.
publishingEvents() - Method in annotation type jakarta.portlet.annotations.ActionMethod: The QName definitions of the events published by this method.
publishingEvents() - Method in annotation type jakarta.portlet.annotations.EventMethod: The QName definitions of the events published by this method.

Q

qname() - Method in annotation type jakarta.portlet.annotations.EventDefinition: The event Qname.
qname() - Method in annotation type jakarta.portlet.annotations.PublicRenderParameterDefinition: The public render parameter Qname.
qname() - Method in annotation type jakarta.portlet.ProcessEvent: Event QName.

R

ReadOnlyException - Exception in jakarta.portlet: The ReadOnlyException is thrown when a portlet tries to change the value for a read-only preference attribute.
ReadOnlyException(String) - Constructor for exception jakarta.portlet.ReadOnlyException: Constructs a new read-only exception with the given text.
ReadOnlyException(String, Throwable) - Constructor for exception jakarta.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 jakarta.portlet.ReadOnlyException: Constructs a new read-only exception when the portlet needs to throw an exception.
removeAttribute(String) - Method in class jakarta.portlet.filter.PortletContextWrapper
removeAttribute(String) - Method in class jakarta.portlet.filter.PortletRequestWrapper
removeAttribute(String) - Method in class jakarta.portlet.filter.PortletSessionWrapper
removeAttribute(String) - Method in interface jakarta.portlet.PortletContext: Removes the attribute with the given name from the portlet context.
removeAttribute(String) - Method in interface jakarta.portlet.PortletRequest: Removes an attribute from this request.
removeAttribute(String) - Method in interface jakarta.portlet.PortletSession: Removes the object bound with the specified name under the PORTLET_SCOPE from this session.
removeAttribute(String, int) - Method in class jakarta.portlet.filter.PortletSessionWrapper
removeAttribute(String, int) - Method in interface jakarta.portlet.PortletSession: Removes the object bound with the specified name and the given scope from this session.
removeParameter(String) - Method in class jakarta.portlet.filter.MutablePortletParametersWrapper
removeParameter(String) - Method in interface jakarta.portlet.MutablePortletParameters: Removes the given public or private parameter.
removePublicRenderParameter(String) - Method in class jakarta.portlet.filter.PortletURLWrapper: Deprecated.
removePublicRenderParameter(String) - Method in class jakarta.portlet.filter.StateAwareResponseWrapper: Deprecated.
removePublicRenderParameter(String) - Method in interface jakarta.portlet.PortletURL: Deprecated.
As of version 3.0. Use RenderState.getRenderParameters() instead.
removePublicRenderParameter(String) - Method in interface jakarta.portlet.StateAwareResponse: Deprecated.
As of version 3.0. Use MutableRenderState.getRenderParameters() instead.
render(RenderRequest, RenderResponse) - Method in class jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.portlet.PortletRequest: String identifier for the portlet render lifecycle phase.
RenderFilter - Interface in jakarta.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 jakarta.portlet.GenericPortlet: V3 method implementing the headers stage within the render phase.
renderHeaders(HeaderRequest, HeaderResponse) - Method in interface jakarta.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 jakarta.portlet.annotations: Designates a method corresponding to the portlet API render method.
RenderMode - Annotation Type in jakarta.portlet: Annotation for marking a method for handling a specific portlet mode in the render phase.
RenderParameters - Interface in jakarta.portlet: Provides access to render parameters, which make up part of the render state.
RenderParametersWrapper - Class in jakarta.portlet.filter: The RenderParametersWrapper provides a convenient implementation of the RenderParameters interface that can be subclassed by developers.
RenderParametersWrapper(RenderParameters) - Constructor for class jakarta.portlet.filter.RenderParametersWrapper
RenderRequest - Interface in jakarta.portlet: The RenderRequest represents the request sent to the portlet to handle a render.
RenderRequestWrapper - Class in jakarta.portlet.filter: The RenderRequestWrapper provides a convenient implementation of the RenderRequest interface that can be subclassed by developers.
RenderRequestWrapper(RenderRequest) - Constructor for class jakarta.portlet.filter.RenderRequestWrapper: Creates an RenderRequest adaptor wrapping the given request object.
RenderResponse - Interface in jakarta.portlet: The RenderResponse defines an object to assist a portlet in sending a response to the portal.
RenderResponseWrapper - Class in jakarta.portlet.filter: The RenderResponseWrapper provides a convenient implementation of the RenderResponse interface that can be subclassed by developers.
RenderResponseWrapper(RenderResponse) - Constructor for class jakarta.portlet.filter.RenderResponseWrapper: Creates an RenderResponse adaptor wrapping the given response object.
RenderState - Interface in jakarta.portlet: Provides read-only access to the render state.
RenderStateScoped - Annotation Type in jakarta.portlet.annotations: Provides a CDI custom scope that is scoped to the render state.
RenderStateWrapper - Class in jakarta.portlet.filter: The RenderStateWrapper provides a convenient implementation of the RenderState interface that can be subclassed by developers.
RenderStateWrapper(RenderState) - Constructor for class jakarta.portlet.filter.RenderStateWrapper
RenderURL - Interface in jakarta.portlet: This is a marker interface for a render URL.
RenderURLWrapper - Class in jakarta.portlet.filter: The RenderURLWrapper provides a convenient implementation of the RenderURL interface that can be subclassed by developers.
RenderURLWrapper(RenderURL) - Constructor for class jakarta.portlet.filter.RenderURLWrapper
reset() - Method in class jakarta.portlet.filter.MimeResponseWrapper
reset() - Method in interface jakarta.portlet.MimeResponse: Clears any data that exists in the buffer as well as the properties set.
reset(String) - Method in interface jakarta.portlet.PortletPreferences: Resets or removes the value associated with the specified key.
resetBuffer() - Method in class jakarta.portlet.filter.MimeResponseWrapper
resetBuffer() - Method in interface jakarta.portlet.MimeResponse: Clears the content of the underlying buffer in the response without clearing properties set.
RESOURCE_PHASE - Static variable in interface jakarta.portlet.PortletRequest: String identifier for the portlet resource serving lifecycle phase.
resourceBundle() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The resource bundle name for this portlet.
resourceBundle() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The resource bundle name for this portlet.
ResourceFilter - Interface in jakarta.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.
resourceID() - Method in annotation type jakarta.portlet.annotations.ServeResourceMethod: The resource ID.
ResourceParameters - Interface in jakarta.portlet: Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
ResourceParametersWrapper - Class in jakarta.portlet.filter: The ResourceParametersWrapper provides a convenient implementation of the ResourceParameters interface that can be subclassed by developers.
ResourceParametersWrapper(ResourceParameters) - Constructor for class jakarta.portlet.filter.ResourceParametersWrapper
ResourceRequest - Interface in jakarta.portlet: The ResourceRequest interface represents the request send to the portlet for rendering resources.
ResourceRequestWrapper - Class in jakarta.portlet.filter: The ResourceRequestWrapper provides a convenient implementation of the ResourceRequest interface that can be subclassed by developers.
ResourceRequestWrapper(ResourceRequest) - Constructor for class jakarta.portlet.filter.ResourceRequestWrapper: Creates an ResourceRequest adaptor wrapping the given request object.
ResourceResponse - Interface in jakarta.portlet: The ResourceResponse defines an object to assist a portlet for rendering a resource.
ResourceResponseWrapper - Class in jakarta.portlet.filter: The ResourceResponseWrapper provides a convenient implementation of the ResourceResponse interface that can be subclassed by developers.
ResourceResponseWrapper(ResourceResponse) - Constructor for class jakarta.portlet.filter.ResourceResponseWrapper: Creates an ResourceResponse adaptor wrapping the given response object.
ResourceServingPortlet - Interface in jakarta.portlet: The ResourceServingPortlet interface allows serving resources through the portlet.
ResourceURL - Interface in jakarta.portlet: The ResourceURL defines a resource URL that when clicked will result in a serveResource call of the ResourceServingPortlet interface.
ResourceURLWrapper - Class in jakarta.portlet.filter: The ResourceURLWrapper provides a convenient implementation of the ResourceURL interface that can be subclassed by developers.
ResourceURLWrapper(ResourceURL) - Constructor for class jakarta.portlet.filter.ResourceURLWrapper
roleLink() - Method in annotation type jakarta.portlet.annotations.SecurityRoleRef: The application role that the role name is mapped to.
roleName() - Method in annotation type jakarta.portlet.annotations.SecurityRoleRef: The role name.
roleRefs() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The security role references.
RuntimeOption - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent portlet container runtime option name-value pairs.
runtimeOptions() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The portlet container runtime options.
runtimeOptions() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: The portlet container runtime options.

S

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

title() - Method in annotation type jakarta.portlet.annotations.PortletConfiguration: Locale specific static title for this portlet.
toString() - Method in interface jakarta.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 jakarta.portlet.filter.BaseURLWrapper
toString() - Method in class jakarta.portlet.PortletMode: Returns a String representation of this portlet mode.
toString() - Method in enum jakarta.portlet.PortletRequest.P3PUserInfos
toString() - Method in class jakarta.portlet.WindowState: Returns a String representation of this window state.

U

UnavailableException - Exception in jakarta.portlet: The portlet should throw the UnavailableException when the portlet is either temporarily or permanently unavailable to handle requests.
UnavailableException(String) - Constructor for exception jakarta.portlet.UnavailableException: Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.
UnavailableException(String, int) - Constructor for exception jakarta.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 jakarta.portlet.PortletMode: The portlet mode UNDEFINED is returned by the getPortletMode method when the portlet mode is not available.
UNDEFINED - Static variable in class jakarta.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 jakarta.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 jakarta.portlet.CacheControl: Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid.
USER_BDATE_FRACTIONSECOND - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_HMS_HOUR - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_HMS_MINUTE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_HMS_SECOND - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_TIMEZONE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_YMD_DAY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_YMD_MONTH - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BDATE_YMD_YEAR - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_ONLINE_EMAIL - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_ONLINE_URI - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_CITY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_COUNTRY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_NAME - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_ORGANIZATION - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_POSTALCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_STATEPROV - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_POSTAL_STREET - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_FAX_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_FAX_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_FAX_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_FAX_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_FAX_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_MOBILE_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_MOBILE_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_MOBILE_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_MOBILE_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_MOBILE_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_PAGER_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_PAGER_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_PAGER_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_PAGER_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_PAGER_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_TELEPHONE_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_TELEPHONE_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_TELEPHONE_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_TELEPHONE_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_BUSINESSINFO_TELECOM_TELEPHONE_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_DEPARTMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_EMPLOYER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_GENDER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_ONLINE_EMAIL - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_ONLINE_URI - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_CITY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_COUNTRY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_NAME - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_ORGANIZATION - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_POSTALCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_STATEPROV - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_POSTAL_STREET - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_FAX_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_FAX_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_FAX_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_FAX_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_FAX_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_MOBILE_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_MOBILE_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_MOBILE_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_MOBILE_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_MOBILE_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_PAGER_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_PAGER_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_PAGER_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_PAGER_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_PAGER_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_TELEPHONE_COMMENT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_TELEPHONE_EXT - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_TELEPHONE_INTCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_TELEPHONE_LOCCODE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_HOMEINFO_TELECOM_TELEPHONE_NUMBER - jakarta.portlet.PortletRequest.P3PUserInfos
USER_INFO - Static variable in interface jakarta.portlet.PortletRequest: Used to retrieve user information attributes with the getAttribute call.
USER_JOBTITLE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_LOGIN_ID - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_FAMILY - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_GIVEN - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_MIDDLE - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_NICKNAME - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_PREFIX - jakarta.portlet.PortletRequest.P3PUserInfos
USER_NAME_SUFFIX - jakarta.portlet.PortletRequest.P3PUserInfos
UserAttribute - Annotation Type in jakarta.portlet.annotations: This annotation is used within composite portlet configuration annotations to represent a single user attribute.
userAttributes() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The user aattribute declarations.

V

validate(PortletPreferences) - Method in interface jakarta.portlet.PreferencesValidator: If the preferences values are successfully validated the call to this method must finish gracefully.
ValidatorException - Exception in jakarta.portlet: The ValidatorException is thrown by the validate method of a PreferencesValidator when the validation of a preference failed.
ValidatorException(String, Throwable, Collection<String>) - Constructor for exception jakarta.portlet.ValidatorException: Constructs a new portlet validator exception.
ValidatorException(String, Collection<String>) - Constructor for exception jakarta.portlet.ValidatorException: Constructs a new validator exception with the given text.
ValidatorException(Throwable, Collection<String>) - Constructor for exception jakarta.portlet.ValidatorException: Constructs a new portlet validator exception when the portlet needs to throw an exception.
value() - Method in annotation type jakarta.portlet.annotations.DestroyMethod: The portlet name for the annotated method.
value() - Method in annotation type jakarta.portlet.annotations.InitMethod: The portlet name for the annotated method.
value() - Method in annotation type jakarta.portlet.annotations.InitParameter: The parameter value
value() - Method in annotation type jakarta.portlet.annotations.LocaleString: The parameter value
value() - Method in annotation type jakarta.portlet.annotations.PortletConfigurations: The portlet configurations.
value() - Method in annotation type jakarta.portlet.annotations.PortletSessionScoped: The portlet scope into which the annotated bean is to be placed.
valueOf(String) - Static method in enum jakarta.portlet.MimeResponse.Copy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum jakarta.portlet.PortletRequest.P3PUserInfos: Returns the enum constant of this type with the specified name.
values() - Method in annotation type jakarta.portlet.annotations.Preference: The preference values array.
values() - Method in annotation type jakarta.portlet.annotations.RuntimeOption: The container runtime options values.
values() - Static method in enum jakarta.portlet.MimeResponse.Copy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum jakarta.portlet.PortletRequest.P3PUserInfos: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in annotation type jakarta.portlet.annotations.Dependency: The minimum acceptable module version.
version() - Method in annotation type jakarta.portlet.annotations.PortletApplication: The portlet API version required by this portlet application.
VIEW - Static variable in class jakarta.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 jakarta.portlet.annotations: Qualifier that specifies the window ID for injection.
WindowState - Class in jakarta.portlet: The WindowState class represents the possible window states that a portlet window can assume.
WindowState() - Constructor for class jakarta.portlet.WindowState: No-arg constructor to make object proxyable
WindowState(String) - Constructor for class jakarta.portlet.WindowState: Creates a new window state with the given name.
WindowStateException - Exception in jakarta.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 jakarta.portlet.WindowStateException: Constructs a new window state exception with the given text.
WindowStateException(String, Throwable, WindowState) - Constructor for exception jakarta.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 jakarta.portlet.WindowStateException: Constructs a new window state exception when the portlet needs to throw an exception.
windowStates() - Method in annotation type jakarta.portlet.annotations.Supports: Defines the window states supported by this portlet.
wrapped - Variable in class jakarta.portlet.filter.PortalContextWrapper
wrapped - Variable in class jakarta.portlet.filter.PortletConfigWrapper
wrapped - Variable in class jakarta.portlet.filter.PortletContextWrapper
wrapped - Variable in class jakarta.portlet.filter.PortletParametersWrapper
wrapped - Variable in class jakarta.portlet.filter.PortletRequestDispatcherWrapper
wrapped - Variable in class jakarta.portlet.filter.PortletSessionWrapper
wrapped - Variable in class jakarta.portlet.filter.RenderStateWrapper
write(Writer) - Method in interface jakarta.portlet.BaseURL: Writes the portlet URL to the output stream using the provided writer.
write(Writer) - Method in class jakarta.portlet.filter.BaseURLWrapper
write(Writer, boolean) - Method in interface jakarta.portlet.BaseURL: Writes the portlet URL to the output stream using the provided writer.
write(Writer, boolean) - Method in class jakarta.portlet.filter.BaseURLWrapper

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