javax.portlet: public interface: PortletResponse

javax.portlet
public interface: PortletResponse [javadoc | source]

All Known Implementing Classes:
ActionResponse, RenderResponse

The PortletResponse defines the base interface to assist a portlet in creating and sending a response to the client. The portlet container uses two specialized versions of this interface when invoking a portlet, ActionResponse and RenderResponse. The portlet container creates these objects and passes them as arguments to the portlet's processAction and render methods.

Also see:

ActionResponse

RenderResponse

Method from javax.portlet.PortletResponse Summary:
addProperty, encodeURL, setProperty

Method from javax.portlet.PortletResponse Detail:
public void addProperty(String key, String value) 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.
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. 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.
public void setProperty(String key, String value) 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.

Method from javax.portlet.PortletResponse Detail:

 public  void addProperty(String key,
    String value)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.

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

 public  void setProperty(String key,
    String value)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.