Interface ActionResponse
-
- All Superinterfaces:
PortletResponse
,StateAwareResponse
- All Known Implementing Classes:
ActionResponseWrapper
public interface ActionResponse extends StateAwareResponse
TheActionResponse
interface represents the portlet response to an action request. It extends theStateAwareResponse
interface to provide specific action response functionality to portlets.
The portlet container creates anActionResponse
object and passes it as argument to the portlet'sprocessAction
method.- See Also:
StateAwareResponse
,PortletResponse
,ActionRequest
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
sendRedirect(java.lang.String location)
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.void
sendRedirect(java.lang.String location, java.lang.String renderUrlParamName)
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL and encode a render URL as parameter on the redirect URL.-
Methods inherited from interface javax.portlet.PortletResponse
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty
-
Methods inherited from interface javax.portlet.StateAwareResponse
getPortletMode, getRenderParameterMap, getWindowState, removePublicRenderParameter, setEvent, setEvent, setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setWindowState
-
-
-
-
Method Detail
-
sendRedirect
void sendRedirect(java.lang.String location) throws java.io.IOException
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
- removePublicRenderParamter
- Parameters:
location
- the redirect location URL- Throws:
java.io.IOException
- if an input or output exception occurs.java.lang.IllegalArgumentException
- if a relative path URL is givenjava.lang.IllegalStateException
- if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called.
-
sendRedirect
void sendRedirect(java.lang.String location, java.lang.String renderUrlParamName) throws java.io.IOException
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL and encode a render URL as parameter on the redirect 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 portlet container will attach a render URL with the currently set portlet mode, window state and render parameters on the
ActionResponse
and the current public render parameters. The attached URL will be available as query parameter value under the key provided with therenderUrlParamName
parameter.New values for
- setPortletMode
- setWindowState
- setRenderParameter
- setRenderParameters
- Parameters:
location
- the redirect location URLrenderUrlParamName
- name of the query parameter under which the portlet container should store a render URL to this portlet- Throws:
java.io.IOException
- if an input or output exception occurs.java.lang.IllegalArgumentException
- if a relative path URL is given- Since:
- 2.0
-
-