|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ActionResponse
The ActionResponse
interface represents the portlet response to an action request. It extends the StateAwareResponse
interface to provide specific action response functionality to portlets.
The portlet container creates an ActionResponse
object and passes it as argument to the portlet's processAction
method.
StateAwareResponse
, PortletResponse
, ActionRequest
Method Summary | |
---|---|
void |
sendRedirect(String location) Instructs the portlet container to send a redirect response to the client using the specified redirect location URL. |
void |
sendRedirect(String location, 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.StateAwareResponse |
---|
getPortletMode, getRenderParameterMap, getWindowState, removePublicRenderParameter, setEvent, setEvent, setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setWindowState |
Methods inherited from interface javax.portlet.PortletResponse |
---|
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty |
Method Detail |
---|
void sendRedirect(String location) throws IOException
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:
location
- the redirect location URLIOException
- if an input or output exception occurs.IllegalArgumentException
- if a relative path URL is givenIllegalStateException
- if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called.void sendRedirect(String location, String renderUrlParamName) throws IOException
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 the renderUrlParamName
parameter.
New values for
location
- the redirect location URLrenderUrlParamName
- name of the query parameter under which the portlet container should store a render URL to this portletIOException
- if an input or output exception occurs.IllegalArgumentException
- if a relative path URL is given
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.