Portlet API (V0.7.1) : Index

Package | Class | Tree | Deprecated | Index | Help
| Portlet API (V0.7.1)
PREV NEXT | FRAMES NO FRAMES

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

## A

ActionRequest - interface javax.portlet.ActionRequest.
  The `ActionRequest` represents the request sent to the portlet to handle an action.
ActionResponse - interface javax.portlet.ActionResponse.
  The `ActionResponse` interface represents the portlet response to an action request, the invocation of the processAction method.
addParameter(String, String) - Method in interface javax.portlet.PortletURL
  Adds the given String parameter to this URL.
addParameter(String, String[]) - Method in interface javax.portlet.PortletURL
  Adds the given String array parameter to this URL.
addProperty(String, String) - Method in interface javax.portlet.PortletResponse
  Adds a String property to an existing key to be returned to the portal.
APPLICATION_SCOPE - Static variable in interface javax.portlet.PortletSession
  This constant defines an application wide scope for the session attribute.

## B

BASIC_AUTH - Static variable in interface javax.portlet.PortletRequest
  String identifier for Basic authentication.

## C

CLIENT_CERT_AUTH - Static variable in interface javax.portlet.PortletRequest
  String identifier for Certification based authentication.
createActionURL() - Method in interface javax.portlet.RenderResponse
  Creates a portlet URL pointing to the current portlet mode and current window state, triggering an action request and a render request.
createRenderURL() - Method in interface javax.portlet.RenderResponse
  Creates a portlet URL pointing to the current portlet mode and current window state, triggering a render call.

## D

decodeAttribute(String) - Static method in class javax.portlet.PortletSessionUtil
  Returns the portlet attribute name from an encoded portlet attribute.
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.Portlet
  Called by the portlet container to indicate to a portlet that the portlet 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.
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 a set of helper methods based on the portlet mode.
doEdit(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
  Helper method to serve up the `edit` mode.
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.
encodeNamespace(String) - Method in interface javax.portlet.RenderResponse
  Maps the given string value into this portlet namespace and therefore ensures the uniqueness of the string value in the whole portal page.
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.WindowState
  Compares the specified object with this window state for equality.
equals(Object) - Method in class javax.portlet.PortletMode
  Compares the specified object with this portlet mode for equality.
EXPIRATION_CACHE - Static variable in interface javax.portlet.RenderResponse
  Property to set the expiration time in seconds for this response using the `setProperty` method.

## F

flushBuffer() - Method in interface javax.portlet.RenderResponse
  Forces any content in the buffer to be written to the client.
FORM_AUTH - Static variable in interface javax.portlet.PortletRequest
  String identifier for Form based authentication.

## G

GenericPortlet - class javax.portlet.GenericPortlet.
  The `GenericPortlet` class provides a default implementation for the `Portlet` interface.
GenericPortlet() - Constructor for class javax.portlet.GenericPortlet
  Does nothing.
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) - 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, 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.
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() - Method in interface javax.portlet.PortletContext
  Returns an `Enumeration` containing the attribute names available within this portlet context, or an emtpy `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 interface javax.portlet.PortletRequest
  Returns the name of the authentication scheme used for the connection between client and portal, for example, `BASIC_AUTH` or `CLIENT_CERT_AUTH`, or `null` if there was no authentication.
getBufferSize() - Method in interface javax.portlet.RenderResponse
  Returns the actual buffer size used for the response.
getCause() - Method in class javax.portlet.PortletException
  Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
getCharacterEncoding() - Method in interface javax.portlet.RenderResponse
  Returns the name of the charset used for the MIME body sent in this response.
getCharacterEncoding() - Method in interface javax.portlet.ActionRequest
  Returns the name of the character encoding used in the body of this request.
getContentLength() - Method in interface javax.portlet.ActionRequest
  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.
getContentType() - Method in interface javax.portlet.RenderResponse
  Returns the MIME type that can be used to contribute markup to the render response.
getContentType() - Method in interface javax.portlet.ActionRequest
  Returns the MIME type of the body of the request, or null if the type is not known.
getContextPath() - Method in interface javax.portlet.PortletRequest
  Returns the portion of the request URL that indicates the context of the request.
getCreationTime() - Method in interface javax.portlet.PortletSession
  Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getFailedKeys() - Method in class javax.portlet.ValidatorException
  Returns the keys that failed the validation.
getId() - Method in interface javax.portlet.PortletSession
  Returns a string containing the unique identifier assigned to this session.
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 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 interface javax.portlet.PortletRequest
  Returns the preferred Locale in which the portal will accept content.
getLocale() - Method in interface javax.portlet.RenderResponse
  Returns the locale assigned to the response.
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.
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.
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 class javax.portlet.PortletModeException
  Returns the unsupported portlet mode causing this exception.
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.
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.PortletRequest
  Returns a `Map` of the parameters of this request.
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 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 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.PortletSession
  Returns the portlet application context associated with this session.
getPortletContext() - Method in class javax.portlet.GenericPortlet
  Returns the portlet application context.
getPortletContext() - Method in interface javax.portlet.PortletConfig
  Returns a reference to the `PortletContext` in which the caller is executing.
getPortletContextName() - Method in interface javax.portlet.PortletContext
  Returns the name of this portlet web 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.ActionRequest
  Retrieves the body of the HTTP request from client to portal as binary data using an `InputStream`.
getPortletMode() - Method in interface javax.portlet.PortletRequest
  Returns the current portlet mode of the portlet.
getPortletName() - Method in class javax.portlet.GenericPortlet
  Returns the name of the portlet.
getPortletName() - Method in interface javax.portlet.PortletConfig
  Returns the name of the portlet.
getPortletOutputStream() - Method in interface javax.portlet.RenderResponse
  Returns a `OutputStream` suitable for writing binary data in the response.
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 interface javax.portlet.PortletRequest
  Returns the preferences object associated with the portlet.
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 interface javax.portlet.PortletRequest
  Returns the value of the specified request property as a `String`.
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.
getPropertyNames() - Method in interface javax.portlet.PortletRequest
  Returns a `Enumeration` of all the property names this request contains.
getPropertyNames() - Method in interface javax.portlet.PortalContext
  Returns all portal property names as strings, or an empty `Enumeration` if there are no property names.
getReader() - Method in interface javax.portlet.ActionRequest
  Retrieves the body of the HTTP request from the client to the portal as character data using a `BufferedReader`.
getRealPath(String) - Method in interface javax.portlet.PortletContext
  Returns a `String` containing the real path for a given virtual path.
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.
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 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.
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.
getResponseContentType() - Method in interface javax.portlet.PortletRequest
  Returns the portal preferred content type for the response.
getResponseContentTypes() - Method in interface javax.portlet.PortletRequest
  Gets a list of content types which the portal accepts for the response.
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 interface javax.portlet.PortletRequest
  Returns the host name of the server that received the request.
getServerPort() - Method in interface javax.portlet.PortletRequest
  Returns the port number on which this request was received.
getState() - Method in class javax.portlet.WindowStateException
  Returns the portlet state causing this exception.
getSupportedPortletModes() - Method in interface javax.portlet.PortalContext
  Returns the portlet modes that the portal supports.
getSupportedWindowStates() - Method in interface javax.portlet.PortalContext
  Returns the window states that the portal supports.
getTitle(RenderRequest) - Method in class javax.portlet.GenericPortlet
  Used by the render method to get the title.
getUnavailableSeconds() - Method in class javax.portlet.UnavailableException
  Returns the time in seconds for which the portlet can be expected to be unavailable.
getUserPrincipal() - Method in interface javax.portlet.PortletRequest
  Returns a java.security.Principal object containing the name of the current authenticated user.
getValue(String, String) - Method in interface javax.portlet.PortletPreferences
  Returns the first String value associated with the specified key in this preference.
getValues(String, String[]) - Method in interface javax.portlet.PortletPreferences
  Returns the String array value associated with the specified key in this preference.
getWindowState() - Method in interface javax.portlet.PortletRequest
  Returns the current window state of the portlet.
getWriter() - Method in interface javax.portlet.RenderResponse
  Returns a PrintWriter object that can send character text to the portal.

## H

hashCode() - Method in class javax.portlet.WindowState
  Returns the hash code value for this window state.
hashCode() - Method in class javax.portlet.PortletMode
  Returns the hash code value for this portlet mode.
HELP - Static variable in class javax.portlet.PortletMode
  When in `HELP` portlet mode, a portlet should provide help information about the portlet.

## I

include(RenderRequest, RenderResponse) - Method in interface javax.portlet.PortletRequestDispatcher
  Includes the content of a resource (servlet, JSP page, HTML file) in the response.
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.
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.
invalidate() - Method in interface javax.portlet.PortletSession
  Invalidates this session (all scopes) and unbinds any objects bound to it.
isCommitted() - Method in interface javax.portlet.RenderResponse
  Returns a boolean indicating if the response has been committed.
isModifiable(String) - Method in interface javax.portlet.PortletPreferences
  Returns true, if the value of this key can be modified by the user.
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 class javax.portlet.UnavailableException
  Returns a `boolean` indicating whether the portlet is permanently unavailable.
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.
isRequestedSessionIdValid() - Method in interface javax.portlet.PortletRequest
  Checks whether the requested session ID is still valid.
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 interface javax.portlet.PortletRequest
  Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
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
  Portlet API Package description.

## L

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

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.
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

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

PortalContext - interface javax.portlet.PortalContext.
  The `PortalContext` interface gives the portlet the ability to retrieve information about the portal calling this portlet.
Portlet - interface javax.portlet.Portlet.
  The `Portlet` interface is used by the portlet container to invoke the portlets.
PORTLET_SCOPE - Static variable in interface javax.portlet.PortletSession
  This constant defines the scope of the session attribute to be private to the portlet and its included resources.
PortletConfig - interface javax.portlet.PortletConfig.
  The `PortletConfig` interface provides the portlet with its configuration.
PortletContext - interface javax.portlet.PortletContext.
  The `PortletContext` interface defines a portlet view of the portlet container.
PortletException - exception javax.portlet.PortletException.
  The `PortletException` class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.
PortletException() - Constructor for class javax.portlet.PortletException
  Constructs a new portlet exception.
PortletException(String) - Constructor for class javax.portlet.PortletException
  Constructs a new portlet exception with the given text.
PortletException(String, Throwable) - Constructor for class javax.portlet.PortletException
  Constructs a new portlet exception when the portlet needs to do the following: throw an exception include the "root cause" exception include a description message
PortletException(Throwable) - Constructor for class javax.portlet.PortletException
  Constructs a new portlet exception when the portlet needs to throw an exception.
PortletMode - class javax.portlet.PortletMode.
  The `PortletMode` class represents the possible modes that a portlet can assume.
PortletMode(String) - Constructor for class javax.portlet.PortletMode
  Creates a new portlet mode with the given name.
PortletModeException - exception javax.portlet.PortletModeException.
  The `PortletModeException` is thrown when a portlet tries to use or set a portlet mode that is not supported by the current runtime environment.
PortletModeException(String, PortletMode) - Constructor for class javax.portlet.PortletModeException
  Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
PortletModeException(String, Throwable, PortletMode) - Constructor for class javax.portlet.PortletModeException
  Constructs a new portlet mode exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message include the portlet mode that caused this exception
PortletModeException(Throwable, PortletMode) - Constructor for class javax.portlet.PortletModeException
  Constructs a new portlet mode exception when the portlet needs to throw an exception.
PortletPreferences - interface javax.portlet.PortletPreferences.
  The `PortletPreferences` interface allows the portlet to store configuration data.
PortletRequest - interface javax.portlet.PortletRequest.
  The `PortletRequest` is the basic interface extended by all portlet requests.
PortletRequestDispatcher - interface javax.portlet.PortletRequestDispatcher.
  The `RequestDispatcher` 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.
PortletResponse - interface javax.portlet.PortletResponse.
  The `PortletResponse` is the basic interface extended by all portlet responses.
PortletSecurityException - exception javax.portlet.PortletSecurityException.
  The `PortletSecurityException` is thrown when a call fails because of security reasons.
PortletSecurityException(String) - Constructor for class javax.portlet.PortletSecurityException
  Constructs a new security exception with the given text.
PortletSecurityException(String, Throwable) - Constructor for class javax.portlet.PortletSecurityException
  Constructs a new portlet security exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message
PortletSecurityException(Throwable) - Constructor for class javax.portlet.PortletSecurityException
  Constructs a new portlet security exception when the portlet needs to throw an exception.
PortletSession - interface javax.portlet.PortletSession.
  The `PortletSession` interface provides a way to identify a user across more than one request and to store transient information about that user.
PortletSessionUtil - class javax.portlet.PortletSessionUtil.
  The `PortletSessionUtil` class helps with the decoding of portlet session attributes from the `HttpSession` that the `PortletSession` uses.
PortletSessionUtil() - Constructor for class javax.portlet.PortletSessionUtil
PortletURL - interface javax.portlet.PortletURL.
  The `PortletURL` interface represents a URL that reference the portlet itself.
PreferencesValidator - interface javax.portlet.PreferencesValidator.
  The `PreferencesValidator` allows the portlet to validate the preference settings before they are stored in the persistent store.
printStackTrace() - Method in class javax.portlet.PortletException
  Prints the stack trace of this exception to the standard error stream.
printStackTrace(PrintStream) - Method in class javax.portlet.PortletException
  Prints the stack trace of this exception to the specified print stream.
printStackTrace(PrintWriter) - Method in class javax.portlet.PortletException
  Prints the stack trace of this exception to the specified print writer.
processAction(ActionRequest, ActionResponse) - Method in interface javax.portlet.Portlet
  Notifies this portlet that a client request is triggered by an action URL to this portlet.
processAction(ActionRequest, ActionResponse) - Method in class javax.portlet.GenericPortlet
  Notifies the portlet which is called by the portlet container that an action request has been performed.

## R

removeAttribute(String) - Method in interface javax.portlet.PortletRequest
  Removes an attribute from this request.
removeAttribute(String) - Method in interface javax.portlet.PortletSession
  Removes the object bound with the specified name under the `PORTLET_SCOPE` from this session.
removeAttribute(String) - Method in interface javax.portlet.PortletContext
  Removes the attribute with the given name from the portlet context.
removeAttribute(String, int) - Method in interface javax.portlet.PortletSession
  Removes the object bound with the specified name and the given scope from this session.
render(RenderRequest, RenderResponse) - Method in interface javax.portlet.Portlet
  Notifies this portlet to generate its markup using the given request/response pair.
render(RenderRequest, RenderResponse) - Method in class javax.portlet.GenericPortlet
  The default implementation of this method sets the title using the `getTitle` method and performs the rendering using the `doDispatch` method.
RenderRequest - interface javax.portlet.RenderRequest.
  The `RenderRequest` represents the request sent to the portlet to handle a render.
RenderResponse - interface javax.portlet.RenderResponse.
  The `RenderResponse` defines an object to assist a portlet in sending a response to the portal.
reset() - Method in interface javax.portlet.RenderResponse
  Clears any data that exists in the buffer as well as the properties set.
reset(String) - Method in interface javax.portlet.PortletPreferences
  Resets or removes the value associated with the specified key.
resetBuffer() - Method in interface javax.portlet.RenderResponse
  Clears the content of the underlying buffer in the response without clearing properties set.

## S

sendRedirect(String) - Method in interface javax.portlet.ActionResponse
  Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.
setAttribute(String, Object) - Method in interface javax.portlet.PortletRequest
  Stores an attribute in this request.
setAttribute(String, Object) - Method in interface javax.portlet.PortletSession
  Binds an object to this session under the `PORTLET_SCOPE`, using the name specified.
setAttribute(String, Object) - Method in interface javax.portlet.PortletContext
  Binds an object to a given attribute name in this portlet context.
setAttribute(String, Object, int) - Method in interface javax.portlet.PortletSession
  Binds an object to this session in the given scope, using the name specified.
setBufferSize(int) - Method in interface javax.portlet.RenderResponse
  Sets the preferred buffer size for the body of the response.
setCharacterEncoding(String) - Method in interface javax.portlet.ActionRequest
  Overrides the name of the character encoding used in the body of this request.
setContentType(String) - Method in interface javax.portlet.RenderResponse
  Sets the MIME type for the render response.
setMaxInactiveInterval(int) - Method in interface javax.portlet.PortletSession
  Specifies the time, in seconds, between client requests, before the portlet container invalidates this session.
setParameters(Map) - Method in interface javax.portlet.PortletURL
  Sets a parameter map for this URL.
setPortletMode(PortletMode) - Method in interface javax.portlet.ActionResponse
  Sets the portlet mode of a portlet to the given portlet mode.
setPortletMode(PortletMode) - Method in interface javax.portlet.PortletURL
  Indicates the portlet mode the portlet must be in, if this portlet URL triggers a request.
setProperty(String, String) - Method in interface javax.portlet.PortletResponse
  Sets a String property to be returned to the portal.
setRenderParameter(String, String) - Method in interface javax.portlet.ActionResponse
  Sets a String parameter for the render request.
setRenderParameter(String, String[]) - Method in interface javax.portlet.ActionResponse
  Sets a String array parameter for the render request.
setRenderParameters(Map) - Method in interface javax.portlet.ActionResponse
  Sets a parameter map for the render request.
setSecure(boolean) - Method in interface javax.portlet.PortletURL
  Indicated the security setting for this URL.
setTitle(String) - Method in interface javax.portlet.RenderResponse
  This method can be called to set the title of a portlet.
setValue(String, String) - Method in interface javax.portlet.PortletPreferences
  Associates the specified String value with the specified key in this preference.
setValues(String, String[]) - Method in interface javax.portlet.PortletPreferences
  Associates the specified String array value with the specified key in this preference.
setWindowState(WindowState) - Method in interface javax.portlet.ActionResponse
  Sets the window state of a portlet to the given window state.
setWindowState(WindowState) - Method in interface javax.portlet.PortletURL
  Indicates the window state the portlet should be in, if this portlet URL triggers a request.
store() - Method in interface javax.portlet.PortletPreferences
  Commits all changes made to the preferences via the `set` methods in the persistent store.

## T

toString() - Method in interface javax.portlet.PortletURL
  Returns the complete URL as a string.
toString() - Method in class javax.portlet.WindowState
  Returns a String representation of this window state.
toString() - Method in class javax.portlet.PortletMode
  Returns a String representation of this portlet mode.

## U

UnavailableException - exception javax.portlet.UnavailableException.
  The portlet should throw the `UnavailableException` when the portlet is either temporarily or permanently unavailable to handle requests.
UnavailableException(String) - Constructor for class javax.portlet.UnavailableException
  Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.
UnavailableException(String, int) - Constructor for class javax.portlet.UnavailableException
  Constructs a new exception with a descriptive message indicating that the portlet is temporarily unavailable and giving an estimate of how long it will be unavailable.
UnmodifiableException - exception javax.portlet.UnmodifiableException.
  The `UnmodifiableException` is thrown when a portlet tries to change the value for a preference attribute, marked as unmodifiable in the deployment descriptor with the `non-modifiable` tag, without the needed permissions.
UnmodifiableException(String) - Constructor for class javax.portlet.UnmodifiableException
  Constructs a new unmodifiable exception with the given text.
UnmodifiableException(String, Throwable) - Constructor for class javax.portlet.UnmodifiableException
  Constructs a new unmodifiable 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
UnmodifiableException(Throwable) - Constructor for class javax.portlet.UnmodifiableException
  Constructs a new unmodifiable exception when the portlet needs to throw an exception.
USER_INFO - Static variable in interface javax.portlet.PortletRequest
  Used to retrieve user information attributes with the `getAttribute` call.

## V

validate(PortletPreferences) - Method in interface javax.portlet.PreferencesValidator
  Throws a `ValidatorException` if the given preferences contains invalid settings.
ValidatorException - exception javax.portlet.ValidatorException.
  The `ValidatorException` is thrown when a the validation of a preference failed.
ValidatorException(String, Collection) - Constructor for class javax.portlet.ValidatorException
  Constructs a new validator exception with the given text.
ValidatorException(String, Throwable, Collection) - Constructor for class javax.portlet.ValidatorException
  Constructs a new portlet validator exception.
ValidatorException(Throwable, Collection) - Constructor for class javax.portlet.ValidatorException
  Constructs a new portlet validator exception when the portlet needs to throw an exception.
VIEW - Static variable in class javax.portlet.PortletMode
  The expected functionality for a portlet in `VIEW` portlet mode is to generate markup reflecting the current state of the portlet.

## W

WindowState - class javax.portlet.WindowState.
  The `WindowState` class represents the possible window states that a portlet window can assume.
WindowState(String) - Constructor for class javax.portlet.WindowState
  Creates a new window state with the given name.
WindowStateException - exception javax.portlet.WindowStateException.
  The `WindowStateException` is thrown when a portlet tries to use a window state that is not supported by the current runtime environment.
WindowStateException(String, Throwable, WindowState) - Constructor for class javax.portlet.WindowStateException
  Constructs a new portlet 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(String, WindowState) - Constructor for class javax.portlet.WindowStateException
  Constructs a new portlet state exception with the given text.
WindowStateException(Throwable, WindowState) - Constructor for class javax.portlet.WindowStateException
  Constructs a new portlet state exception when the portlet needs to throw an exception.

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

Package | Class | Tree | Deprecated | Index | Help
| Portlet API (V0.7.1)
PREV NEXT | FRAMES NO FRAMES