| ID | Return | Method/Field | Description | Required | Deprecated | Testable |
| PORTLET:JAVADOC:1 | String | javax.portlet.ActionRequest.getCharacterEncoding
|
Returns the name of the character encoding used in the body of this request.
This method returns null if the request does not specify a character encoding.
| true |
| true |
| PORTLET:JAVADOC:2 | int | javax.portlet.ActionRequest.getContentLength
|
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.
| true |
| true |
| PORTLET:JAVADOC:3 | String | javax.portlet.ActionRequest.getContentType
|
Returns the MIME type of the body of the request, or null if the type is not known.
| true |
| true |
| PORTLET:JAVADOC:4 | InputStream | javax.portlet.ActionRequest.getPortletInputStream
|
Retrieves the body of the HTTP request from client to portal as binary data using an InputStream.
Either this method or getReader may be called to read the body, but not both. For HTTP POST data of type application/x-www-form-urlencoded this method throws an IllegalStateException as this data has been already processed by the portal/portlet-container and is available as request parameters.
| true |
| true |
| PORTLET:JAVADOC:5 | InputStream | javax.portlet.ActionRequest.getPortletInputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| PORTLET:JAVADOC:6 | InputStream | javax.portlet.ActionRequest.getPortletInputStream
throws
IllegalStateException
| if getReader was already called, or it is a HTTP POST data of type application/x-www-form-urlencoded | true |
| true |
| PORTLET:JAVADOC:7 | BufferedReader | javax.portlet.ActionRequest.getReader
|
Retrieves the body of the HTTP request from the client to the portal as character data using a BufferedReader.
The reader translates the character data according to the character encoding used on the body. Either this method or getPortletInputStream may be called to read the body, not both. For HTTP POST data of type application/x-www-form-urlencoded this method throws an IllegalStateException as this data has been already processed by the portal/portlet-container and is available as request parameters.
| true |
| true |
| PORTLET:JAVADOC:8 | BufferedReader | javax.portlet.ActionRequest.getReader
throws
UnsupportedEncodingException
| if the character set encoding used is not supported and the text cannot be decoded | true |
| false |
| PORTLET:JAVADOC:9 | BufferedReader | javax.portlet.ActionRequest.getReader
throws
IOException
| if an input or output exception occurred | true |
| false |
| PORTLET:JAVADOC:10 | BufferedReader | javax.portlet.ActionRequest.getReader
throws
IllegalStateException
| if getPortletInputStream method has been called on this request, it is a HTTP POST data of type application/x-www-form-urlencoded. | true |
| true |
| PORTLET:JAVADOC:11 | void | javax.portlet.ActionRequest.setCharacterEncoding
(
String
)
|
Overrides the name of the character encoding used in the body of this request.
This method must be called prior to reading input using getReader or getPortletInputStream. This method only sets the character set for the Reader that the getReader method returns.
| true |
| false |
| PORTLET:JAVADOC:12 | void | javax.portlet.ActionRequest.setCharacterEncoding
(
String
)
throws
UnsupportedEncodingException
| if this is not a valid encoding | true |
| false |
| PORTLET:JAVADOC:13 | void | javax.portlet.ActionRequest.setCharacterEncoding
(
String
)
throws
IllegalStateException
| if this method is called after reading request parameters or reading input using getReader() | true |
| true |
| PORTLET:JAVADOC:14 | void | javax.portlet.ActionResponse.sendRedirect
(
String
)
|
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.
This method only accepts an absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif) or a full path URI (e.g. /myportal/mywebap/myfolder/myresource.gif). If required, the portlet container may encode the given URL before the redirection is issued to the client. The sendRedirect method can not be invoked after any of the following methods of the ActionResponse interface has been called: setPortletMode setWindowState setRenderParameter setRenderParameters
| true |
| true |
| PORTLET:JAVADOC:15 | void | javax.portlet.ActionResponse.sendRedirect
(
String
)
throws
IOException
| if an input or output exception occurs. | true |
| false |
| PORTLET:JAVADOC:16 | void | javax.portlet.ActionResponse.sendRedirect
(
String
)
throws
IllegalArgumentException
| if a relative path URL is given | true |
| true |
| PORTLET:JAVADOC:17 | void | javax.portlet.ActionResponse.sendRedirect
(
String
)
throws
IllegalStateException
| if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called. | true |
| true |
| PORTLET:JAVADOC:18 | void | javax.portlet.ActionResponse.setPortletMode
(
PortletMode
)
|
Sets the portlet mode of a portlet to the given portlet mode.
Possible values are the standard portlet modes and any custom portlet modes supported by the portal and the portlet. Portlets must declare in the deployment descriptor the portlet modes they support for each markup type. Standard portlet modes are: EDIT HELP VIEW Note: The portlet may still be called in a different window state in the next render call, depending on the portlet container / portal.
| true |
| true |
| PORTLET:JAVADOC:19 | void | javax.portlet.ActionResponse.setPortletMode
(
PortletMode
)
throws
PortletModeException
| if the portlet cannot switch to this portlet mode, because the portlet or portal does not support it for this markup, or the current user is not allowed to switch to this portlet mode. To avoid this exception the portlet can check the allowed portlet modes with Request.isPortletModeAllowed(). | true |
| true |
| PORTLET:JAVADOC:20 | void | javax.portlet.ActionResponse.setPortletMode
(
PortletMode
)
throws
IllegalStateException
| if the method is invoked after sendRedirect has been called. | true |
| true |
| PORTLET:JAVADOC:21 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String
)
|
Sets a String parameter for the render request.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a request is targeted to the portlet. This method replaces all parameters with the given key. The given parameter do not need to be encoded prior to calling this method.
| true |
| true |
| PORTLET:JAVADOC:22 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String
)
throws
IllegalArgumentException
| if key or value are null. | true |
| true |
| PORTLET:JAVADOC:23 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String
)
throws
IllegalStateException
| if the method is invoked after sendRedirect has been called. | true |
| true |
| PORTLET:JAVADOC:24 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String[]
)
|
Sets a String array parameter for the render request.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a request is targeted to the portlet. This method replaces all parameters with the given key. The given parameter do not need to be encoded prior to calling this method.
| true |
| true |
| PORTLET:JAVADOC:25 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String[]
)
throws
IllegalArgumentException
| if key or value are null. | true |
| true |
| PORTLET:JAVADOC:26 | void | javax.portlet.ActionResponse.setRenderParameter
(
String
, String[]
)
throws
IllegalStateException
| if the method is invoked after sendRedirect has been called. | true |
| true |
| PORTLET:JAVADOC:27 | void | javax.portlet.ActionResponse.setRenderParameters
(
Map
)
|
Sets a parameter map for the render request.
All previously set render parameters are cleared. These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a new request is targeted to the portlet. The given parameters do not need to be encoded prior to calling this method.
| true |
| true |
| PORTLET:JAVADOC:28 | void | javax.portlet.ActionResponse.setRenderParameters
(
Map
)
throws
IllegalArgumentException
| if parameters is null, if any of the key/values in the Map are null, if any of the keys is not a String, or if any of the values is not a String array. | true |
| true |
| PORTLET:JAVADOC:29 | void | javax.portlet.ActionResponse.setRenderParameters
(
Map
)
throws
IllegalStateException
| if the method is invoked after sendRedirect has been called. | true |
| true |
| PORTLET:JAVADOC:30 | void | javax.portlet.ActionResponse.setWindowState
(
WindowState
)
|
Sets the window state of a portlet to the given window state.
Possible values are the standard window states and any custom window states supported by the portal and the portlet. Standard window states are: MINIMIZED NORMAL MAXIMIZED
| true |
| false |
| PORTLET:JAVADOC:31 | void | javax.portlet.ActionResponse.setWindowState
(
WindowState
)
throws
WindowStateException
| if the portlet cannot switch to the specified window state. To avoid this exception the portlet can check the allowed window states with Request.isWindowStateAllowed(). | true |
| true |
| PORTLET:JAVADOC:32 | void | javax.portlet.ActionResponse.setWindowState
(
WindowState
)
throws
IllegalStateException
| if the method is invoked after sendRedirect has been called. | true |
| true |
| PORTLET:JAVADOC:33 | void | javax.portlet.GenericPortlet.destroy
|
Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.
The default implementation does nothing.
| true |
| false |
| PORTLET:JAVADOC:34 | void | javax.portlet.GenericPortlet.doDispatch
(
RenderRequest
, RenderResponse
)
|
The default implementation of this method routes the render request to a set of helper methods depending on the current portlet mode the portlet is currently in.
These methods are: doView for handling view requests doEdit for handling edit requests doHelp for handling help requests If the window state of this portlet is minimized, this method does not invoke any of the portlet mode rendering methods. For handling custom portlet modes the portlet should override this method.
| true |
| true |
| PORTLET:JAVADOC:35 | void | javax.portlet.GenericPortlet.doDispatch
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:36 | void | javax.portlet.GenericPortlet.doDispatch
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:37 | void | javax.portlet.GenericPortlet.doDispatch
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:38 | void | javax.portlet.GenericPortlet.doDispatch
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:39 | void | javax.portlet.GenericPortlet.doEdit
(
RenderRequest
, RenderResponse
)
|
Helper method to serve up the edit mode.
The default implementation throws an exception.
| true |
| true |
| PORTLET:JAVADOC:40 | void | javax.portlet.GenericPortlet.doEdit
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:41 | void | javax.portlet.GenericPortlet.doEdit
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:42 | void | javax.portlet.GenericPortlet.doEdit
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:43 | void | javax.portlet.GenericPortlet.doEdit
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:44 | void | javax.portlet.GenericPortlet.doHelp
(
RenderRequest
, RenderResponse
)
|
Helper method to serve up the help mode.
The default implementation throws an exception.
| true |
| true |
| PORTLET:JAVADOC:45 | void | javax.portlet.GenericPortlet.doHelp
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:46 | void | javax.portlet.GenericPortlet.doHelp
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:47 | void | javax.portlet.GenericPortlet.doHelp
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:48 | void | javax.portlet.GenericPortlet.doHelp
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:49 | void | javax.portlet.GenericPortlet.doView
(
RenderRequest
, RenderResponse
)
|
Helper method to serve up the mandatory view mode.
The default implementation throws an exception.
| true |
| true |
| PORTLET:JAVADOC:50 | void | javax.portlet.GenericPortlet.doView
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:51 | void | javax.portlet.GenericPortlet.doView
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:52 | void | javax.portlet.GenericPortlet.doView
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:53 | void | javax.portlet.GenericPortlet.doView
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:54 | GenericPortlet | javax.portlet.GenericPortlet.GenericPortlet
|
Does nothing.
| true |
| true |
| PORTLET:JAVADOC:55 | String | javax.portlet.GenericPortlet.getInitParameter
(
String
)
|
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
| true |
| true |
| PORTLET:JAVADOC:56 | String | javax.portlet.GenericPortlet.getInitParameter
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:57 | Enumeration | javax.portlet.GenericPortlet.getInitParameterNames
|
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.
| true |
| true |
| PORTLET:JAVADOC:58 | PortletConfig | javax.portlet.GenericPortlet.getPortletConfig
|
Returns the PortletConfig object of this portlet.
| true |
| true |
| PORTLET:JAVADOC:59 | PortletContext | javax.portlet.GenericPortlet.getPortletContext
|
Returns the PortletContext of the portlet application the portlet is in.
| true |
| true |
| PORTLET:JAVADOC:60 | String | javax.portlet.GenericPortlet.getPortletName
|
Returns the name of this portlet.
| true |
| true |
| PORTLET:JAVADOC:61 | ResourceBundle | javax.portlet.GenericPortlet.getResourceBundle
(
Locale
)
|
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.
| true |
| true |
| PORTLET:JAVADOC:62 | String | javax.portlet.GenericPortlet.getTitle
(
RenderRequest
)
|
Used by the render method to get the title.
The default implementation gets the title from the ResourceBundle of the PortletConfig of the portlet. The title is retrieved using the 'javax.portlet.title' resource name. Portlets can overwrite this method to provide dynamic titles (e.g. based on locale, client, and session information). Examples are: language-dependant titles for multi-lingual portals shorter titles for WAP phones the number of messages in a mailbox portlet
| true |
| true |
| PORTLET:JAVADOC:63 | void | javax.portlet.GenericPortlet.init
(
PortletConfig
)
|
Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
The default implementation just stores the PortletConfig object. The portlet container calls the init method exactly once after instantiating the portlet. The init method must complete successfully before the portlet can receive any requests. The portlet container cannot place the portlet into service if the init method does one of the following: it throws a PortletException it does not return within a time period defined by the Web server
| true |
| true |
| PORTLET:JAVADOC:64 | void | javax.portlet.GenericPortlet.init
(
PortletConfig
)
throws
PortletException
| if an exception has occurred that interferes with the portlet normal operation. | true |
| false |
| PORTLET:JAVADOC:65 | void | javax.portlet.GenericPortlet.init
(
PortletConfig
)
throws
UnavailableException
| if the portlet cannot perform the initialization at this time. | true |
| false |
| PORTLET:JAVADOC:66 | void | javax.portlet.GenericPortlet.init
|
A convenience method which can be overridden so that there's no need to call super.init(config).
Instead of overriding init(PortletConfig), simply override this method and it will be called by GenericPortlet.init(PortletConfig config). The PortletConfig object can still be retrieved via getPortletConfig.
| true |
| true |
| PORTLET:JAVADOC:67 | void | javax.portlet.GenericPortlet.init
throws
PortletException
| if an exception has occurred that interferes with the portlet normal operation. | true |
| true |
| PORTLET:JAVADOC:68 | void | javax.portlet.GenericPortlet.init
throws
UnavailableException
| if the portlet is unavailable to perform init | true |
| true |
| PORTLET:JAVADOC:69 | void | javax.portlet.GenericPortlet.processAction
(
ActionRequest
, ActionResponse
)
|
Called by the portlet container to allow the portlet to process an action request.
This method is called if the client request was originated by a URL created (by the portlet) with the RenderResponse.createActionURL() method. The default implementation throws an exception.
| true |
| true |
| PORTLET:JAVADOC:70 | void | javax.portlet.GenericPortlet.processAction
(
ActionRequest
, ActionResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:71 | void | javax.portlet.GenericPortlet.processAction
(
ActionRequest
, ActionResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:72 | void | javax.portlet.GenericPortlet.processAction
(
ActionRequest
, ActionResponse
)
throws
UnavailableException
| if the portlet is unavailable to process the action at this time | true |
| false |
| PORTLET:JAVADOC:73 | void | javax.portlet.GenericPortlet.processAction
(
ActionRequest
, ActionResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:74 | void | javax.portlet.GenericPortlet.render
(
RenderRequest
, RenderResponse
)
|
The default implementation of this method sets the title using the getTitle method and invokes the doDispatch method.
| true |
| true |
| PORTLET:JAVADOC:75 | void | javax.portlet.GenericPortlet.render
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet cannot fulfilling the request | true |
| false |
| PORTLET:JAVADOC:76 | void | javax.portlet.GenericPortlet.render
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:77 | void | javax.portlet.GenericPortlet.render
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:78 | void | javax.portlet.GenericPortlet.render
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:79 | String | javax.portlet.PortalContext.getPortalInfo
|
Returns information about the portal like vendor, version, etc.
The form of the returned string is servername/versionnumber. For example, the reference implementation Pluto may return the string Pluto/1.0. The portlet container may return other optional information after the primary string in parentheses, for example, Pluto/1.0 (JDK 1.3.1; Windows NT 4.0 x86).
| true |
| true |
| PORTLET:JAVADOC:80 | String | javax.portlet.PortalContext.getProperty
(
String
)
|
Returns the portal property with the given name, or a null if there is no property by that name.
| true |
| false |
| PORTLET:JAVADOC:81 | String | javax.portlet.PortalContext.getProperty
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| false |
| PORTLET:JAVADOC:82 | Enumeration | javax.portlet.PortalContext.getPropertyNames
|
Returns all portal property names, or an empty Enumeration if there are no property names.
| true |
| false |
| PORTLET:JAVADOC:83 | Enumeration | javax.portlet.PortalContext.getSupportedPortletModes
|
Returns all supported portlet modes by the portal as an enumertation of PorltetMode objects.
The portlet modes must at least include the standard portlet modes EDIT, HELP, VIEW.
| true |
| true |
| PORTLET:JAVADOC:84 | Enumeration | javax.portlet.PortalContext.getSupportedWindowStates
|
Returns all supported window states by the portal as an enumertation of WindowState objects.
The window states must at least include the standard window states MINIMIZED, NORMAL, MAXIMIZED.
| true |
| true |
| PORTLET:JAVADOC:85 | void | javax.portlet.Portlet.destroy
|
Called by the portlet container to indicate to a portlet that the portlet is being taken out of service.
Before the portlet container calls the destroy method, it should allow any threads that are currently processing requests within the portlet object to complete execution. To avoid waiting forever, the portlet container can optionally wait for a predefined time before destroying the portlet object. This method enables the portlet to do the following: clean up any resources that it holds (for example, memory, file handles, threads) make sure that any persistent state is synchronized with the portlet current state in memory.
| true |
| true |
| PORTLET:JAVADOC:86 | void | javax.portlet.Portlet.init
(
PortletConfig
)
|
Called by the portlet container to indicate to a portlet that the portlet is being placed into service.
The portlet container calls the init method exactly once after instantiating the portlet. The init method must complete successfully before the portlet can receive any requests. The portlet container cannot place the portlet into service if the init method Throws a PortletException Does not return within a time period defined by the portlet container.
| true |
| true |
| PORTLET:JAVADOC:87 | void | javax.portlet.Portlet.init
(
PortletConfig
)
throws
PortletException
| if an exception has occurred that interferes with the portlet's normal operation. | true |
| true |
| PORTLET:JAVADOC:88 | void | javax.portlet.Portlet.init
(
PortletConfig
)
throws
UnavailableException
| if the portlet cannot perform the initialization at this time. | true |
| true |
| PORTLET:JAVADOC:89 | void | javax.portlet.Portlet.processAction
(
ActionRequest
, ActionResponse
)
|
Called by the portlet container to allow the portlet to process an action request.
This method is called if the client request was originated by a URL created (by the portlet) with the RenderResponse.createActionURL() method. Typically, in response to an action request, a portlet updates state based on the information sent in the action request parameters. In an action the portlet may: issue a redirect change its window state change its portlet mode modify its persistent state set render parameters A client request triggered by an action URL translates into one action request and many render requests, one per portlet in the portal page. The action processing must be finished before the render requests can be issued.
| true |
| true |
| PORTLET:JAVADOC:90 | void | javax.portlet.Portlet.processAction
(
ActionRequest
, ActionResponse
)
throws
PortletException
| if the portlet has problems fulfilling the request | true |
| false |
| PORTLET:JAVADOC:91 | void | javax.portlet.Portlet.processAction
(
ActionRequest
, ActionResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:92 | void | javax.portlet.Portlet.processAction
(
ActionRequest
, ActionResponse
)
throws
UnavailableException
| if the portlet is unavailable to process the action at this time | true |
| true |
| PORTLET:JAVADOC:93 | void | javax.portlet.Portlet.processAction
(
ActionRequest
, ActionResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:94 | void | javax.portlet.Portlet.render
(
RenderRequest
, RenderResponse
)
|
Called by the portlet container to allow the portlet to generate the content of the response based on its current state.
| true |
| true |
| PORTLET:JAVADOC:95 | void | javax.portlet.Portlet.render
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the portlet has problems fulfilling the rendering request | true |
| false |
| PORTLET:JAVADOC:96 | void | javax.portlet.Portlet.render
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the streaming causes an I/O problem | true |
| false |
| PORTLET:JAVADOC:97 | void | javax.portlet.Portlet.render
(
RenderRequest
, RenderResponse
)
throws
UnavailableException
| if the portlet is unavailable to perform render at this time | true |
| false |
| PORTLET:JAVADOC:98 | void | javax.portlet.Portlet.render
(
RenderRequest
, RenderResponse
)
throws
PortletSecurityException
| if the portlet cannot fullfill this request because of security reasons | true |
| false |
| PORTLET:JAVADOC:99 | String | javax.portlet.PortletConfig.getInitParameter
(
String
)
|
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
| true |
| true |
| PORTLET:JAVADOC:100 | String | javax.portlet.PortletConfig.getInitParameter
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:101 | Enumeration | javax.portlet.PortletConfig.getInitParameterNames
|
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.
| true |
| true |
| PORTLET:JAVADOC:102 | PortletContext | javax.portlet.PortletConfig.getPortletContext
|
Returns the PortletContext of the portlet application the portlet is in.
| true |
| true |
| PORTLET:JAVADOC:103 | String | javax.portlet.PortletConfig.getPortletName
|
Returns the name of the portlet.
The name may be provided via server administration, assigned in the portlet application deployment descriptor with the portlet-name tag.
| true |
| true |
| PORTLET:JAVADOC:104 | ResourceBundle | javax.portlet.PortletConfig.getResourceBundle
(
Locale
)
|
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.
| true |
| true |
| PORTLET:JAVADOC:105 | Object | javax.portlet.PortletContext.getAttribute
(
String
)
|
Returns the portlet container attribute with the given name, or null if there is no attribute by that name.
An attribute allows a portlet container to give the portlet additional information not already provided by this interface. A list of supported attributes can be retrieved using getAttributeNames. The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Java Portlet API specification reserves names matching java.*, javax.*, and sun.*.
| true |
| true |
| PORTLET:JAVADOC:106 | Object | javax.portlet.PortletContext.getAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:107 | Enumeration | javax.portlet.PortletContext.getAttributeNames
|
Returns an Enumeration containing the attribute names available within this portlet context, or an emtpy Enumeration if no attributes are available.
Use the getAttribute method with an attribute name to get the value of an attribute.
| true |
| true |
| PORTLET:JAVADOC:108 | String | javax.portlet.PortletContext.getInitParameter
(
String
)
|
Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.
This method provides configuration information which may be useful for an entire "portlet application".
| true |
| true |
| PORTLET:JAVADOC:109 | String | javax.portlet.PortletContext.getInitParameter
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:110 | Enumeration | javax.portlet.PortletContext.getInitParameterNames
|
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.
| true |
| true |
| PORTLET:JAVADOC:111 | int | javax.portlet.PortletContext.getMajorVersion
|
Returns the major version of the Portlet API that this portlet container supports.
| true |
| true |
| PORTLET:JAVADOC:112 | String | javax.portlet.PortletContext.getMimeType
(
String
)
|
Returns the MIME type of the specified file, or null if the MIME type is not known.
The MIME type is determined by the configuration of the portlet container and may be specified in a web application deployment descriptor. Common MIME types are text/html and image/gif.
| true |
| true |
| PORTLET:JAVADOC:113 | int | javax.portlet.PortletContext.getMinorVersion
|
Returns the minor version of the Portlet API that this portlet container supports.
| true |
| true |
| PORTLET:JAVADOC:114 | PortletRequestDispatcher | javax.portlet.PortletContext.getNamedDispatcher
(
String
)
|
Returns a PortletRequestDispatcher object that acts as a wrapper for the named servlet.
Servlets (and also JSP pages) may be given names via server administration or via a web application deployment descriptor. This method returns null if the PortletContext cannot return a PortletRequestDispatcher for any reason.
| true |
| true |
| PORTLET:JAVADOC:115 | String | javax.portlet.PortletContext.getPortletContextName
|
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.
| true |
| true |
| PORTLET:JAVADOC:116 | String | javax.portlet.PortletContext.getRealPath
(
String
)
|
Returns a String containing the real path for a given virtual path.
For example, the path /index.html returns the absolute file path of the portlet container file system. The real path returned will be in a form appropriate to the computer and operating system on which the portlet container is running, including the proper path separators. This method returns null if the portlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive).
| true |
| true |
| PORTLET:JAVADOC:117 | PortletRequestDispatcher | javax.portlet.PortletContext.getRequestDispatcher
(
String
)
|
Returns a PortletRequestDispatcher object that acts as a wrapper for the resource located at the given path.
A PortletRequestDispatcher object can be used include the resource in a response. The resource can be dynamic or static. The pathname must begin with a slash ( / ) and is interpreted as relative to the current context root. This method returns null if the PortletContext cannot return a PortletRequestDispatcher for any reason.
| true |
| true |
| PORTLET:JAVADOC:118 | URL | javax.portlet.PortletContext.getResource
(
String
)
|
Returns a URL to the resource that is mapped to a specified path.
The path must begin with a slash (/) and is interpreted as relative to the current context root. This method allows the portlet container to make a resource available to portlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file. The portlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource. This method returns null if no resource is mapped to the pathname. Some containers may allow writing to the URL returned by this method using the methods of the URL class. The resource content is returned directly, so be aware that requesting a .jsp page returns the JSP source code. Use a RequestDispatcher instead to include results of an execution. This method has a different purpose than java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.
| true |
| true |
| PORTLET:JAVADOC:119 | URL | javax.portlet.PortletContext.getResource
(
String
)
throws
MalformedURLException
| if the pathname is not given in the correct form | true |
| true |
| PORTLET:JAVADOC:120 | InputStream | javax.portlet.PortletContext.getResourceAsStream
(
String
)
|
Returns the resource located at the given path as an InputStream object.
The data in the InputStream can be of any type or length. The method returns null if no resource exists at the given path. In order to access protected resources the path has to be prefixed with /WEB-INF/ (for example /WEB-INF/myportlet/myportlet.jsp). Otherwise, the direct path is used (for example /myportlet/myportlet.jsp).
| true |
| true |
| PORTLET:JAVADOC:121 | Set | javax.portlet.PortletContext.getResourcePaths
(
String
)
|
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.
Paths indicating subdirectory paths end with a slash (/). The returned paths are all relative to the root of the web application and have a leading slash. For example, for a web application containing /welcome.html /catalog/index.html /catalog/products.html /catalog/offers/books.html /catalog/offers/music.html /customer/login.jsp /WEB-INF/web.xml /WEB-INF/classes/com.acme.OrderPortlet.class, getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"} getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.
| true |
| true |
| PORTLET:JAVADOC:122 | String | javax.portlet.PortletContext.getServerInfo
|
Returns the name and version of the portlet container in which the portlet is running.
The form of the returned string is containername/versionnumber.
| true |
| true |
| PORTLET:JAVADOC:123 | void | javax.portlet.PortletContext.log
(
String
)
|
Writes the specified message to a portlet log file, usually an event log.
The name and type of the portlet log file is specific to the portlet container. This method mapps to the ServletContext.log method. The portlet container may in addition log this message in a portlet container specific log file.
| true |
| false |
| PORTLET:JAVADOC:124 | void | javax.portlet.PortletContext.log
(
String
, Throwable
)
|
Writes an explanatory message and a stack trace for a given Throwable exception to the portlet log file.
The name and type of the portlet log file is specific to the portlet container, usually an event log. This method is mapped to the ServletContext.log method. The portlet container may in addition log this message in a portlet container specific log file.
| true |
| false |
| PORTLET:JAVADOC:125 | void | javax.portlet.PortletContext.removeAttribute
(
String
)
|
Removes the attribute with the given name from the portlet context.
After removal, subsequent calls to getAttribute to retrieve the attribute's value will return null.
| true |
| true |
| PORTLET:JAVADOC:126 | void | javax.portlet.PortletContext.removeAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:127 | void | javax.portlet.PortletContext.setAttribute
(
String
, Object
)
|
Binds an object to a given attribute name in this portlet context.
If the name specified is already used for an attribute, this method removes the old attribute and binds the name to the new attribute. If a null value is passed, the effect is the same as calling removeAttribute(). Attribute names should follow the same convention as package names. The Java Portlet API specification reserves names matching java.*, javax.*, and sun.*.
| true |
| true |
| PORTLET:JAVADOC:128 | void | javax.portlet.PortletContext.setAttribute
(
String
, Object
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:129 | Throwable | javax.portlet.PortletException.getCause
|
Returns the cause of this throwable or null if the cause is nonexistent or unknown.
(The cause is the throwable that caused this throwable to get thrown.) This implementation returns the cause that was supplied via one of the constructors requiring a Throwable.
| true |
| true |
| PORTLET:JAVADOC:130 | PortletException | javax.portlet.PortletException.PortletException
|
Constructs a new portlet exception.
| true |
| true |
| PORTLET:JAVADOC:131 | PortletException | javax.portlet.PortletException.PortletException
(
String
)
|
Constructs a new portlet exception with the given text.
The portlet container may use the text write it to a log.
| true |
| true |
| PORTLET:JAVADOC:132 | PortletException | javax.portlet.PortletException.PortletException
(
String
, Throwable
)
|
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
| true |
| true |
| PORTLET:JAVADOC:133 | PortletException | javax.portlet.PortletException.PortletException
(
Throwable
)
|
Constructs a new portlet exception when the portlet needs to throw an exception.
The exception's message is based on the localized message of the underlying exception.
| true |
| true |
| PORTLET:JAVADOC:134 | void | javax.portlet.PortletException.printStackTrace
|
Prints the stack trace of this exception to the standard error stream.
| true |
| true |
| PORTLET:JAVADOC:135 | void | javax.portlet.PortletException.printStackTrace
(
PrintStream
)
|
Prints the stack trace of this exception to the specified print stream.
| true |
| true |
| PORTLET:JAVADOC:136 | void | javax.portlet.PortletException.printStackTrace
(
PrintWriter
)
|
Prints the stack trace of this exception to the specified print writer.
| true |
| true |
| PORTLET:JAVADOC:137 | boolean | javax.portlet.PortletMode.equals
(
Object
)
|
Compares the specified object with this portlet mode for equality.
Returns true if the Strings equals method for the String representing the two portlet modes returns true.
| true |
| true |
| PORTLET:JAVADOC:138 | int | javax.portlet.PortletMode.hashCode
|
Returns the hash code value for this portlet mode.
The hash code is constructed by producing the hash value of the String value of this mode.
| true |
| true |
| PORTLET:JAVADOC:139 | PortletMode | javax.portlet.PortletMode.PortletMode
(
String
)
|
Creates a new portlet mode with the given name.
Upper case letters in the name are converted to lower case letters.
| true |
| true |
| PORTLET:JAVADOC:140 | String | javax.portlet.PortletMode.toString
|
Returns a String representation of this portlet mode.
Portlet mode names are always lower case names.
| true |
| true |
| PORTLET:JAVADOC:141 | PortletMode | javax.portlet.PortletModeException.getMode
|
Returns the unsupported portlet mode causing this exception.
| true |
| true |
| PORTLET:JAVADOC:142 | PortletModeException | javax.portlet.PortletModeException.PortletModeException
(
String
, PortletMode
)
|
Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
The portlet container may use the text and portlet mode write it to a log.
| true |
| true |
| PORTLET:JAVADOC:143 | PortletModeException | javax.portlet.PortletModeException.PortletModeException
(
String
, Throwable
, PortletMode
)
|
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
| true |
| true |
| PORTLET:JAVADOC:144 | PortletModeException | javax.portlet.PortletModeException.PortletModeException
(
Throwable
, PortletMode
)
|
Constructs a new portlet mode exception when the portlet needs to throw an exception.
The exception message is based on the localized message of the underlying exception and the portlet mode that caused this exception.
| true |
| true |
| PORTLET:JAVADOC:145 | Map | javax.portlet.PortletPreferences.getMap
|
Returns a Map of the preferences.
The values in the returned Map are from type String array (String[]). If no preferences exist this method returns an empty Map.
| true |
| true |
| PORTLET:JAVADOC:146 | Enumeration | javax.portlet.PortletPreferences.getNames
|
Returns all of the keys that have an associated value, or an empty Enumeration if no keys are available.
| true |
| true |
| PORTLET:JAVADOC:147 | String | javax.portlet.PortletPreferences.getValue
(
String
, String
)
|
Returns the first String value associated with the specified key of this preference.
If there is one or more preference values associated with the given key it returns the first associated value. If there are no preference values associated with the given key, or the backing preference database is unavailable, it returns the given default value.
| true |
| true |
| PORTLET:JAVADOC:148 | String | javax.portlet.PortletPreferences.getValue
(
String
, String
)
throws
IllegalArgumentException
| if key is null. (A null value for def is permitted.) | true |
| true |
| PORTLET:JAVADOC:149 | String[] | javax.portlet.PortletPreferences.getValues
(
String
, String[]
)
|
Returns the String array value associated with the specified key in this preference.
Returns the specified default if there is no value associated with the key, or if the backing store is inaccessible. If the implementation supports stored defaults and such a default exists and is accessible, it is used in favor of the specified default.
| true |
| true |
| PORTLET:JAVADOC:150 | String[] | javax.portlet.PortletPreferences.getValues
(
String
, String[]
)
throws
IllegalArgumentException
| if key is null. (A null value for def is permitted.) | true |
| true |
| PORTLET:JAVADOC:151 | boolean | javax.portlet.PortletPreferences.isReadOnly
(
String
)
|
Returns true, if the value of this key cannot be modified by the user.
Modifiable preferences can be changed by the portlet in any standard portlet mode (EDIT, HELP, VIEW). Per default every preference is modifiable. Read-only preferences cannot be changed by the portlet in any standard portlet mode, but inside of custom modes it may be allowed changing them. Preferences are read-only, if they are defined in the deployment descriptor with read-only set to true, or if the portlet container restricts write access.
| true |
| true |
| PORTLET:JAVADOC:152 | boolean | javax.portlet.PortletPreferences.isReadOnly
(
String
)
throws
IllegalArgumentException
| if key is null. | true |
| true |
| PORTLET:JAVADOC:153 | void | javax.portlet.PortletPreferences.reset
(
String
)
|
Resets or removes the value associated with the specified key.
If this implementation supports stored defaults, and there is such a default for the specified preference, the given key will be reset to the stored default. If there is no default available the key will be removed.
| true |
| true |
| PORTLET:JAVADOC:154 | void | javax.portlet.PortletPreferences.reset
(
String
)
throws
ReadOnlyException
| if this preference cannot be modified for this request | true |
| true |
| PORTLET:JAVADOC:155 | void | javax.portlet.PortletPreferences.reset
(
String
)
throws
IllegalArgumentException
| if key is null. | true |
| true |
| PORTLET:JAVADOC:156 | void | javax.portlet.PortletPreferences.setValue
(
String
, String
)
|
Associates the specified String value with the specified key in this preference.
The key cannot be null, but null values for the value parameter are allowed.
| true |
| true |
| PORTLET:JAVADOC:157 | void | javax.portlet.PortletPreferences.setValue
(
String
, String
)
throws
ReadOnlyException
| if this preference cannot be modified for this request | true |
| true |
| PORTLET:JAVADOC:158 | void | javax.portlet.PortletPreferences.setValue
(
String
, String
)
throws
IllegalArgumentException
| if key is null, or key.length() or value.length are to long. The maximum length for key and value are implementation specific. | true |
| false |
| PORTLET:JAVADOC:159 | void | javax.portlet.PortletPreferences.setValues
(
String
, String[]
)
|
Associates the specified String array value with the specified key in this preference.
The key cannot be null, but null values in the values parameter are allowed.
| true |
| true |
| PORTLET:JAVADOC:160 | void | javax.portlet.PortletPreferences.setValues
(
String
, String[]
)
throws
ReadOnlyException
| if this preference cannot be modified for this request | true |
| true |
| PORTLET:JAVADOC:161 | void | javax.portlet.PortletPreferences.setValues
(
String
, String[]
)
throws
IllegalArgumentException
| if key is null, or key.length() is to long or value.size is to large. The maximum length for key and maximum size for value are implementation specific. | true |
| false |
| PORTLET:JAVADOC:162 | void | javax.portlet.PortletPreferences.store
|
Commits all changes made to the preferences via the set methods in the persistent store.
If this call returns succesfull, all changes are made persistent. If this call fails, no changes are made in the persistent store. This call is an atomic operation regardless of how many preference attributes have been modified. All changes made to preferences not followed by a call to the store method are discarded when the portlet finishes the processAction method. If a validator is defined for this preferences in the deployment descriptor, this validator is called before the actual store is performed to check wether the given preferences are vaild. If this check fails a ValidatorException is thrown.
| true |
| true |
| PORTLET:JAVADOC:163 | void | javax.portlet.PortletPreferences.store
throws
IOException
| if changes cannot be written into the backend store | true |
| false |
| PORTLET:JAVADOC:164 | void | javax.portlet.PortletPreferences.store
throws
ValidatorException
| if the validation performed by the associated validator fails | true |
| true |
| PORTLET:JAVADOC:165 | void | javax.portlet.PortletPreferences.store
throws
IllegalStateException
| if this method is called inside a render call | true |
| true |
| PORTLET:JAVADOC:166 | Object | javax.portlet.PortletRequest.getAttribute
(
String
)
|
Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, and javax.*. In a distributed portlet web application the Object needs to be serializable.
| true |
| true |
| PORTLET:JAVADOC:167 | Object | javax.portlet.PortletRequest.getAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:168 | Enumeration | javax.portlet.PortletRequest.getAttributeNames
|
Returns an Enumeration containing the names of the attributes available to this request.
This method returns an empty Enumeration if the request has no attributes available to it.
| true |
| true |
| PORTLET:JAVADOC:169 | String | javax.portlet.PortletRequest.getAuthType
|
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.
| true |
| true |
| PORTLET:JAVADOC:170 | String | javax.portlet.PortletRequest.getContextPath
|
Returns the context path which is the path prefix associated with the deployed portlet application.
If the portlet application is rooted at the base of the web server URL namespace (also known as "default" context), this path must be an empty string. Otherwise, it must be the path the portlet application is rooted to, the path must start with a '/' and it must not end with a '/' character. To encode a URL the PortletResponse#encodeURL method must be used.
| true |
| true |
| PORTLET:JAVADOC:171 | Locale | javax.portlet.PortletRequest.getLocale
|
Returns the preferred Locale in which the portal will accept content.
The Locale may be based on the Accept-Language header of the client.
| true |
| true |
| PORTLET:JAVADOC:172 | Enumeration | javax.portlet.PortletRequest.getLocales
|
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.
The Locales may be based on the Accept-Language header of the client.
| true |
| true |
| PORTLET:JAVADOC:173 | String | javax.portlet.PortletRequest.getParameter
(
String
)
|
Returns the value of a request parameter as a String, or null if the parameter does not exist.
Request parameters are extra information sent with the request. The returned parameter are "x-www-form-urlencoded" decoded. Only parameters targeted to the current portlet are accessible. This method should only be used if the parameter has only one value. If the parameter might have more than one value, use getParameterValues. If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.
| true |
| true |
| PORTLET:JAVADOC:174 | String | javax.portlet.PortletRequest.getParameter
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:175 | Map | javax.portlet.PortletRequest.getParameterMap
|
Returns a Map of the parameters of this request.
Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded. The values in the returned Map are from type String array (String[]). If no parameters exist this method returns an empty Map.
| true |
| true |
| PORTLET:JAVADOC:176 | Enumeration | javax.portlet.PortletRequest.getParameterNames
|
Returns an Enumeration of String objects containing the names of the parameters contained in this request.
If the request has no parameters, the method returns an empty Enumeration. Only parameters targeted to the current portlet are returned.
| true |
| true |
| PORTLET:JAVADOC:177 | String[] | javax.portlet.PortletRequest.getParameterValues
(
String
)
|
Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
The returned parameters are "x-www-form-urlencoded" decoded. If the parameter has a single value, the array has a length of 1.
| true |
| true |
| PORTLET:JAVADOC:178 | String[] | javax.portlet.PortletRequest.getParameterValues
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:179 | PortalContext | javax.portlet.PortletRequest.getPortalContext
|
Returns the context of the calling portal.
| true |
| true |
| PORTLET:JAVADOC:180 | PortletMode | javax.portlet.PortletRequest.getPortletMode
|
Returns the current portlet mode of the portlet.
| true |
| true |
| PORTLET:JAVADOC:181 | PortletSession | javax.portlet.PortletRequest.getPortletSession
|
Returns the current portlet session or, if there is no current session, creates one and returns the new session.
Creating a new portlet session will result in creating a new HttpSession on which the portlet session is based on.
| true |
| true |
| PORTLET:JAVADOC:182 | PortletSession | javax.portlet.PortletRequest.getPortletSession
(
boolean
)
|
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.
If the given flag is false and there is no current portlet session, this method returns null. Creating a new portlet session will result in creating a new HttpSession on which the portlet session is based on.
| true |
| true |
| PORTLET:JAVADOC:183 | PortletPreferences | javax.portlet.PortletRequest.getPreferences
|
Returns the preferences object associated with the portlet.
| true |
| true |
| PORTLET:JAVADOC:184 | Enumeration | javax.portlet.PortletRequest.getProperties
(
String
)
|
Returns all the values of the specified request property as a Enumeration of String objects.
If the request did not include any propertys of the specified name, this method returns an empty Enumeration. The property name is case insensitive. You can use this method with any request property.
| true |
| false |
| PORTLET:JAVADOC:185 | Enumeration | javax.portlet.PortletRequest.getProperties
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| false |
| PORTLET:JAVADOC:186 | String | javax.portlet.PortletRequest.getProperty
(
String
)
|
Returns the value of the specified request property as a String.
If the request did not include a property of the specified name, this method returns null. A portlet can access portal/portlet-container specific properties through this method and, if available, the headers of the HTTP client request. This method should only be used if the property has only one value. If the property might have more than one value, use getProperties. If this method is used with a multivalued parameter, the value returned is equal to the first value in the Enumeration returned by getProperties.
| true |
| false |
| PORTLET:JAVADOC:187 | String | javax.portlet.PortletRequest.getProperty
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| false |
| PORTLET:JAVADOC:188 | Enumeration | javax.portlet.PortletRequest.getPropertyNames
|
Returns a Enumeration of all the property names this request contains.
If the request has no properties, this method returns an empty Enumeration.
| true |
| false |
| PORTLET:JAVADOC:189 | String | javax.portlet.PortletRequest.getRemoteUser
|
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
| true |
| true |
| PORTLET:JAVADOC:190 | String | javax.portlet.PortletRequest.getRequestedSessionId
|
Returns the session ID indicated in the client request.
This session ID may not be a valid one, it may be an old one that has expired or has been invalidated. If the client request did not specify a session ID, this method returns null.
| true |
| false |
| PORTLET:JAVADOC:191 | String | javax.portlet.PortletRequest.getResponseContentType
|
Returns the portal preferred content type for the response.
The content type only includes the MIME type, not the character set. Only content types that the portlet has defined in its deployment descriptor are valid return values for this method call. If the portlet has defined '*' or '* / *' as supported content types, these may also be valid return values.
| true |
| true |
| PORTLET:JAVADOC:192 | Enumeration | javax.portlet.PortletRequest.getResponseContentTypes
|
Gets a list of content types which the portal accepts for the response.
This list is ordered with the most preferable types listed first. The content type only includes the MIME type, not the character set. Only content types that the portlet has defined in its deployment descriptor are valid return values for this method call. If the portlet has defined '*' or '* / *' as supported content types, these may also be valid return values.
| true |
| true |
| PORTLET:JAVADOC:193 | String | javax.portlet.PortletRequest.getScheme
|
Returns the name of the scheme used to make this request.
For example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
| true |
| true |
| PORTLET:JAVADOC:194 | String | javax.portlet.PortletRequest.getServerName
|
Returns the host name of the server that received the request.
| true |
| true |
| PORTLET:JAVADOC:195 | int | javax.portlet.PortletRequest.getServerPort
|
Returns the port number on which this request was received.
| true |
| true |
| PORTLET:JAVADOC:196 | Principal | javax.portlet.PortletRequest.getUserPrincipal
|
Returns a java.security.Principal object containing the name of the current authenticated user.
| false |
| true |
| PORTLET:JAVADOC:197 | WindowState | javax.portlet.PortletRequest.getWindowState
|
Returns the current window state of the portlet.
| true |
| true |
| PORTLET:JAVADOC:198 | boolean | javax.portlet.PortletRequest.isPortletModeAllowed
(
PortletMode
)
|
Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.
| true |
| true |
| PORTLET:JAVADOC:199 | boolean | javax.portlet.PortletRequest.isRequestedSessionIdValid
|
Checks whether the requested session ID is still valid.
| true |
| true |
| PORTLET:JAVADOC:200 | boolean | javax.portlet.PortletRequest.isSecure
|
Returns a boolean indicating whether this request was made using a secure channel between client and the portal, such as HTTPS.
| false |
| true |
| PORTLET:JAVADOC:201 | boolean | javax.portlet.PortletRequest.isUserInRole
(
String
)
|
Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.
| false |
| true |
| PORTLET:JAVADOC:202 | boolean | javax.portlet.PortletRequest.isWindowStateAllowed
(
WindowState
)
|
Returns true, if the given window state is valid to be set for this portlet in the context of the current request.
| true |
| true |
| PORTLET:JAVADOC:203 | void | javax.portlet.PortletRequest.removeAttribute
(
String
)
|
Removes an attribute from this request.
This method is not generally needed, as attributes only persist as long as the request is being handled. Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.* are reserved for use by Sun Microsystems.
| true |
| true |
| PORTLET:JAVADOC:204 | void | javax.portlet.PortletRequest.removeAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:205 | void | javax.portlet.PortletRequest.setAttribute
(
String
, Object
)
|
Stores an attribute in this request.
Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.* are reserved for use by Sun Microsystems. If the value passed into this method is null, the effect is the same as calling removeAttribute.
| true |
| true |
| PORTLET:JAVADOC:206 | void | javax.portlet.PortletRequest.setAttribute
(
String
, Object
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:207 | void | javax.portlet.PortletRequestDispatcher.include
(
RenderRequest
, RenderResponse
)
|
Includes the content of a resource (servlet, JSP page, HTML file) in the response.
In essence, this method enables programmatic server-side includes. The included servlet cannot set or change the response status code or set headers; any attempt to make a change is ignored.
| true |
| true |
| PORTLET:JAVADOC:208 | void | javax.portlet.PortletRequestDispatcher.include
(
RenderRequest
, RenderResponse
)
throws
PortletException
| if the included resource throws a ServletException, or other exceptions that are not Runtime- or IOExceptions. | true |
| true |
| PORTLET:JAVADOC:209 | void | javax.portlet.PortletRequestDispatcher.include
(
RenderRequest
, RenderResponse
)
throws
IOException
| if the included resource throws this exception | true |
| true |
| PORTLET:JAVADOC:210 | void | javax.portlet.PortletResponse.addProperty
(
String
, String
)
|
Adds a String property to an existing key to be returned to the portal.
This method allows response properties to have multiple values. Properties can be used by portlets to provide vendor specific information to the portal.
| true |
| false |
| PORTLET:JAVADOC:211 | void | javax.portlet.PortletResponse.addProperty
(
String
, String
)
throws
IllegalArgumentException
| if key is null. | true |
| false |
| PORTLET:JAVADOC:212 | String | javax.portlet.PortletResponse.encodeURL
(
String
)
|
Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.
Some portal/portlet-container implementation may require those URLs to contain implementation specific data encoded in it. Because of that, portlets should use this method to create such URLs. The encodeURL method may include the session ID and other portal/portlet-container specific information into the URL. If encoding is not needed, it returns the URL unchanged.
| true |
| true |
| PORTLET:JAVADOC:213 | String | javax.portlet.PortletResponse.encodeURL
(
String
)
throws
IllegalArgumentException
| if path doesn't have a leading slash or is not an absolute URL | true |
| true |
| PORTLET:JAVADOC:214 | void | javax.portlet.PortletResponse.setProperty
(
String
, String
)
|
Sets a String property to be returned to the portal.
Properties can be used by portlets to provide vendor specific information to the portal. This method resets all properties previously added with the same key.
| true |
| false |
| PORTLET:JAVADOC:215 | void | javax.portlet.PortletResponse.setProperty
(
String
, String
)
throws
IllegalArgumentException
| if key is null. | true |
| false |
| PORTLET:JAVADOC:216 | PortletSecurityException | javax.portlet.PortletSecurityException.PortletSecurityException
(
String
)
|
Constructs a new security exception with the given text.
The portlet container may use the text write it to a log.
| true |
| true |
| PORTLET:JAVADOC:217 | PortletSecurityException | javax.portlet.PortletSecurityException.PortletSecurityException
(
String
, Throwable
)
|
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
| true |
| true |
| PORTLET:JAVADOC:218 | PortletSecurityException | javax.portlet.PortletSecurityException.PortletSecurityException
(
Throwable
)
|
Constructs a new portlet security exception when the portlet needs to throw an exception.
The exception message is based on the localized message of the underlying exception.
| true |
| true |
| PORTLET:JAVADOC:219 | Object | javax.portlet.PortletSession.getAttribute
(
String
)
|
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.
| true |
| true |
| PORTLET:JAVADOC:220 | Object | javax.portlet.PortletSession.getAttribute
(
String
)
throws
IllegalStateException
| if this method is called on an invalidated session. | true |
| true |
| PORTLET:JAVADOC:221 | Object | javax.portlet.PortletSession.getAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:222 | Object | javax.portlet.PortletSession.getAttribute
(
String
, int
)
|
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.
| true |
| true |
| PORTLET:JAVADOC:223 | Object | javax.portlet.PortletSession.getAttribute
(
String
, int
)
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| PORTLET:JAVADOC:224 | Object | javax.portlet.PortletSession.getAttribute
(
String
, int
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:225 | Enumeration | javax.portlet.PortletSession.getAttributeNames
|
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.
| true |
| true |
| PORTLET:JAVADOC:226 | Enumeration | javax.portlet.PortletSession.getAttributeNames
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| PORTLET:JAVADOC:227 | Enumeration | javax.portlet.PortletSession.getAttributeNames
(
int
)
|
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.
| true |
| true |
| PORTLET:JAVADOC:228 | Enumeration | javax.portlet.PortletSession.getAttributeNames
(
int
)
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| PORTLET:JAVADOC:229 | long | javax.portlet.PortletSession.getCreationTime
|
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
| true |
| true |
| PORTLET:JAVADOC:230 | long | javax.portlet.PortletSession.getCreationTime
throws
IllegalStateException
| if this method is called on an invalidated session | true |
| true |
| PORTLET:JAVADOC:231 | String | javax.portlet.PortletSession.getId
|
Returns a string containing the unique identifier assigned to this session.
| true |
| true |
| PORTLET:JAVADOC:232 | long | javax.portlet.PortletSession.getLastAccessedTime
|
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
Actions that your portlet takes, such as getting or setting a value associated with the session, do not affect the access time.
| true |
| true |
| PORTLET:JAVADOC:233 | int | javax.portlet.PortletSession.getMaxInactiveInterval
|
Returns the maximum time interval, in seconds, for which the portlet container keeps this session open between client accesses.
After this interval, the portlet container invalidates the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.
| true |
| true |
| PORTLET:JAVADOC:234 | PortletContext | javax.portlet.PortletSession.getPortletContext
|
Returns the portlet application context associated with this session.
| true |
| true |
| PORTLET:JAVADOC:235 | void | javax.portlet.PortletSession.invalidate
|
Invalidates this session (all scopes) and unbinds any objects bound to it.
Invalidating the portlet session will result in invalidating the underlying HttpSession
| true |
| true |
| PORTLET:JAVADOC:236 | void | javax.portlet.PortletSession.invalidate
throws
IllegalStateException
| if this method is called on a session which has already been invalidated | true |
| true |
| PORTLET:JAVADOC:237 | boolean | javax.portlet.PortletSession.isNew
|
Returns true if the client does not yet know about the session or if the client chooses not to join the session.
| true |
| false |
| PORTLET:JAVADOC:238 | boolean | javax.portlet.PortletSession.isNew
throws
IllegalStateException
| if this method is called on a session which has already been invalidated | true |
| true |
| PORTLET:JAVADOC:239 | void | javax.portlet.PortletSession.removeAttribute
(
String
)
|
Removes the object bound with the specified name under the PORTLET_SCOPE from this session.
If the session does not have an object bound with the specified name, this method does nothing.
| true |
| true |
| PORTLET:JAVADOC:240 | void | javax.portlet.PortletSession.removeAttribute
(
String
)
throws
IllegalStateException
| if this method is called on a session which has been invalidated | true |
| true |
| PORTLET:JAVADOC:241 | void | javax.portlet.PortletSession.removeAttribute
(
String
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:242 | void | javax.portlet.PortletSession.removeAttribute
(
String
, int
)
|
Removes the object bound with the specified name and the given scope from this session.
If the session does not have an object bound with the specified name, this method does nothing.
| true |
| true |
| PORTLET:JAVADOC:243 | void | javax.portlet.PortletSession.removeAttribute
(
String
, int
)
throws
IllegalStateException
| if this method is called on a session which has been invalidated | true |
| true |
| PORTLET:JAVADOC:244 | void | javax.portlet.PortletSession.removeAttribute
(
String
, int
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:245 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
)
|
Binds an object to this session under the PORTLET_SCOPE, using the name specified.
If an object of the same name in this scope is already bound to the session, that object is replaced. After this method has been executed, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application. If an object was already bound to this session that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called. If the value is null, this has the same effect as calling removeAttribute().
| true |
| true |
| PORTLET:JAVADOC:246 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
)
throws
IllegalStateException
| if this method is called on a session which has been invalidated | true |
| true |
| PORTLET:JAVADOC:247 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:248 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
, int
)
|
Binds an object to this session in the given scope, using the name specified.
If an object of the same name in this scope is already bound to the session, that object is replaced. After this method has been executed, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application. If an object was already bound to this session that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called. If the value is null, this has the same effect as calling removeAttribute().
| true |
| true |
| PORTLET:JAVADOC:249 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
, int
)
throws
IllegalStateException
| if this method is called on a session which has been invalidated | true |
| true |
| PORTLET:JAVADOC:250 | void | javax.portlet.PortletSession.setAttribute
(
String
, Object
, int
)
throws
IllegalArgumentException
| if name is null. | true |
| true |
| PORTLET:JAVADOC:251 | void | javax.portlet.PortletSession.setMaxInactiveInterval
(
int
)
|
Specifies the time, in seconds, between client requests, before the portlet container invalidates this session.
A negative time indicates the session should never timeout.
| true |
| true |
| PORTLET:JAVADOC:252 | String | javax.portlet.PortletSessionUtil.decodeAttributeName
(
String
)
|
Returns the attribute name of an attribute in the PORTLET_SCOPE.
If the attribute is in the APPLICATION_SCOPE it returns the attribute name unchanged.
| true |
| true |
| PORTLET:JAVADOC:253 | int | javax.portlet.PortletSessionUtil.decodeScope
(
String
)
|
Returns the portlet attribute scope from an encoded portlet attribute.
Possible return values are: PortletSession.APPLICATION_SCOPE PortletSession.PORTLET_SCOPE
| true |
| true |
| PORTLET:JAVADOC:254 | PortletSessionUtil | javax.portlet.PortletSessionUtil.PortletSessionUtil
|
| true |
| false |
| PORTLET:JAVADOC:255 | void | javax.portlet.PortletURL.setParameter
(
String
, String
)
|
Sets the given String parameter to this URL.
This method replaces all parameters with the given key. The PortletURL implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them. A portlet container may prefix the attribute names internally in order to preserve a unique namespace for the portlet.
| true |
| true |
| PORTLET:JAVADOC:256 | void | javax.portlet.PortletURL.setParameter
(
String
, String
)
throws
IllegalArgumentException
| if name or value are null. | true |
| true |
| PORTLET:JAVADOC:257 | void | javax.portlet.PortletURL.setParameter
(
String
, String[]
)
|
Sets the given String array parameter to this URL.
This method replaces all parameters with the given key. The PortletURL implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them. A portlet container may prefix the attribute names internally in order to preserve a unique namespace for the portlet.
| true |
| true |
| PORTLET:JAVADOC:258 | void | javax.portlet.PortletURL.setParameter
(
String
, String[]
)
throws
IllegalArgumentException
| if name or values are null. | true |
| true |
| PORTLET:JAVADOC:259 | void | javax.portlet.PortletURL.setParameters
(
Map
)
|
Sets a parameter map for this URL.
All previously set parameters are cleared. The PortletURL implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them. A portlet container may prefix the attribute names internally, in order to preserve a unique namespace for the portlet.
| true |
| true |
| PORTLET:JAVADOC:260 | void | javax.portlet.PortletURL.setParameters
(
Map
)
throws
IllegalArgumentException
| if parameters is null, if any of the key/values in the Map are null, if any of the keys is not a String, or if any of the values is not a String array. | true |
| true |
| PORTLET:JAVADOC:261 | void | javax.portlet.PortletURL.setPortletMode
(
PortletMode
)
|
Indicates the portlet mode the portlet must be in, if this portlet URL triggers a request.
A URL can not have more than one portlet mode attached to it. If more than one portlet mode is set only the last one set is attached to the URL.
| true |
| true |
| PORTLET:JAVADOC:262 | void | javax.portlet.PortletURL.setPortletMode
(
PortletMode
)
throws
PortletModeException
| if the portlet cannot switch to this mode, because the portal does not support this mode, the portlet has not declared in its deployment descriptor that it supports this mode for the current markup, or the current user is not allowed to switch to this mode. The PortletRequest.isPortletModeAllowed() method can be used to check if the portlet can set a given portlet mode. | true |
| true |
| PORTLET:JAVADOC:263 | void | javax.portlet.PortletURL.setSecure
(
boolean
)
|
Indicated the security setting for this URL.
Secure set to true indicates that the portlet requests a secure connection between the client and the portlet window for this URL. Secure set to false indicates that the portlet does not need a secure connection for this URL. If the security is not set for a URL, it will stay the same as the current request.
| true |
| false |
| PORTLET:JAVADOC:264 | void | javax.portlet.PortletURL.setSecure
(
boolean
)
throws
PortletSecurityException
| if the run-time environment does not support the indicated setting | false |
| true |
| PORTLET:JAVADOC:265 | void | javax.portlet.PortletURL.setWindowState
(
WindowState
)
|
Indicates the window state the portlet should be in, if this portlet URL triggers a request.
A URL can not have more than one window state attached to it. If more than one window state is set only the last one set is attached to the URL.
| true |
| false |
| PORTLET:JAVADOC:266 | void | javax.portlet.PortletURL.setWindowState
(
WindowState
)
throws
WindowStateException
| if the portlet cannot switch to this state, because the portal does not support this state, the portlet has not declared in its deployment descriptor that it supports this state, or the current user is not allowed to switch to this state. The PortletRequest.isWindowStateAllowed() method can be used to check if the portlet can set a given window state. | true |
| true |
| PORTLET:JAVADOC:267 | String | javax.portlet.PortletURL.toString
|
Returns the portlet URL string representation to be embedded in the markup. Note that the returned String may not be a valid URL, as it may be rewritten by the portal/portlet-container before returning the markup to the client.
| true |
| true |
| PORTLET:JAVADOC:268 | void | javax.portlet.PreferencesValidator.validate
(
PortletPreferences
)
|
If the preferences values are successfully validated the call to this method must finish gracefully.
Otherwise it must throw a ValidatorException.
| true |
| false |
| PORTLET:JAVADOC:269 | void | javax.portlet.PreferencesValidator.validate
(
PortletPreferences
)
throws
ValidatorException
| if the given preferences contains invalid settings | true |
| false |
| PORTLET:JAVADOC:270 | ReadOnlyException | javax.portlet.ReadOnlyException.ReadOnlyException
(
String
)
|
Constructs a new read-only exception with the given text.
The portlet container may use the text write it to a log.
| true |
| true |
| PORTLET:JAVADOC:271 | ReadOnlyException | javax.portlet.ReadOnlyException.ReadOnlyException
(
String
, Throwable
)
|
Constructs a new read-only exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message
| true |
| true |
| PORTLET:JAVADOC:272 | ReadOnlyException | javax.portlet.ReadOnlyException.ReadOnlyException
(
Throwable
)
|
Constructs a new read-only exception when the portlet needs to throw an exception.
The exception message is based on the localized message of the underlying exception.
| true |
| true |
| PORTLET:JAVADOC:273 | PortletURL | javax.portlet.RenderResponse.createActionURL
|
Creates a portlet URL targeting the portlet.
If no portlet mode, window state or security modifier is set in the PortletURL the current values are preserved. If a request is triggered by the PortletURL, it results in an action request. The returned URL can be further extended by adding portlet-specific parameters and portlet modes and window states. The created URL will per default not contain any parameters of the current render request.
| true |
| true |
| PORTLET:JAVADOC:274 | PortletURL | javax.portlet.RenderResponse.createRenderURL
|
Creates a portlet URL targeting the portlet.
If no portlet mode, window state or security modifier is set in the PortletURL the current values are preserved. If a request is triggered by the PortletURL, it results in a render request. The returned URL can be further extended by adding portlet-specific parameters and portlet modes and window states. The created URL will per default not contain any parameters of the current render request.
| true |
| true |
| PORTLET:JAVADOC:275 | void | javax.portlet.RenderResponse.flushBuffer
|
Forces any content in the buffer to be written to the client.
A call to this method automatically commits the response.
| true |
| true |
| PORTLET:JAVADOC:276 | void | javax.portlet.RenderResponse.flushBuffer
throws
IOException
| if an error occured when writing the output | true |
| false |
| PORTLET:JAVADOC:277 | int | javax.portlet.RenderResponse.getBufferSize
|
Returns the actual buffer size used for the response.
If no buffering is used, this method returns 0.
| true |
| true |
| PORTLET:JAVADOC:278 | String | javax.portlet.RenderResponse.getCharacterEncoding
|
Returns the name of the charset used for the MIME body sent in this response.
See RFC 2047 for more information about character encoding and MIME.
| true |
| true |
| PORTLET:JAVADOC:279 | String | javax.portlet.RenderResponse.getContentType
|
Returns the MIME type that can be used to contribute markup to the render response.
If no content type was set previously using the setContentType method this method retuns null.
| true |
| true |
| PORTLET:JAVADOC:280 | Locale | javax.portlet.RenderResponse.getLocale
|
Returns the locale assigned to the response.
| true |
| true |
| PORTLET:JAVADOC:281 | String | javax.portlet.RenderResponse.getNamespace
|
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.
| true |
| true |
| PORTLET:JAVADOC:282 | OutputStream | javax.portlet.RenderResponse.getPortletOutputStream
|
Returns a OutputStream suitable for writing binary data in the response.
The portlet container does not encode the binary data. Before calling this method the content type of the render response must be set using the setContentType method. Calling flush() on the OutputStream commits the response. Either this method or getWriter may be called to write the body, not both.
| true |
| true |
| PORTLET:JAVADOC:283 | OutputStream | javax.portlet.RenderResponse.getPortletOutputStream
throws
IOException
| if an input or output exception occurred | true |
| false |
| PORTLET:JAVADOC:284 | OutputStream | javax.portlet.RenderResponse.getPortletOutputStream
throws
IllegalStateException
| if the getWriter method has been called on this response, or if no content type was set using the setContentType method. | true |
| true |
| PORTLET:JAVADOC:285 | PrintWriter | javax.portlet.RenderResponse.getWriter
|
Returns a PrintWriter object that can send character text to the portal.
Before calling this method the content type of the render response must be set using the setContentType method. Either this method or getPortletOutputStream may be called to write the body, not both.
| true |
| true |
| PORTLET:JAVADOC:286 | PrintWriter | javax.portlet.RenderResponse.getWriter
throws
IOException
| if an input or output exception occurred | true |
| false |
| PORTLET:JAVADOC:287 | PrintWriter | javax.portlet.RenderResponse.getWriter
throws
IllegalStateException
| if the getPortletOutputStream method has been called on this response, or if no content type was set using the setContentType method. | true |
| true |
| PORTLET:JAVADOC:288 | boolean | javax.portlet.RenderResponse.isCommitted
|
Returns a boolean indicating if the response has been committed.
| true |
| true |
| PORTLET:JAVADOC:289 | void | javax.portlet.RenderResponse.reset
|
Clears any data that exists in the buffer as well as the properties set.
If the response has been committed, this method throws an IllegalStateException.
| true |
| true |
| PORTLET:JAVADOC:290 | void | javax.portlet.RenderResponse.reset
throws
IllegalStateException
| if the response has already been committed | true |
| true |
| PORTLET:JAVADOC:291 | void | javax.portlet.RenderResponse.resetBuffer
|
Clears the content of the underlying buffer in the response without clearing properties set.
If the response has been committed, this method throws an IllegalStateException.
| true |
| true |
| PORTLET:JAVADOC:292 | void | javax.portlet.RenderResponse.resetBuffer
throws
IllegalStateException
| if this method is called after response is comitted | true |
| true |
| PORTLET:JAVADOC:293 | void | javax.portlet.RenderResponse.setBufferSize
(
int
)
|
Sets the preferred buffer size for the body of the response.
The portlet container will use a buffer at least as large as the size requested. This method must be called before any response body content is written; if content has been written, or the portlet container does not support buffering, this method may throw an IllegalStateException.
| true |
| true |
| PORTLET:JAVADOC:294 | void | javax.portlet.RenderResponse.setBufferSize
(
int
)
throws
IllegalStateException
| if this method is called after content has been written, or the portlet container does not support buffering | true |
| false |
| PORTLET:JAVADOC:295 | void | javax.portlet.RenderResponse.setContentType
(
String
)
|
Sets the MIME type for the render response.
The portlet must set the content type before calling getWriter or getPortletOutputStream. Calling setContentType after getWriter or getOutputStream does not change the content type.
| true |
| true |
| PORTLET:JAVADOC:296 | void | javax.portlet.RenderResponse.setContentType
(
String
)
throws
IllegalArgumentException
| if the given type is not in the list returned by PortletRequest.getResponseContentTypes | true |
| true |
| PORTLET:JAVADOC:297 | void | javax.portlet.RenderResponse.setTitle
(
String
)
|
This method sets the title of the portlet.
The value can be a text String
| true |
| false |
| PORTLET:JAVADOC:298 | int | javax.portlet.UnavailableException.getUnavailableSeconds
|
Returns the time in seconds for which the portlet can be expected to be unavailable.
If the portlet is called again while it is still unavailable, it indicates the same time estimate. No effort is made to correct for the time elapsed since the exception was first reported. If this method returns zero or a negative number, the portlet is permanently unavailable or cannot provide an estimate of how long it will be unavailable.
| true |
| true |
| PORTLET:JAVADOC:299 | boolean | javax.portlet.UnavailableException.isPermanent
|
Returns a boolean indicating whether the portlet is permanently unavailable.
If so, something is wrong with the portlet, and the system administrator must take some corrective action.
| true |
| true |
| PORTLET:JAVADOC:300 | UnavailableException | javax.portlet.UnavailableException.UnavailableException
(
String
)
|
Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.
| true |
| true |
| PORTLET:JAVADOC:301 | UnavailableException | javax.portlet.UnavailableException.UnavailableException
(
String
, int
)
|
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.
In some cases, the portlet cannot make an estimate. For example, the portlet might know that a server it needs is not running, but it might not be able to report how long it will take to be restored to functionality. This can be indicated with a negative or zero value for the seconds argument.
| true |
| true |
| PORTLET:JAVADOC:302 | Enumeration | javax.portlet.ValidatorException.getFailedKeys
|
Returns the keys that failed the validation.
The Enumeration of failed keys may contain all failed keys, only the first key that failed validation, or an empty Enumeration if no failed keys are available.
| true |
| true |
| PORTLET:JAVADOC:303 | ValidatorException | javax.portlet.ValidatorException.ValidatorException
(
String
, Collection
)
|
Constructs a new validator exception with the given text.
The portlet container may use the text write it to a log. The collection of failed keys may contain all failed keys, only the first key that failed validation, or may be null.
| true |
| true |
| PORTLET:JAVADOC:304 | ValidatorException | javax.portlet.ValidatorException.ValidatorException
(
String
, Throwable
, Collection
)
|
Constructs a new portlet validator exception.
Used, when the portlet needs to do one of the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message The Collection of failed keys may contain all failed keys, only the first key that failed validation, or may be null.
| true |
| true |
| PORTLET:JAVADOC:305 | ValidatorException | javax.portlet.ValidatorException.ValidatorException
(
Throwable
, Collection
)
|
Constructs a new portlet validator exception when the portlet needs to throw an exception.
The exception message is based on the localized message of the underlying exception. The Collection of failed keys may contain all failed keys, only the first key that failed validation, or may be null.
| true |
| true |
| PORTLET:JAVADOC:306 | boolean | javax.portlet.WindowState.equals
(
Object
)
|
Compares the specified object with this window state for equality.
Returns true if the Strings equals method for the String representing the two window states returns true.
| true |
| true |
| PORTLET:JAVADOC:307 | int | javax.portlet.WindowState.hashCode
|
Returns the hash code value for this window state.
The hash code is constructed by producing the hash value of the String value of this window state.
| true |
| true |
| PORTLET:JAVADOC:308 | String | javax.portlet.WindowState.toString
|
Returns a String representation of this window state.
Window state names are always lower case names.
| true |
| true |
| PORTLET:JAVADOC:309 | WindowState | javax.portlet.WindowState.WindowState
(
String
)
|
Creates a new window state with the given name.
Upper case letters in the name are converted to lower case letters.
| true |
| true |
| PORTLET:JAVADOC:310 | WindowState | javax.portlet.WindowStateException.getState
|
Returns the portlet state causing this exception.
| true |
| true |
| PORTLET:JAVADOC:311 | WindowStateException | javax.portlet.WindowStateException.WindowStateException
(
String
, WindowState
)
|
Constructs a new portlet state exception with the given text.
The portlet container may use the text write it to a log.
| true |
| true |
| PORTLET:JAVADOC:312 | WindowStateException | javax.portlet.WindowStateException.WindowStateException
(
String
, Throwable
, WindowState
)
|
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
| true |
| true |
| PORTLET:JAVADOC:313 | WindowStateException | javax.portlet.WindowStateException.WindowStateException
(
Throwable
, WindowState
)
|
Constructs a new portlet state exception when the portlet needs to throw an exception.
The exception message is based on the localized message of the underlying exception.
| true |
| true |