- 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 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.
- 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() - 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 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 interface javax.portlet.RenderResponse
-
Returns the actual buffer size used for the response.
- getCharacterEncoding() - Method in interface javax.portlet.ActionRequest
-
Returns the name of the character encoding used in the body of this request.
- getCharacterEncoding() - Method in interface javax.portlet.RenderResponse
-
Returns the name of the charset used for the MIME body sent in this response.
- 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.ActionRequest
-
Returns the MIME type of the body of the request, or null if the type 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.
- getContextPath() - Method in interface javax.portlet.PortletRequest
-
Returns the context path which is the path prefix associated with the deployed portlet application.
- 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 exception 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.
- 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.
- 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.
- getNamedDispatcher(String) - Method in interface javax.portlet.PortletContext
-
- 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 interface javax.portlet.RenderResponse
-
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.
- 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 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.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 this 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.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 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.
- 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
-
- 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 exception javax.portlet.WindowStateException
-
Returns the portlet state causing this exception.
- getSupportedPortletModes() - Method in interface javax.portlet.PortalContext
-
Returns all supported portlet modes by the portal as an enumertation of PorltetMode objects.
- getSupportedWindowStates() - Method in interface javax.portlet.PortalContext
-
Returns all supported window states by the portal as an enumertation 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 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 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.
- 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.
- 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_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 in javax.portlet
-
The PortletConfig interface provides the portlet with its configuration.
- PortletContext - Interface in javax.portlet
-
The PortletContext interface defines a portlet view of the portlet container.
- PortletException - Exception in javax.portlet
-
The PortletException class defines a general exception that a portlet can throw when it is unable to
perform its operation successfully.
- PortletException() - Constructor for exception javax.portlet.PortletException
-
Constructs a new portlet exception.
- PortletException(String) - Constructor for exception javax.portlet.PortletException
-
Constructs a new portlet exception with the given text.
- PortletException(String, Throwable) - Constructor for exception javax.portlet.PortletException
-
Constructs a new portlet exception when the portlet needs to do the following: throw an exception
include the "root cause" exception include a description message
- PortletException(Throwable) - Constructor for exception javax.portlet.PortletException
-
Constructs a new portlet exception when the portlet needs to throw an exception.
- PortletMode - Class in javax.portlet
-
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 in javax.portlet
-
The PortletModeException is thrown when a portlet tries to use or set a portlet mode that is not
supported by the current runtime environment or the portlet.
- PortletModeException(String, PortletMode) - Constructor for exception javax.portlet.PortletModeException
-
Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
- PortletModeException(String, Throwable, PortletMode) - Constructor for exception javax.portlet.PortletModeException
-
Constructs a new portlet mode exception when the portlet needs to do the following: throw an exception
include a message about the "root cause" that interfered with its normal operationinclude a description
messageinclude the portlet mode that caused this exception
- PortletModeException(Throwable, PortletMode) - Constructor for exception javax.portlet.PortletModeException
-
Constructs a new portlet mode exception when the portlet needs to throw an exception.
- PortletPreferences - Interface in javax.portlet
-
The PortletPreferences interface allows the portlet to store configuration data.
- PortletRequest - Interface in javax.portlet
-
The PortletRequest defines the base interface to provide client request information to a portlet.
- PortletRequestDispatcher - Interface in javax.portlet
-
The PortletRequestDispatcher interface defines an object that receives requests from the client and
sends them to the specified resources (such as a servlet, HTML file, or JSP file) on the server.
- PortletResponse - Interface in javax.portlet
-
The PortletResponse defines the base interface to assist a portlet in creating and sending a response to
the client.
- PortletSecurityException - Exception in javax.portlet
-
A portlet should throw a PortletSecurityException when a call fails because of security reasons.
Additionally it can be thrown by the portal/portlet-container.
- PortletSecurityException(String) - Constructor for exception javax.portlet.PortletSecurityException
-
Constructs a new security exception with the given text.
- PortletSecurityException(String, Throwable) - Constructor for exception javax.portlet.PortletSecurityException
-
Constructs a new portlet security exception when the portlet needs to do the following: throw an
exceptioninclude a message about the "root cause" that interfered with its normal operationinclude a
description message
- PortletSecurityException(Throwable) - Constructor for exception javax.portlet.PortletSecurityException
-
Constructs a new portlet security exception when the portlet needs to throw an exception.
- PortletSession - Interface in javax.portlet
-
The PortletSession interface provides a way to identify a user across more than one request and to store
transient information about that user.
- PortletSessionUtil - Class in javax.portlet
-
The PortletSessionUtil class helps identify and decode attributes in the PORTLET_SCOPE
scope of the PortletSession when accessed through the HttpSession an from within calls to methods of the
HttpSessionBindingListener interface.
- PortletSessionUtil() - Constructor for class javax.portlet.PortletSessionUtil
-
- PortletURL - Interface in javax.portlet
-
The PortletURL interface represents a URL that reference the portlet itself.
- PreferencesValidator - Interface in javax.portlet
-
The PreferencesValidator allows to validate the set of preferences of the associated portlet just before
they are stored in the persistent store.
- processAction(ActionRequest, ActionResponse) - Method in class javax.portlet.GenericPortlet
-
Called by the portlet container to allow the portlet to process an action request.
- processAction(ActionRequest, ActionResponse) - Method in interface javax.portlet.Portlet
-
Called by the portlet container to allow the portlet to process an action request.
- 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.PortletContext
-
Binds an object to a given attribute name in this portlet context.
- setAttribute(String, Object) - Method in interface javax.portlet.PortletRequest
-
Stores an attribute in this request.
- setAttribute(String, Object) - Method in interface javax.portlet.PortletSession
-
Binds an object to this session under the PORTLET_SCOPE, using the name specified.
- setAttribute(String, Object, int) - Method in interface javax.portlet.PortletSession
-
Binds an object to this session in the given scope, using the name specified.
- 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.
- setParameter(String, String) - Method in interface javax.portlet.PortletURL
-
Sets the given String parameter to this URL.
- setParameter(String, String[]) - Method in interface javax.portlet.PortletURL
-
Sets the given String array parameter to this URL.
- 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 sets the title of the 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.