org.jboss.portal.portlet.impl.jsr168.api
Class ActionResponseImpl

java.lang.Object
  org.jboss.portal.portlet.impl.jsr168.api.PortletResponseImpl
      org.jboss.portal.portlet.impl.jsr168.api.StateAwareResponseImpl
          org.jboss.portal.portlet.impl.jsr168.api.ActionResponseImpl

All Implemented Interfaces:

ActionResponse, PortletResponse, javax.portlet.StateAwareResponse

public class ActionResponseImpl
extends StateAwareResponseImpl
implements ActionResponse

Version:

$Revision: 7379 $

Author:

Julien Viet

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.portal.portlet.impl.jsr168.api.StateAwareResponseImpl

StateAwareResponseImpl.WantRedirect, StateAwareResponseImpl.WantUpdate

Field Summary

protected PortletInvocationResponse

response .

Fields inherited from class org.jboss.portal.portlet.impl.jsr168.api.StateAwareResponseImpl

wantRedirect, wantUpdate

Fields inherited from class org.jboss.portal.portlet.impl.jsr168.api.PortletResponseImpl

invocation, preq

Constructor Summary

ActionResponseImpl(ActionInvocation invocation, PortletRequestImpl preq)

Method Summary

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 s, java.lang.String s1)

Methods inherited from class org.jboss.portal.portlet.impl.jsr168.api.StateAwareResponseImpl

checkRedirect, getPortletMode, getRenderParameterMap, getResponse, getWindowState, queueEvent, removePublicRenderParameter, requireRedirect, requireUpdate, setEvent, setEvent, setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setWindowState, wantUpdate

Methods inherited from class org.jboss.portal.portlet.impl.jsr168.api.PortletResponseImpl

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperties, getProperties, getRealResponse, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.portlet.ActionResponse

setPortletMode, setRenderParameter, setRenderParameter, setRenderParameters, setWindowState

Methods inherited from interface javax.portlet.PortletResponse

addProperty, encodeURL, setProperty

Field Detail

response

protected PortletInvocationResponse response

.

Constructor Detail

ActionResponseImpl

public ActionResponseImpl(ActionInvocation invocation,
                          PortletRequestImpl preq)

Method Detail

sendRedirect

public void sendRedirect(java.lang.String s,
                         java.lang.String s1)
                  throws java.io.IOException

Throws:

java.io.IOException

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Description copied from interface: ActionResponse

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

Specified by:

sendRedirect in interface ActionResponse

Parameters:

location - the redirect location URL

Throws:

java.io.IOException - if an input or output exception occurs.