| java.lang.Object
 com.sun.portal.portlet.impl.PortletResponseImpl
All known Subclasses: com.sun.portal.portlet.impl.EventResponseImpl, com.sun.portal.portlet.impl.ActionResponseImpl, com.sun.portal.portlet.impl.RenderResponseImpl,
| PortletResponseImpl | | public class PortletResponseImpl implements PortletResponse(Code) | | This class provides implementation of the PortletResponse interface.
|
| Method Summary | |
| public void | addProperty(String key, String value)
Adds a String property to an existing key to be returned to the
portal. | | void | clear()
Clears the global variables. | | public String | encodeURL(String path)
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. | | void | init(HttpServletRequest req, HttpServletResponse res, PortletRequest pReq, PortletContainerRequest pContReq, PortletContainerResponse pContRes, Logger logger)
Initialize the global variables. | | public void | setProperty(String key, String value)
Sets a String property to be returned to the portal. |
| addProperty | | public void addProperty(String key, String value)(Code) | | 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.
Parameters:
key - the key of the property to be returned to the portal
Parameters:
value - the value of the property to be returned to the portal
exception:
java.lang.IllegalArgumentException - if key is null. |
| clear | | void clear()(Code) | | Clears the global variables.
|
| encodeURL | | public String encodeURL(String path)(Code) | | 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.
Parameters:
path - the URI path to the resource. This must be eitheran absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif)or a full path URI (e.g. /myfolder/myresource.gif). the resource URL as string
exception:
java.lang.IllegalArgumentException - - if path doesn'thave a leading slash or is not an absolute URL |
| setProperty | | public void setProperty(String key, String value)(Code) | | 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.
Parameters:
key - the key of the property to be returned to the portal
Parameters:
value - the value of the property to be returned to theportal
exception:
java.lang.IllegalArgumentException - if key is null. |
|
|