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

A

ACTION_NAME - Static variable in interface javax.portlet.ActionRequest

Predefined action name for usage with the @ProcessAction annotation.

ACTION_PHASE - Static variable in interface javax.portlet.PortletRequest

String identifier for the portlet action lifecycle phase.

ACTION_SCOPE_ID - Static variable in interface javax.portlet.PortletRequest

The action scope ID that the portlet container uses for storing the current action scope as render parameter if the javax.portlet.actionScopedRequestAttributes container runtime option is used by the portlet.

ActionFilter - Interface in javax.portlet.filter

The ActionFilter is an object that performs filtering tasks on either the action request to a portlet, or on the action response from a portlet, or both.

ActionRequest - Interface in javax.portlet

The ActionRequest represents the request sent to the portlet to handle an action.
It extends the ClientDataRequest interface and provides action request information to portlets.

ActionRequestWrapper - Class in javax.portlet.filter

The ActionRequestWrapper provides a convenient implementation of the ActionRequest interface that can be subclassed by developers wishing to adapt the request.

ActionRequestWrapper(ActionRequest) - Constructor for class javax.portlet.filter.ActionRequestWrapper

Creates an ActionRequest adaptor wrapping the given request object.

ActionResponse - Interface in javax.portlet

The ActionResponse interface represents the portlet response to an action request.

ActionResponseWrapper - Class in javax.portlet.filter

The ActionResponseWrapper provides a convenient implementation of the ActionResponse interface that can be subclassed by developers wishing to adapt the response.

ActionResponseWrapper(ActionResponse) - Constructor for class javax.portlet.filter.ActionResponseWrapper

Creates an ActionResponse adaptor wrapping the given response object.

addProperty(String, String) - Method in interface javax.portlet.BaseURL

Adds a String property to an existing key on the URL.

addProperty(String, String) - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call addProperty(key, value) on the wrapped response object.

addProperty(String, Element) - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call addProperty() on the wrapped response object.

addProperty(Cookie) - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call addProperty() on the wrapped response object.

addProperty(String, String) - Method in interface javax.portlet.PortletResponse

Adds a String property to an existing key to be returned to the portal.

addProperty(Cookie) - Method in interface javax.portlet.PortletResponse

Adds a HTTP Cookie property to the response.
The portlet should note that the cookie may not make it to the client, but may be stored at the portal.

addProperty(String, Element) - Method in interface javax.portlet.PortletResponse

Adds an XML DOM element property to the response.

APPLICATION_SCOPE - Static variable in interface javax.portlet.PortletSession

This constant defines an application wide scope for the session attribute.

B

BaseURL - Interface in javax.portlet

The BaseURL defines the basic capabilities of a portlet URL pointing back to the portlet.

BASIC_AUTH - Static variable in interface javax.portlet.PortletRequest

String identifier for Basic authentication.

C

CACHE_SCOPE - Static variable in interface javax.portlet.MimeResponse

Property to set the cache scope for this response using the setProperty method intended to be used in forwarded or included servlets/JSPs.

CacheControl - Interface in javax.portlet

The CacheControl interface represents cache settings for a piece of markup.

CCPP_PROFILE - Static variable in interface javax.portlet.PortletRequest

Used to retrieve an instance of the javax.ccpp.Profile with the getAttribute call.

CLIENT_CERT_AUTH - Static variable in interface javax.portlet.PortletRequest

String identifier for Certification based authentication.

ClientDataRequest - Interface in javax.portlet

The ClientDataRequest represents the request information of the HTTP request issued from the client to the portal.
It extends the PortletRequest interface.

createActionURL() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call createActionURL() on the wrapped response object.

createActionURL() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call createActionURL() on the wrapped response object.

createActionURL() - Method in interface javax.portlet.MimeResponse

Creates a portlet URL targeting the portlet.

createActionURL() - Method in interface javax.portlet.ResourceResponse

createElement(String) - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call createElement() on the wrapped response object.

createElement(String) - Method in interface javax.portlet.PortletResponse

Creates an element of the type specified to be used in the PortletResponse.addProperty(String,Element) method.

createRenderURL() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call createRenderURL() on the wrapped response object.

createRenderURL() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call createRenderURL() on the wrapped response object.

createRenderURL() - Method in interface javax.portlet.MimeResponse

Creates a portlet URL targeting the portlet.

createRenderURL() - Method in interface javax.portlet.ResourceResponse

createResourceURL() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call createResourceURL() on the wrapped response object.

createResourceURL() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call createResourceURL() on the wrapped response object.

createResourceURL() - Method in interface javax.portlet.MimeResponse

Creates a portlet URL targeting the portlet.

createResourceURL() - Method in interface javax.portlet.ResourceResponse

D

decodeAttributeName(String) - Static method in class javax.portlet.PortletSessionUtil

Returns the attribute name of an attribute in the PORTLET_SCOPE.

decodeScope(String) - Static method in class javax.portlet.PortletSessionUtil

Returns the portlet attribute scope from an encoded portlet attribute.

destroy() - Method in interface javax.portlet.filter.PortletFilter

Called by the portlet container to indicate to a filter that it is being taken out of service.

destroy() - Method in class javax.portlet.GenericPortlet

Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.

destroy() - Method in interface javax.portlet.Portlet

Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.

DIGEST_AUTH - Static variable in interface javax.portlet.PortletRequest

String identifier for Digest based authentication.

doDispatch(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet

The default implementation of this method routes the render request to: method annotated with @RenderMode and the name of the portlet mode a set of helper methods depending on the current portlet mode the portlet is currently in.

doEdit(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet

Helper method to serve up the edit mode.

doFilter(ActionRequest, ActionResponse, FilterChain) - Method in interface javax.portlet.filter.ActionFilter

The doFilter method of the Filter is called by the portlet container each time a action request/response pair is passed through the chain due to a client request for a portlet method at the end of the chain.

doFilter(EventRequest, EventResponse, FilterChain) - Method in interface javax.portlet.filter.EventFilter

The doFilter method of the Filter is called by the portlet container each time a event request/response pair is passed through the chain due to a client request for a portlet method at the end of the chain.

doFilter(ActionRequest, ActionResponse) - Method in interface javax.portlet.filter.FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

doFilter(EventRequest, EventResponse) - Method in interface javax.portlet.filter.FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

doFilter(RenderRequest, RenderResponse) - Method in interface javax.portlet.filter.FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

doFilter(ResourceRequest, ResourceResponse) - Method in interface javax.portlet.filter.FilterChain

Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

doFilter(RenderRequest, RenderResponse, FilterChain) - Method in interface javax.portlet.filter.RenderFilter

The doFilter method of the Filter is called by the portlet container each time a render request/response pair is passed through the chain due to a client request for a portlet method at the end of the chain.

doFilter(ResourceRequest, ResourceResponse, FilterChain) - Method in interface javax.portlet.filter.ResourceFilter

The doFilter method of the Filter is called by the portlet container each time a resource request/response pair is passed through the chain due to a client request for a portlet method at the end of the chain.

doHeaders(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet

Used by the render method to set the response properties and headers.

doHelp(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet

Helper method to serve up the help mode.

doView(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet

Helper method to serve up the mandatory view mode.

E

EDIT - Static variable in class javax.portlet.PortletMode

Within the EDIT portlet mode, a portlet should provide content and logic that lets a user customize the behavior of the portlet.

encodeURL(String) - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call encodeURL(path) on the wrapped response object.

encodeURL(String) - Method in interface javax.portlet.PortletResponse

Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.

equals(Object) - Method in class javax.portlet.PortletMode

Compares the specified object with this portlet mode for equality.

equals(Object) - Method in class javax.portlet.WindowState

Compares the specified object with this window state for equality.

ETAG - Static variable in interface javax.portlet.MimeResponse

Property to tell the portlet container the new ETag for this response intended to be used in forwarded or included servlets/JSPs.

ETAG - Static variable in interface javax.portlet.RenderRequest

This property is set by the container if the portlet container has a cached response for the given validation tag.

ETAG - Static variable in interface javax.portlet.ResourceRequest

This property is set by the container if the container has a cached response for the given validation tag.

Event - Interface in javax.portlet

The Event interface represents an event that the portlet has received in the event processing phase.

EVENT_PHASE - Static variable in interface javax.portlet.PortletRequest

String identifier for the portlet event lifecycle phase.

EventFilter - Interface in javax.portlet.filter

The EventFilter is an object that performs filtering tasks on either the event request to a portlet, or on the event response from a portlet, or both.

EventPortlet - Interface in javax.portlet

The EventPortlet interface allows portlets receiving events.

EventRequest - Interface in javax.portlet

The EventRequest represents the request sent to the portlet to handle an event.

EventRequestWrapper - Class in javax.portlet.filter

The EventRequestWrapper provides a convenient implementation of the EventRequest interface that can be subclassed by developers wishing to adapt the request.

EventRequestWrapper(EventRequest) - Constructor for class javax.portlet.filter.EventRequestWrapper

Creates an EventRequest adaptor wrapping the given request object.

EventResponse - Interface in javax.portlet

The EventResponse interface represents the portlet response to an event request.

EventResponseWrapper - Class in javax.portlet.filter

The EventResponseWrapper provides a convenient implementation of the EventResponse interface that can be subclassed by developers wishing to adapt the response.

EventResponseWrapper(EventResponse) - Constructor for class javax.portlet.filter.EventResponseWrapper

Creates an EventResponse adaptor wrapping the given response object.

EXPIRATION_CACHE - Static variable in interface javax.portlet.MimeResponse

Property to set the expiration time in seconds for this response using the setProperty method intended to be used in forwarded or included servlets/JSPs.

F

filterActionURL(PortletURL) - Method in interface javax.portlet.PortletURLGenerationListener

Callback being called by the portlet container before toString or write are executed on action URLs.

FilterChain - Interface in javax.portlet.filter

A FilterChain is an object provided by the portlet container to the developer giving a view into the invocation chain of a filtered request for a portlet.

FilterConfig - Interface in javax.portlet.filter

A filter configuration object used by a portlet container to pass information to a filter during initialization.

filterRenderURL(PortletURL) - Method in interface javax.portlet.PortletURLGenerationListener

Callback being called by the portlet container before toString or write are executed on render URLs.

filterResourceURL(ResourceURL) - Method in interface javax.portlet.PortletURLGenerationListener

Callback being called by the portlet container before toString or write are executed on resource URLs.

flushBuffer() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call flushBuffer() on the wrapped response object.

flushBuffer() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call flushBuffer() on the wrapped response object.

flushBuffer() - Method in interface javax.portlet.MimeResponse

Forces any content in the buffer to be written to the underlying output stream.

FORM_AUTH - Static variable in interface javax.portlet.PortletRequest

String identifier for Form based authentication.

forward(PortletRequest, PortletResponse) - Method in interface javax.portlet.PortletRequestDispatcher

Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) on the server.

FULL - Static variable in interface javax.portlet.ResourceURL

The URL of type FULL does not need to contain the current state of the page or the current render parameters, portlet mode, or window state of the portlet.

G

GenericPortlet - Class in javax.portlet

The GenericPortlet class provides a default implementation for the Portlet interface.

GenericPortlet() - Constructor for class javax.portlet.GenericPortlet

Does nothing.

getAttribute(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getAttribute(String name) on the wrapped request object.

getAttribute(String) - Method in interface javax.portlet.PortletContext

Returns the portlet container attribute with the given name, or null if there is no attribute by that name.

getAttribute(String) - Method in interface javax.portlet.PortletRequest

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

getAttribute(String) - Method in interface javax.portlet.PortletSession

Returns the object bound with the specified name in this session under the PORTLET_SCOPE, or null if no object is bound under the name in that scope.

getAttribute(String, int) - Method in interface javax.portlet.PortletSession

Returns the object bound with the specified name in this session, or null if no object is bound under the name in the given scope.

getAttributeMap() - Method in interface javax.portlet.PortletSession

Returns a Map of the session attributes in the portlet session scope.

getAttributeMap(int) - Method in interface javax.portlet.PortletSession

Returns a Map of the session attributes in the given session scope.

getAttributeNames() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getAttributeNames() on the wrapped request object.

getAttributeNames() - Method in interface javax.portlet.PortletContext

Returns an Enumeration containing the attribute names available within this portlet context, or an empty Enumeration if no attributes are available.

getAttributeNames() - Method in interface javax.portlet.PortletRequest

Returns an Enumeration containing the names of the attributes available to this request.

getAttributeNames() - Method in interface javax.portlet.PortletSession

Returns an Enumeration of String objects containing the names of all the objects bound to this session under the PORTLET_SCOPE, or an empty Enumeration if no attributes are available.

getAttributeNames(int) - Method in interface javax.portlet.PortletSession

Returns an Enumeration of String objects containing the names of all the objects bound to this session in the given scope, or an empty Enumeration if no attributes are available in the given scope.

getAuthType() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getAuthType() on the wrapped request object.

getAuthType() - Method in interface javax.portlet.PortletRequest

Returns the name of the authentication scheme used for the connection between client and portal, for example, BASIC_AUTH, CLIENT_CERT_AUTH, a custom one or null if there was no authentication.

getBufferSize() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getBufferSize() on the wrapped response object.

getBufferSize() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getBufferSize() on the wrapped response object.

getBufferSize() - Method in interface javax.portlet.MimeResponse

Returns the actual buffer size used for the response.

getCacheability() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getCacheability() on the wrapped response object.

getCacheability() - Method in interface javax.portlet.ResourceRequest

Returns the cache level of this resource request.

getCacheability() - Method in interface javax.portlet.ResourceURL

Returns the cache level of this resource URL.

getCacheControl() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getCacheControl() on the wrapped response object.

getCacheControl() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getCacheControl() on the wrapped response object.

getCacheControl() - Method in interface javax.portlet.MimeResponse

Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response.

getCharacterEncoding() - Method in interface javax.portlet.ClientDataRequest

Returns the name of the character encoding used in the body of this request.

getCharacterEncoding() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getCharacterEncoding() on the wrapped request object.

getCharacterEncoding() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getCharacterEncoding() on the wrapped response object.

getCharacterEncoding() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getCharacterEncoding() on the wrapped request object.

getCharacterEncoding() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getCharacterEncoding() on the wrapped response object.

getCharacterEncoding() - Method in interface javax.portlet.MimeResponse

Returns the name of the charset used for the MIME body sent in this response.

getContainerRuntimeOptions() - Method in class javax.portlet.GenericPortlet

getContainerRuntimeOptions() - Method in interface javax.portlet.PortletConfig

Returns the container runtime options and values for this portlet.

getContainerRuntimeOptions() - Method in interface javax.portlet.PortletContext

Returns the container container runtime options keys supported by this portlet container.

getContentLength() - Method in interface javax.portlet.ClientDataRequest

Returns the length, in bytes, of the request body which is made available by the input stream, or -1 if the length is not known.

getContentLength() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getContentLength() on the wrapped request object.

getContentLength() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getContentLength() on the wrapped request object.

getContentType() - Method in interface javax.portlet.ClientDataRequest

Returns the MIME type of the body of the request, or null if the type is not known.

getContentType() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getContentType() on the wrapped request object.

getContentType() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getContentType() on the wrapped response object.

getContentType() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getContentType() on the wrapped request object.

getContentType() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getContentType() on the wrapped response object.

getContentType() - Method in interface javax.portlet.MimeResponse

Returns the MIME type that can be used to contribute markup to the render response.

getContextPath() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getContextPath() on the wrapped request object.

getContextPath() - Method in interface javax.portlet.PortletRequest

Returns the context path which is the path prefix associated with the deployed portlet application.

getCookies() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getCookies() on the wrapped request object.

getCookies() - Method in interface javax.portlet.PortletRequest

Returns an array containing all of the Cookie properties.

getCreationTime() - Method in interface javax.portlet.PortletSession

Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.

getDefaultNamespace() - Method in class javax.portlet.GenericPortlet

Returns the default namespace for events and public parameters.

getDefaultNamespace() - Method in interface javax.portlet.PortletConfig

Returns the default namespace for events and public render parameters.

getETag() - Method in interface javax.portlet.CacheControl

Returns the ETag for the current response that is used as validation tag, or null if no ETag is set on the response.

getETag() - Method in class javax.portlet.filter.RenderRequestWrapper

The default behavior of this method is to call getETag() on the wrapped request object.

getETag() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getETag() on the wrapped request object.

getETag() - Method in interface javax.portlet.RenderRequest

Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

getETag() - Method in interface javax.portlet.ResourceRequest

Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

getEvent() - Method in interface javax.portlet.EventRequest

Returns the event that triggered the call to the processEvent method.

getEvent() - Method in class javax.portlet.filter.EventRequestWrapper

The default behavior of this method is to call getEvent() on the wrapped request object.

getExpirationTime() - Method in interface javax.portlet.CacheControl

Get the currently set expiration time.

getFailedKeys() - Method in exception javax.portlet.ValidatorException

Returns the keys that failed the validation.

getFilterName() - Method in interface javax.portlet.filter.FilterConfig

Returns the filter-name of this filter as defined in the portlet deployment descriptor.

getId() - Method in interface javax.portlet.PortletSession

Returns a string containing the unique identifier assigned to this session.

getInitParameter(String) - Method in interface javax.portlet.filter.FilterConfig

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

getInitParameter(String) - Method in class javax.portlet.GenericPortlet

Returns a String containing the value of the named initialization * parameter, or null if the parameter does not exist.

getInitParameter(String) - Method in interface javax.portlet.PortletConfig

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

getInitParameter(String) - Method in interface javax.portlet.PortletContext

Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.

getInitParameterNames() - Method in interface javax.portlet.filter.FilterConfig

Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters.

getInitParameterNames() - Method in class javax.portlet.GenericPortlet

Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.

getInitParameterNames() - Method in interface javax.portlet.PortletConfig

Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.

getInitParameterNames() - Method in interface javax.portlet.PortletContext

Returns the names of the context initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.

getLastAccessedTime() - Method in interface javax.portlet.PortletSession

Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.

getLocale() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getLocale() on the wrapped request object.

getLocale() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getLocale() on the wrapped response object.

getLocale() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getLocale() on the wrapped response object.

getLocale() - Method in interface javax.portlet.MimeResponse

Returns the locale assigned to the response.

getLocale() - Method in interface javax.portlet.PortletRequest

Returns the preferred Locale in which the portal will accept content.

getLocales() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getLocales() on the wrapped request object.

getLocales() - Method in interface javax.portlet.PortletRequest

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale in which the portal will accept content for this request.

getMajorVersion() - Method in interface javax.portlet.PortletContext

Returns the major version of the Portlet API that this portlet container supports.

getMap() - Method in interface javax.portlet.PortletPreferences

Returns a Map of the preferences.

getMaxInactiveInterval() - Method in interface javax.portlet.PortletSession

Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses.

getMethod() - Method in interface javax.portlet.ClientDataRequest

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.

getMethod() - Method in interface javax.portlet.EventRequest

Returns the name of the HTTP method with which the original action request was made, for example, POST, or PUT.

getMethod() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getMethod() on the wrapped request object.

getMethod() - Method in class javax.portlet.filter.EventRequestWrapper

The default behavior of this method is to call getMethod() on the wrapped request object.

getMethod() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getMethod() on the wrapped request object.

getMimeType(String) - Method in interface javax.portlet.PortletContext

Returns the MIME type of the specified file, or null if the MIME type is not known.

getMinorVersion() - Method in interface javax.portlet.PortletContext

Returns the minor version of the Portlet API that this portlet container supports.

getMode() - Method in exception javax.portlet.PortletModeException

Returns the unsupported portlet mode causing this exception.

getName() - Method in interface javax.portlet.Event

Get the local part of the event name.

getNamedDispatcher(String) - Method in interface javax.portlet.PortletContext

Returns a PortletRequestDispatcher object that acts as a wrapper for the named servlet.

getNames() - Method in interface javax.portlet.PortletPreferences

Returns all of the keys that have an associated value, or an empty Enumeration if no keys are available.

getNamespace() - Method in class javax.portlet.filter.PortletResponseWrapper

The default behavior of this method is to call getNamespace() on the wrapped response object.

getNamespace() - Method in interface javax.portlet.PortletResponse

The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.

getNextPossiblePortletModes(RenderRequest) - Method in class javax.portlet.GenericPortlet

Used by the render method to set the next possible portlet modes.

getParameter(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getParameter(String name) on the wrapped request object.

getParameter(String) - Method in interface javax.portlet.PortletRequest

Returns the value of a request parameter as a String, or null if the parameter does not exist.

getParameterMap() - Method in interface javax.portlet.BaseURL

Returns a Map of the parameters currently set on this portlet URL via the setParameter or setParameters methods.

getParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getParameterMap() on the wrapped request object.

getParameterMap() - Method in interface javax.portlet.PortletRequest

Returns a Map of the parameters of this request.

getParameterNames() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getParameterNames() on the wrapped request object.

getParameterNames() - Method in interface javax.portlet.PortletRequest

Returns an Enumeration of String objects containing the names of the parameters contained in this request.

getParameterValues(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getParameterValues(name) on the wrapped request object.

getParameterValues(String) - Method in interface javax.portlet.PortletRequest

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

getPortalContext() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPortalContext() on the wrapped request object.

getPortalContext() - Method in interface javax.portlet.PortletRequest

Returns the context of the calling portal.

getPortalInfo() - Method in interface javax.portlet.PortalContext

Returns information about the portal like vendor, version, etc.

getPortletConfig() - Method in class javax.portlet.GenericPortlet

Returns the PortletConfig object of this portlet.

getPortletContext() - Method in interface javax.portlet.filter.FilterConfig

Returns a reference to the PortletContext in which the caller is executing.

getPortletContext() - Method in class javax.portlet.GenericPortlet

Returns the PortletContext of the portlet application the portlet is in.

getPortletContext() - Method in interface javax.portlet.PortletConfig

Returns the PortletContext of the portlet application the portlet is in.

getPortletContext() - Method in interface javax.portlet.PortletSession

Returns the portlet application context associated with this session.

getPortletContextName() - Method in interface javax.portlet.PortletContext

Returns the name of this portlet application correponding to this PortletContext as specified in the web.xml deployment descriptor for this web application by the display-name element.

getPortletInputStream() - Method in interface javax.portlet.ClientDataRequest

Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.

getPortletInputStream() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getPortletInputStream() on the wrapped request object.

getPortletInputStream() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getPortletInputStream() on the wrapped request object.

getPortletMode() - Method in class javax.portlet.filter.ActionResponseWrapper

The default behavior of this method is to call getPortletMode() on the wrapped response object.

getPortletMode() - Method in class javax.portlet.filter.EventResponseWrapper

The default behavior of this method is to call getPortletMode() on the wrapped response object.

getPortletMode() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPortletMode() on the wrapped request object.

getPortletMode() - Method in interface javax.portlet.PortletRequest

Returns the current portlet mode of the portlet.

getPortletMode() - Method in interface javax.portlet.PortletURL

Returns the currently set portlet mode on this PortletURL.

getPortletMode() - Method in interface javax.portlet.StateAwareResponse

Returns the currently set portlet mode on this reponse.

getPortletName() - Method in class javax.portlet.GenericPortlet

Returns the name of this portlet.

getPortletName() - Method in interface javax.portlet.PortletConfig

Returns the name of the portlet.

getPortletOutputStream() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getPortletOutputStream() on the wrapped response object.

getPortletOutputStream() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getPortletOutputStream() on the wrapped response object.

getPortletOutputStream() - Method in interface javax.portlet.MimeResponse

Returns a OutputStream suitable for writing binary data in the response.

getPortletSession() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPortletSession() on the wrapped request object.

getPortletSession(boolean) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPortletSession(create) on the wrapped request object.

getPortletSession() - Method in interface javax.portlet.PortletRequest

Returns the current portlet session or, if there is no current session, creates one and returns the new session.

getPortletSession(boolean) - Method in interface javax.portlet.PortletRequest

Returns the current portlet session or, if there is no current session and the given flag is true, creates one and returns the new session.

getPreferences() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPreferences() on the wrapped request object.

getPreferences() - Method in interface javax.portlet.PortletRequest

Returns the preferences object associated with the portlet.

getPrivateParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPrivateParameterMap() on the wrapped request object.

getPrivateParameterMap() - Method in interface javax.portlet.PortletRequest

Returns a Map of the private parameters of this request.

getPrivateRenderParameterMap() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getPrivateRenderParameterMap() on the wrapped request object.

getPrivateRenderParameterMap() - Method in interface javax.portlet.ResourceRequest

Returns a Map of the private render parameters of this request.

getProcessingEventQNames() - Method in class javax.portlet.GenericPortlet

getProcessingEventQNames() - Method in interface javax.portlet.PortletConfig

Returns the QNames of the processing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any processing events.

getProperties(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getProperteis(name) on the wrapped request object.

getProperties(String) - Method in interface javax.portlet.PortletRequest

Returns all the values of the specified request property as a Enumeration of String objects.

getProperty(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getProperty(name) on the wrapped request object.

getProperty(String) - Method in interface javax.portlet.PortalContext

Returns the portal property with the given name, or a null if there is no property by that name.

getProperty(String) - Method in interface javax.portlet.PortletRequest

Returns the value of the specified request property as a String.

getPropertyNames() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPropertyNames() on the wrapped request object.

getPropertyNames() - Method in interface javax.portlet.PortalContext

Returns all portal property names, or an empty Enumeration if there are no property names.

getPropertyNames() - Method in interface javax.portlet.PortletRequest

Returns a Enumeration of all the property names this request contains.

getPublicParameterMap() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getPublicParameterMap() on the wrapped request object.

getPublicParameterMap() - Method in interface javax.portlet.PortletRequest

Returns a Map of the public parameters of this request.

getPublicRenderParameterNames() - Method in class javax.portlet.GenericPortlet

Returns the names of the public render parameters supported by the portlet as an Enumeration of String objects, or an empty Enumeration if the portlet has no public render parameters.

getPublicRenderParameterNames() - Method in interface javax.portlet.PortletConfig

Returns the names of the public render parameters supported by the portlet as an Enumeration of String objects, or an empty Enumeration if the portlet has not defined public render parameters.

getPublishingEventQNames() - Method in class javax.portlet.GenericPortlet

getPublishingEventQNames() - Method in interface javax.portlet.PortletConfig

Returns the QNames of the publishing events supported by the portlet as an Enumeration of QName objects, or an empty Enumeration if the portlet has not defined any publishing events.

getQName() - Method in interface javax.portlet.Event

Get the event QName.

getReader() - Method in interface javax.portlet.ClientDataRequest

Retrieves the body of the HTTP request from the client to the portal as character data using a BufferedReader.

getReader() - Method in class javax.portlet.filter.ActionRequestWrapper

The default behavior of this method is to call getReader() on the wrapped request object.

getReader() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getReader() on the wrapped request object.

getRealPath(String) - Method in interface javax.portlet.PortletContext

Returns a String containing the real path for a given virtual path.

getRemoteUser() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getRemoteUser() on the wrapped request object.

getRemoteUser() - Method in interface javax.portlet.PortletRequest

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.

getRenderParameterMap() - Method in class javax.portlet.filter.ActionResponseWrapper

The default behavior of this method is to call getRenderParameterMap() on the wrapped response object.

getRenderParameterMap() - Method in class javax.portlet.filter.EventResponseWrapper

The default behavior of this method is to call getRenderParameterMap() on the wrapped response object.

getRenderParameterMap() - Method in interface javax.portlet.StateAwareResponse

Returns a Map of the render parameters currently set on this response.

getRequest() - Method in class javax.portlet.filter.ActionRequestWrapper

Return the wrapped request object.

getRequest() - Method in class javax.portlet.filter.EventRequestWrapper

Return the wrapped request object.

getRequest() - Method in class javax.portlet.filter.PortletRequestWrapper

Return the wrapped request object.

getRequest() - Method in class javax.portlet.filter.RenderRequestWrapper

Return the wrapped request object.

getRequest() - Method in class javax.portlet.filter.ResourceRequestWrapper

Return the wrapped request object.

getRequestDispatcher(String) - Method in interface javax.portlet.PortletContext

Returns a PortletRequestDispatcher object that acts as a wrapper for the resource located at the given path.

getRequestedSessionId() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getRequestedSessionId() on the wrapped request object.

getRequestedSessionId() - Method in interface javax.portlet.PortletRequest

Returns the session ID indicated in the client request.

getResource(String) - Method in interface javax.portlet.PortletContext

Returns a URL to the resource that is mapped to a specified path.

getResourceAsStream(String) - Method in interface javax.portlet.PortletContext

Returns the resource located at the given path as an InputStream object.

getResourceBundle(Locale) - Method in class javax.portlet.GenericPortlet

Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.

getResourceBundle(Locale) - Method in interface javax.portlet.PortletConfig

Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.

getResourceID() - Method in class javax.portlet.filter.ResourceRequestWrapper

The default behavior of this method is to call getResourceID() on the wrapped request object.

getResourceID() - Method in interface javax.portlet.ResourceRequest

Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.

getResourcePaths(String) - Method in interface javax.portlet.PortletContext

Returns a directory-like listing of all the paths to resources within the web application longest sub-path of which matches the supplied path argument.

getResponse() - Method in class javax.portlet.filter.ActionResponseWrapper

Return the wrapped response object.

getResponse() - Method in class javax.portlet.filter.EventResponseWrapper

Return the wrapped response object.

getResponse() - Method in class javax.portlet.filter.PortletResponseWrapper

Return the wrapped response object.

getResponse() - Method in class javax.portlet.filter.RenderResponseWrapper

Return the wrapped response object.

getResponse() - Method in class javax.portlet.filter.ResourceResponseWrapper

Return the wrapped response object.

getResponseContentType() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getResponseContentType() on the wrapped request object.

getResponseContentType() - Method in interface javax.portlet.PortletRequest

Returns the portal preferred content type for the response.

getResponseContentType() - Method in interface javax.portlet.ResourceRequest

Returns the portal preferred content type for the response.

getResponseContentTypes() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getResponseContentTypes() on the wrapped request object.

getResponseContentTypes() - Method in interface javax.portlet.PortletRequest

Gets a list of content types which the portal accepts for the response.

getResponseContentTypes() - Method in interface javax.portlet.ResourceRequest

Gets a list of content types which the portal accepts for the response.

getScheme() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getScheme() on the wrapped request object.

getScheme() - Method in interface javax.portlet.PortletRequest

Returns the name of the scheme used to make this request.

getServerInfo() - Method in interface javax.portlet.PortletContext

Returns the name and version of the portlet container in which the portlet is running.

getServerName() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getServerName() on the wrapped request object.

getServerName() - Method in interface javax.portlet.PortletRequest

Returns the host name of the server that received the request.

getServerPort() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getServerPort() on the wrapped request object.

getServerPort() - Method in interface javax.portlet.PortletRequest

Returns the port number on which this request was received.

getState() - Method in exception javax.portlet.WindowStateException

Returns the portlet state causing this exception.

getSupportedLocales() - Method in class javax.portlet.GenericPortlet

getSupportedLocales() - Method in interface javax.portlet.PortletConfig

Returns the locales supported by the portlet as an Enumeration of Locale objects, or an empty Enumeration if the portlet has not defined any supported locales.

getSupportedPortletModes() - Method in interface javax.portlet.PortalContext

Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.

getSupportedWindowStates() - Method in interface javax.portlet.PortalContext

Returns all supported window states by the portal as an enumeration of WindowState objects.

getTitle(RenderRequest) - Method in class javax.portlet.GenericPortlet

Used by the render method to get the title.

getUnavailableSeconds() - Method in exception javax.portlet.UnavailableException

Returns the time in seconds for which the portlet can be expected to be unavailable.

getUserPrincipal() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getUserPrincipal() on the wrapped request object.

getUserPrincipal() - Method in interface javax.portlet.PortletRequest

Returns a java.security.Principal object containing the name of the current authenticated user.

getValue() - Method in interface javax.portlet.Event

Get the event payload.

getValue(String, String) - Method in interface javax.portlet.PortletPreferences

Returns the first String value associated with the specified key of this preference.

getValues(String, String[]) - Method in interface javax.portlet.PortletPreferences

Returns the String array value associated with the specified key in this preference.

getWindowID() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getWindowId() on the wrapped request object.

getWindowID() - Method in interface javax.portlet.PortletRequest

Returns the portlet window ID.

getWindowState() - Method in class javax.portlet.filter.ActionResponseWrapper

The default behavior of this method is to call getWindowState() on the wrapped response object.

getWindowState() - Method in class javax.portlet.filter.EventResponseWrapper

The default behavior of this method is to call getWindowState() on the wrapped response object.

getWindowState() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call getWindowState() on the wrapped request object.

getWindowState() - Method in interface javax.portlet.PortletRequest

Returns the current window state of the portlet.

getWindowState() - Method in interface javax.portlet.PortletURL

Returns the currently set window state on this PortletURL.

getWindowState() - Method in interface javax.portlet.StateAwareResponse

Returns the currently set window state on this response.

getWriter() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call getWriter() on the wrapped response object.

getWriter() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call getWriter() on the wrapped response object.

getWriter() - Method in interface javax.portlet.MimeResponse

Returns a PrintWriter object that can send character text to the portal.

H

hashCode() - Method in class javax.portlet.PortletMode

Returns the hash code value for this portlet mode.

hashCode() - Method in class javax.portlet.WindowState

Returns the hash code value for this window state.

HELP - Static variable in class javax.portlet.PortletMode

When in HELP portlet mode, a portlet should provide help information about the portlet.

HTTP_STATUS_CODE - Static variable in interface javax.portlet.ResourceResponse

Constant for setting the HTTP status code via the setProperty method.

I

include(RenderRequest, RenderResponse) - Method in interface javax.portlet.PortletRequestDispatcher

Includes the content of a resource (servlet, JSP page, HTML file) in the response.

include(PortletRequest, PortletResponse) - Method in interface javax.portlet.PortletRequestDispatcher

Includes the content of a resource (servlet, JSP page, HTML file) in the response.

init(FilterConfig) - Method in interface javax.portlet.filter.PortletFilter

Called by the portlet container to indicate to a filter that it is being placed into service.

init(PortletConfig) - Method in class javax.portlet.GenericPortlet

Called by the portlet container to indicate to a portlet that the portlet is being placed into service.

init() - Method in class javax.portlet.GenericPortlet

A convenience method which can be overridden so that there's no need to call super.init(config).

init(PortletConfig) - Method in interface javax.portlet.Portlet

Called by the portlet container to indicate to a portlet that the portlet is being placed into service.

invalidate() - Method in interface javax.portlet.PortletSession

Invalidates this session (all scopes) and unbinds any objects bound to it.

isCommitted() - Method in class javax.portlet.filter.RenderResponseWrapper

The default behavior of this method is to call isCommitted() on the wrapped response object.

isCommitted() - Method in class javax.portlet.filter.ResourceResponseWrapper

The default behavior of this method is to call isCommitted() on the wrapped response object.

isCommitted() - Method in interface javax.portlet.MimeResponse

Returns a boolean indicating if the response has been committed.

isNew() - Method in interface javax.portlet.PortletSession

Returns true if the client does not yet know about the session or if the client chooses not to join the session.

isPermanent() - Method in exception javax.portlet.UnavailableException

Returns a boolean indicating whether the portlet is permanently unavailable.

isPortletModeAllowed(PortletMode) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call isPortletModeAllowed(mode) on the wrapped request object.

isPortletModeAllowed(PortletMode) - Method in interface javax.portlet.PortletRequest

Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.

isPublicScope() - Method in interface javax.portlet.CacheControl

Returns a boolean indicating whether the caching scope is set to public for the current response.

isReadOnly(String) - Method in interface javax.portlet.PortletPreferences

Returns true, if the value of this key is defined as read-only and thus cannot be modified by the user.

isRequestedSessionIdValid() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call isRequestedSessionIdValid() on the wrapped request object.

isRequestedSessionIdValid() - Method in interface javax.portlet.PortletRequest

Checks whether the requested session ID is still valid.

isSecure() - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call isSecure() on the wrapped request object.

isSecure() - Method in interface javax.portlet.PortletRequest

Returns a boolean indicating whether this request was made using a secure channel between client and the portal, such as HTTPS.

isUserInRole(String) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call isUserInRole(role) on the wrapped request object.

isUserInRole(String) - Method in interface javax.portlet.PortletRequest

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

isWindowStateAllowed(WindowState) - Method in class javax.portlet.filter.PortletRequestWrapper

The default behavior of this method is to call isWindowStateAllowed(state) on the wrapped request object.

isWindowStateAllowed(WindowState) - Method in interface javax.portlet.PortletRequest

Returns true, if the given window state is valid to be set for this portlet in the context of the current request.

J

javax.portlet - package javax.portlet

The javax.portlet package defines the API for Java Portlet Specification V2.0.

javax.portlet.filter - package javax.portlet.filter

The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.

L

LIFECYCLE_PHASE - Static variable in interface javax.portlet.PortletRequest

Provides the portlet lifecycle phase of the current request as request attribute.

log(String) - Method in interface javax.portlet.PortletContext

Writes the specified message to a portlet log file, usually an event log.

log(String, Throwable) - Method in interface javax.portlet.PortletContext

Writes an explanatory message and a stack trace for a given Throwable exception to the portlet log file.

M

MARKUP_HEAD_ELEMENT - Static variable in interface javax.portlet.MimeResponse

Property intended to be a hint to the portal application that the provided DOM element should be added to the markup head section of the response to the client.

MARKUP_HEAD_ELEMENT_SUPPORT - Static variable in interface javax.portlet.PortalContext

Property indicating if the portal application supports the MimeResponse property MARKUP_HEAD_ELEMENT.

MAXIMIZED - Static variable in class javax.portlet.WindowState

The MAXIMIZED window state is an indication that a portlet may be the only portlet being rendered in the portal page, or that the portlet has more space compared to other portlets in the portal page.

MimeResponse - Interface in javax.portlet

The MimeResponse defines the base interface to assist a portlet in returning MIME content.

MINIMIZED - Static variable in class javax.portlet.WindowState

When a portlet is in MINIMIZED window state, the portlet should only render minimal output or no output at all.

N

NAMESPACED_RESPONSE - Static variable in interface javax.portlet.MimeResponse

Property intended to be a hint to the portal application that the returned content is completely namespaced.

NORMAL - Static variable in class javax.portlet.WindowState

The NORMAL window state indicates that a portlet may be sharing the page with other portlets.

P

PAGE - Static variable in interface javax.portlet.ResourceURL

The URL of type PAGE may contain artifacts that require knowledge of the state of the complete page, like PortletURLs.

PortalContext - Interface in javax.portlet

The PortalContext interface gives the portlet the ability to retrieve information about the portal calling this portlet.

Portlet - Interface in javax.portlet

The Portlet interface is used by the portlet container to invoke the portlets.

PORTLET - Static variable in interface javax.portlet.ResourceURL

The URL of type PORTLRET does not need to contain the current state of the page, but the current render parameters, portlet mode, or window state of the portlet must be accessible to the portlet.