[portal-commits] JBoss Portal SVN: r9560 - in modules/portlet/trunk: portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api and 4 other directories.

Author: julien(a)jboss.com Date: 2008-01-22 12:09:32 -0500 (Tue, 22 Jan 2008) New Revision: 9560 Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PortletDoesNotReceiveUnsupportedRenderParametersTestCase.java Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/PortletURL.java modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/RenderURL.java modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletURLImpl.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/base/AbstractUniversalTestPortlet.java modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletControllerContextImpl.java modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletURLRenderer.java modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml Log: - test case for portlet that should not see public render parameter they don't declare - implemented public parameter in render URLs - fixed a bug where only one public parameter update change was taken in account and discarding the others Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/PortletURL.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/PortletURL.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/PortletURL.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -46,11 +46,4 @@ * @return the window state */ WindowState getWindowState(); - - /** - * Returns the public navigational state changes. - * - * @return the public navigational state changes - */ - Map<String, String[]> getPublicNavigationalStateChanges(); } Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/RenderURL.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/RenderURL.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/RenderURL.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -22,6 +22,8 @@ ******************************************************************************/ package org.jboss.portal.portlet; +import java.util.Map; + /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 2748 $ @@ -34,4 +36,11 @@ * @return the navigational state */ StateString getNavigationalState(); + + /** + * Returns the public navigational state changes. + * + * @return the public navigational state changes + */ + Map<String, String[]> getPublicNavigationalStateChanges(); } Modified: modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletURLImpl.java =================================================================== --- modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletURLImpl.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/portlet/src/main/java/org/jboss/portal/portlet/impl/jsr168/api/PortletURLImpl.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -170,11 +170,6 @@ return navigationalState; } - public Map<String, String[]> getPublicNavigationalStateChanges() - { - return Collections.emptyMap(); - } - protected void setParameter(String name, String value) { interactionState.setValue(name, value); Added: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PortletDoesNotReceiveUnsupportedRenderParametersTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PortletDoesNotReceiveUnsupportedRenderParametersTestCase.java (rev 0) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PortletDoesNotReceiveUnsupportedRenderParametersTestCase.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -0,0 +1,147 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.test.portlet.jsr286.tck.portletrequests; + +import org.jboss.portal.unit.annotations.TestCase; +import org.jboss.portal.unit.Assertion; +import org.jboss.portal.unit.PortletTestCase; +import org.jboss.portal.unit.PortletTestContext; +import org.jboss.portal.unit.base.AbstractUniversalTestPortlet; +import org.jboss.portal.unit.actions.PortletRenderTestAction; +import org.jboss.portal.unit.actions.PortletActionTestAction; +import org.jboss.portal.test.portlet.framework.UTP9; +import org.jboss.portal.test.portlet.framework.UTP1; +import org.jboss.portal.test.portlet.framework.UTP2; +import org.jboss.portal.test.portlet.framework.UTP3; +import org.jboss.portal.test.portlet.framework.UTP4; +import org.jboss.portal.common.util.Tools; +import static org.jboss.unit.api.Assert.*; +import org.jboss.unit.driver.DriverResponse; +import org.jboss.unit.driver.response.EndTestResponse; +import org.jboss.unit.driver.response.FailureResponse; +import org.jboss.unit.remote.driver.handler.http.response.InvokeGetResponse; +import org.jboss.unit.Failure; + +import javax.portlet.RenderRequest; +import javax.portlet.RenderResponse; +import javax.portlet.Portlet; +import javax.portlet.PortletConfig; +import javax.portlet.ActionRequest; +import javax.portlet.ActionResponse; +import javax.portlet.PortletException; +import javax.portlet.PortletURL; +import java.util.Enumeration; +import java.util.Locale; +import java.util.List; +import java.util.HashSet; +import java.io.IOException; + +/** + * + * The portlet container must only send those public render parameters to a portlet which the + * portlet has defined support for using supported-public-render-parameter element in the portlet. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +(a)TestCase({Assertion.JSR168_1000}) +public class PortletDoesNotReceiveUnsupportedRenderParametersTestCase +{ + + public PortletDoesNotReceiveUnsupportedRenderParametersTestCase(PortletTestCase seq) + { + seq.bindAction(0, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + return new InvokeGetResponse(response.createActionURL().toString()); + } + }); + + // Test updates from an action + seq.bindAction(1, UTP3.ACTION_JOIN_POINT, new PortletActionTestAction() + { + protected void run(Portlet portlet, ActionRequest request, ActionResponse response, PortletTestContext context) throws PortletException, IOException + { + response.setRenderParameter("foo", new String[]{"foo_value1", "foo_value2"}); + response.setRenderParameter("bar", new String[]{"bar_value1", "bar_value2"}); + } + }); + seq.bindAction(1, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + assertEquals(new String[]{"foo_value1","foo_value2"}, request.getParameterValues("foo")); + assertEquals(new String[]{"bar_value1","bar_value2"}, request.getParameterValues("bar")); + return null; + } + }); + seq.bindAction(1, UTP4.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String[] fooValues = request.getParameterValues("foo"); + assertEquals(new String[]{"foo_value1","foo_value2"}, fooValues); + assertEquals(null, request.getParameterValues("bar")); + return new InvokeGetResponse(response.createRenderURL().toString()); + } + }); + + // Test updates from a render URL + seq.bindAction(2, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + PortletURL url = response.createRenderURL(); + url.setParameter("foo", new String[]{"foo_value3", "foo_value4"}); + url.setParameter("bar", new String[]{"bar_value3", "bar_value4"}); + return new InvokeGetResponse(url.toString()); + } + }); + seq.bindAction(3, UTP3.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + assertEquals(new String[]{"foo_value3","foo_value4"}, request.getParameterValues("foo")); + assertEquals(new String[]{"bar_value3","bar_value4"}, request.getParameterValues("bar")); + return null; + } + }); + seq.bindAction(3, UTP4.RENDER_JOIN_POINT, new PortletRenderTestAction() + { + protected DriverResponse run(Portlet portlet, RenderRequest request, RenderResponse response, PortletTestContext context) + { + String[] fooValues = request.getParameterValues("foo"); + assertEquals(new String[]{"foo_value3","foo_value4"}, fooValues); + assertEquals(null, request.getParameterValues("bar")); + // +// PortletURL renderURL = response.createRenderURL(); +// renderURL.setParameter("bar", ""); + return new EndTestResponse(); + } + }); + + // Test updates from an action with the portlet having a private render parameter + + } +} \ No newline at end of file Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/test/portlet/jsr286/tck/portletrequests/PublicRenderParameterTestCase.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -129,9 +129,7 @@ { String foo = request.getParameter("foo"); assertEquals(null, foo); - renderCount++; - assertEquals(2, renderCount); - return new EndTestResponse(); + return ++renderCount == 2 ? new EndTestResponse() : null; } }); } Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/base/AbstractUniversalTestPortlet.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/base/AbstractUniversalTestPortlet.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/base/AbstractUniversalTestPortlet.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -260,9 +260,20 @@ DriverResponse response = ((PortletRenderTestAction)action).execute(this, req, resp, ctx); // If we have one result it is meant to be returned to the client - if (ctx.getResponse() == null && response != null) + if (response != null) { - ctx.setResponse(response); + DriverResponse existingResponse = ctx.getResponse(); + + // + if (existingResponse instanceof FailureResponse) + { + // We keep the existing failure, since we want it reported + } + else if (response instanceof FailureResponse || existingResponse == null) + { + // We have a failure response and the context contains no response or a non failure response + ctx.setResponse(response); + } } } else Modified: modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java =================================================================== --- modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletController.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -107,8 +107,10 @@ if (publicNavigationalState == null) { publicNavigationalState = new ParameterMap(); - publicNavigationalState.put(parameterId, parameterValue); } + + // + publicNavigationalState.put(parameterId, parameterValue); } } return publicNavigationalState; @@ -133,6 +135,9 @@ updateNavigationalState.setMode(portletRenderRequest.mode); updateNavigationalState.setWindowState(portletRenderRequest.windowState); updateNavigationalState.setNavigationalState(portletRenderRequest.navigationalState); + updateNavigationalState.setPublicNavigationalStateUpdates(portletRenderRequest.publicNavigationalStateChanges); + + // return updateNavigationalState; } else if (containerRequest instanceof PortletActionRequest) @@ -786,9 +791,12 @@ /** . */ final StateString navigationalState; + final Map<String, String[]> publicNavigationalStateChanges; + public PortletRenderRequest( String portletId, StateString navigationalState, + Map<String, String[]> publicNavigationalStateChanges, Mode mode, WindowState windowState) { @@ -796,6 +804,7 @@ // this.navigationalState = navigationalState; + this.publicNavigationalStateChanges = publicNavigationalStateChanges; } } } Modified: modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletControllerContextImpl.java =================================================================== --- modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletControllerContextImpl.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletControllerContextImpl.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -26,6 +26,7 @@ import org.jboss.portal.WindowState; import org.jboss.portal.common.util.ParameterMap; import org.jboss.portal.common.util.Tools; +import org.jboss.portal.common.io.IOTools; import org.jboss.portal.portlet.Portlet; import org.jboss.portal.portlet.PortletContext; import org.jboss.portal.portlet.PortletInvoker; @@ -44,6 +45,7 @@ import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.Collection; +import java.util.Map; /** * @author <a href="mailto:julien@jboss.org">Julien Viet</a> @@ -181,7 +183,10 @@ StateString navigationalState = ParametersStateString.create(req.getParameter("navigationalstate")); // - request = new PortletController.PortletRenderRequest(targetId, navigationalState, mode, windowState); + Map<String, String[]> publicNavigationalStateChanges = (Map<String, String[]>)IOTools.unserialize(Tools.fromHexString(req.getParameter("publicnavigationalstatechanges"))); + + // + request = new PortletController.PortletRenderRequest(targetId, navigationalState, publicNavigationalStateChanges, mode, windowState); } } } Modified: modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletURLRenderer.java =================================================================== --- modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletURLRenderer.java 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/test/src/main/java/org/jboss/portal/portlet/test/PortletURLRenderer.java 2008-01-22 17:09:32 UTC (rev 9560) @@ -32,6 +32,7 @@ import org.jboss.portal.common.text.CharBuffer; import org.jboss.portal.common.text.FastURLEncoder; import org.jboss.portal.common.util.Tools; +import org.jboss.portal.common.io.IOTools; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -159,6 +160,20 @@ RenderURL renderURL = (RenderURL)containerURL; // + try + { + Map<String, String[]> changes = renderURL.getPublicNavigationalStateChanges(); + HashMap<String, String[]> serialiableChanges = new HashMap<String, String[]>(changes); + byte[] bytes = IOTools.serialize(serialiableChanges); + String ns = Tools.toHexString(bytes); + parameters.put("publicnavigationalstatechanges", ns); + } + catch (IOException e) + { + throw new Error(e); + } + + // StateString navigationalState = renderURL.getNavigationalState(); parameters.put("navigationalstate", navigationalState.getStringValue()); } Modified: modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml =================================================================== --- modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml 2008-01-22 15:33:59 UTC (rev 9559) +++ modules/portlet/trunk/test/src/test/resources/jsr286/tck/portletrequests-war/WEB-INF/portlet.xml 2008-01-22 17:09:32 UTC (rev 9560) @@ -45,9 +45,33 @@ <supported-public-render-parameter>foo</supported-public-render-parameter> </portlet> + <portlet> + <portlet-name>UniversalTestPortletC</portlet-name> + <portlet-class>org.jboss.portal.test.portlet.framework.UTP3</portlet-class> + <supports> + <mime-type>text/html</mime-type> + </supports> + <supported-public-render-parameter>foo</supported-public-render-parameter> + <supported-public-render-parameter>bar</supported-public-render-parameter> + </portlet> + + <portlet> + <portlet-name>UniversalTestPortletD</portlet-name> + <portlet-class>org.jboss.portal.test.portlet.framework.UTP4</portlet-class> + <supports> + <mime-type>text/html</mime-type> + </supports> + <supported-public-render-parameter>foo</supported-public-render-parameter> + </portlet> + <public-render-parameter> <identifier>foo</identifier> <name>Foo</name> </public-render-parameter> + <public-render-parameter> + <identifier>bar</identifier> + <name>Bar</name> + </public-render-parameter> + </portlet-app>